Loading...
Searching...
No Matches
usdRenderSettingsSchema.h
Go to the documentation of this file.
1//
2// Copyright 2023 Pixar
3//
4// Licensed under the Apache License, Version 2.0 (the "Apache License")
5// with the following modification; you may not use this file except in
6// compliance with the Apache License and the following modification to it:
7// Section 6. Trademarks. is deleted and replaced with:
8//
9// 6. Trademarks. This License does not grant permission to use the trade
10// names, trademarks, service marks, or product names of the Licensor
11// and its affiliates, except as required to comply with Section 4(c) of
12// the License and to reproduce the content of the NOTICE file.
13//
14// You may obtain a copy of the Apache License at
15//
16// http://www.apache.org/licenses/LICENSE-2.0
17//
18// Unless required by applicable law or agreed to in writing, software
19// distributed under the Apache License with the above modification is
20// distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21// KIND, either express or implied. See the Apache License for the specific
22// language governing permissions and limitations under the Apache License.
23//
25
26/* ************************************************************************** */
27/* ** ** */
28/* ** This file is generated by a script. ** */
29/* ** ** */
30/* ** Do not edit it directly (unless it is within a CUSTOM CODE section)! ** */
31/* ** Edit hdSchemaDefs.py instead to make changes. ** */
32/* ** ** */
33/* ************************************************************************** */
34
35#ifndef PXR_USD_IMAGING_USD_IMAGING_USD_RENDER_SETTINGS_SCHEMA_H
36#define PXR_USD_IMAGING_USD_IMAGING_USD_RENDER_SETTINGS_SCHEMA_H
37
39
40#include "pxr/usdImaging/usdImaging/api.h"
41
42#include "pxr/imaging/hd/schema.h"
43
44// --(BEGIN CUSTOM CODE: Includes)--
45// --(END CUSTOM CODE: Includes)--
46
47PXR_NAMESPACE_OPEN_SCOPE
48
49// --(BEGIN CUSTOM CODE: Declares)--
50// --(END CUSTOM CODE: Declares)--
51
52#define USD_IMAGING_USD_RENDER_SETTINGS_SCHEMA_TOKENS \
53 (__usdRenderSettings) \
54 (resolution) \
55 (pixelAspectRatio) \
56 (aspectRatioConformPolicy) \
57 (dataWindowNDC) \
58 (disableMotionBlur) \
59 (disableDepthOfField) \
60 (camera) \
61 (includedPurposes) \
62 (materialBindingPurposes) \
63 (renderingColorSpace) \
64 (products) \
65 (namespacedSettings) \
66
67TF_DECLARE_PUBLIC_TOKENS(UsdImagingUsdRenderSettingsSchemaTokens, USDIMAGING_API,
68 USD_IMAGING_USD_RENDER_SETTINGS_SCHEMA_TOKENS);
69
70//-----------------------------------------------------------------------------
71
72
73class UsdImagingUsdRenderSettingsSchema : public HdSchema
74{
75public:
78
79 UsdImagingUsdRenderSettingsSchema(HdContainerDataSourceHandle container)
80 : HdSchema(container) {}
81
87 USDIMAGING_API
88 static UsdImagingUsdRenderSettingsSchema GetFromParent(
89 const HdContainerDataSourceHandle &fromParentContainer);
90
92
93// --(BEGIN CUSTOM CODE: Schema Methods)--
94// --(END CUSTOM CODE: Schema Methods)--
95
98
99 USDIMAGING_API
100 HdVec2iDataSourceHandle GetResolution() const;
101
102 USDIMAGING_API
103 HdFloatDataSourceHandle GetPixelAspectRatio() const;
104
105 USDIMAGING_API
106 HdTokenDataSourceHandle GetAspectRatioConformPolicy() const;
107
108 USDIMAGING_API
109 HdVec4fDataSourceHandle GetDataWindowNDC() const;
110
111 USDIMAGING_API
112 HdBoolDataSourceHandle GetDisableMotionBlur() const;
113
114 USDIMAGING_API
115 HdBoolDataSourceHandle GetDisableDepthOfField() const;
116
117 USDIMAGING_API
118 HdPathDataSourceHandle GetCamera() const;
119
120 USDIMAGING_API
121 HdTokenArrayDataSourceHandle GetIncludedPurposes() const;
122
123 USDIMAGING_API
124 HdTokenArrayDataSourceHandle GetMaterialBindingPurposes() const;
125
126 USDIMAGING_API
127 HdTokenDataSourceHandle GetRenderingColorSpace() const;
128
129 USDIMAGING_API
130 HdPathArrayDataSourceHandle GetProducts() const;
131
132 USDIMAGING_API
133 HdContainerDataSourceHandle GetNamespacedSettings() const;
134
136
139
142 USDIMAGING_API
143 static const TfToken &GetSchemaToken();
144
147 USDIMAGING_API
148 static const HdDataSourceLocator &GetDefaultLocator();
149
151
160
162 USDIMAGING_API
163 static const HdDataSourceLocator &GetResolutionLocator();
164
166 USDIMAGING_API
167 static const HdDataSourceLocator &GetPixelAspectRatioLocator();
168
170 USDIMAGING_API
171 static const HdDataSourceLocator &GetAspectRatioConformPolicyLocator();
172
174 USDIMAGING_API
175 static const HdDataSourceLocator &GetDataWindowNDCLocator();
176
178 USDIMAGING_API
179 static const HdDataSourceLocator &GetDisableMotionBlurLocator();
180
182 USDIMAGING_API
183 static const HdDataSourceLocator &GetDisableDepthOfFieldLocator();
184
186 USDIMAGING_API
187 static const HdDataSourceLocator &GetCameraLocator();
188
190 USDIMAGING_API
191 static const HdDataSourceLocator &GetIncludedPurposesLocator();
192
194 USDIMAGING_API
195 static const HdDataSourceLocator &GetMaterialBindingPurposesLocator();
196
198 USDIMAGING_API
199 static const HdDataSourceLocator &GetRenderingColorSpaceLocator();
200
202 USDIMAGING_API
203 static const HdDataSourceLocator &GetProductsLocator();
204
206 USDIMAGING_API
207 static const HdDataSourceLocator &GetNamespacedSettingsLocator();
209
212
220 USDIMAGING_API
221 static HdContainerDataSourceHandle
222 BuildRetained(
223 const HdVec2iDataSourceHandle &resolution,
224 const HdFloatDataSourceHandle &pixelAspectRatio,
225 const HdTokenDataSourceHandle &aspectRatioConformPolicy,
226 const HdVec4fDataSourceHandle &dataWindowNDC,
227 const HdBoolDataSourceHandle &disableMotionBlur,
228 const HdBoolDataSourceHandle &disableDepthOfField,
229 const HdPathDataSourceHandle &camera,
230 const HdTokenArrayDataSourceHandle &includedPurposes,
231 const HdTokenArrayDataSourceHandle &materialBindingPurposes,
232 const HdTokenDataSourceHandle &renderingColorSpace,
233 const HdPathArrayDataSourceHandle &products,
234 const HdContainerDataSourceHandle &namespacedSettings
235 );
236
244 {
245 public:
246 USDIMAGING_API
247 Builder &SetResolution(
248 const HdVec2iDataSourceHandle &resolution);
249 USDIMAGING_API
250 Builder &SetPixelAspectRatio(
251 const HdFloatDataSourceHandle &pixelAspectRatio);
252 USDIMAGING_API
253 Builder &SetAspectRatioConformPolicy(
254 const HdTokenDataSourceHandle &aspectRatioConformPolicy);
255 USDIMAGING_API
256 Builder &SetDataWindowNDC(
257 const HdVec4fDataSourceHandle &dataWindowNDC);
258 USDIMAGING_API
259 Builder &SetDisableMotionBlur(
260 const HdBoolDataSourceHandle &disableMotionBlur);
261 USDIMAGING_API
262 Builder &SetDisableDepthOfField(
263 const HdBoolDataSourceHandle &disableDepthOfField);
264 USDIMAGING_API
265 Builder &SetCamera(
266 const HdPathDataSourceHandle &camera);
267 USDIMAGING_API
268 Builder &SetIncludedPurposes(
269 const HdTokenArrayDataSourceHandle &includedPurposes);
270 USDIMAGING_API
271 Builder &SetMaterialBindingPurposes(
272 const HdTokenArrayDataSourceHandle &materialBindingPurposes);
273 USDIMAGING_API
274 Builder &SetRenderingColorSpace(
275 const HdTokenDataSourceHandle &renderingColorSpace);
276 USDIMAGING_API
277 Builder &SetProducts(
278 const HdPathArrayDataSourceHandle &products);
279 USDIMAGING_API
280 Builder &SetNamespacedSettings(
281 const HdContainerDataSourceHandle &namespacedSettings);
282
284 USDIMAGING_API
285 HdContainerDataSourceHandle Build();
286
287 private:
288 HdVec2iDataSourceHandle _resolution;
289 HdFloatDataSourceHandle _pixelAspectRatio;
290 HdTokenDataSourceHandle _aspectRatioConformPolicy;
291 HdVec4fDataSourceHandle _dataWindowNDC;
292 HdBoolDataSourceHandle _disableMotionBlur;
293 HdBoolDataSourceHandle _disableDepthOfField;
294 HdPathDataSourceHandle _camera;
295 HdTokenArrayDataSourceHandle _includedPurposes;
296 HdTokenArrayDataSourceHandle _materialBindingPurposes;
297 HdTokenDataSourceHandle _renderingColorSpace;
298 HdPathArrayDataSourceHandle _products;
299 HdContainerDataSourceHandle _namespacedSettings;
300
301 };
302
304};
305
306PXR_NAMESPACE_CLOSE_SCOPE
307
308#endif
Represents an object that can identify the location of a data source.
Schema classes represent a structured view of the inherently unstructured container data source passe...
Definition: schema.h:43
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:88
Utility class for setting sparse sets of child data source fields to be filled as arguments into Buil...
USDIMAGING_API HdContainerDataSourceHandle Build()
Returns a container data source containing the members set thus far.
#define TF_DECLARE_PUBLIC_TOKENS(...)
Macro to define public tokens.
Definition: staticTokens.h:98