Loading...
Searching...
No Matches
usdRenderSettingsSchema.h
Go to the documentation of this file.
1//
2// Copyright 2023 Pixar
3//
4// Licensed under the terms set forth in the LICENSE.txt file available at
5// https://openusd.org/license.
6//
8
9/* ************************************************************************** */
10/* ** ** */
11/* ** This file is generated by a script. ** */
12/* ** ** */
13/* ** Do not edit it directly (unless it is within a CUSTOM CODE section)! ** */
14/* ** Edit hdSchemaDefs.py instead to make changes. ** */
15/* ** ** */
16/* ************************************************************************** */
17
18#ifndef PXR_USD_IMAGING_USD_IMAGING_USD_RENDER_SETTINGS_SCHEMA_H
19#define PXR_USD_IMAGING_USD_IMAGING_USD_RENDER_SETTINGS_SCHEMA_H
20
22
23#include "pxr/usdImaging/usdImaging/api.h"
24
25#include "pxr/imaging/hd/schema.h"
26
27// --(BEGIN CUSTOM CODE: Includes)--
28// --(END CUSTOM CODE: Includes)--
29
30PXR_NAMESPACE_OPEN_SCOPE
31
32// --(BEGIN CUSTOM CODE: Declares)--
33// --(END CUSTOM CODE: Declares)--
34
35#define USD_IMAGING_USD_RENDER_SETTINGS_SCHEMA_TOKENS \
36 (__usdRenderSettings) \
37 (resolution) \
38 (pixelAspectRatio) \
39 (aspectRatioConformPolicy) \
40 (dataWindowNDC) \
41 (disableMotionBlur) \
42 (disableDepthOfField) \
43 (camera) \
44 (includedPurposes) \
45 (materialBindingPurposes) \
46 (renderingColorSpace) \
47 (products) \
48 (namespacedSettings) \
49
50TF_DECLARE_PUBLIC_TOKENS(UsdImagingUsdRenderSettingsSchemaTokens, USDIMAGING_API,
51 USD_IMAGING_USD_RENDER_SETTINGS_SCHEMA_TOKENS);
52
53//-----------------------------------------------------------------------------
54
55
56class UsdImagingUsdRenderSettingsSchema : public HdSchema
57{
58public:
61
62 UsdImagingUsdRenderSettingsSchema(HdContainerDataSourceHandle container)
63 : HdSchema(container) {}
64
70 USDIMAGING_API
71 static UsdImagingUsdRenderSettingsSchema GetFromParent(
72 const HdContainerDataSourceHandle &fromParentContainer);
73
75
76// --(BEGIN CUSTOM CODE: Schema Methods)--
77// --(END CUSTOM CODE: Schema Methods)--
78
81
82 USDIMAGING_API
83 HdVec2iDataSourceHandle GetResolution() const;
84
85 USDIMAGING_API
86 HdFloatDataSourceHandle GetPixelAspectRatio() const;
87
88 USDIMAGING_API
89 HdTokenDataSourceHandle GetAspectRatioConformPolicy() const;
90
91 USDIMAGING_API
92 HdVec4fDataSourceHandle GetDataWindowNDC() const;
93
94 USDIMAGING_API
95 HdBoolDataSourceHandle GetDisableMotionBlur() const;
96
97 USDIMAGING_API
98 HdBoolDataSourceHandle GetDisableDepthOfField() const;
99
100 USDIMAGING_API
101 HdPathDataSourceHandle GetCamera() const;
102
103 USDIMAGING_API
104 HdTokenArrayDataSourceHandle GetIncludedPurposes() const;
105
106 USDIMAGING_API
107 HdTokenArrayDataSourceHandle GetMaterialBindingPurposes() const;
108
109 USDIMAGING_API
110 HdTokenDataSourceHandle GetRenderingColorSpace() const;
111
112 USDIMAGING_API
113 HdPathArrayDataSourceHandle GetProducts() const;
114
115 USDIMAGING_API
116 HdContainerDataSourceHandle GetNamespacedSettings() const;
117
119
122
125 USDIMAGING_API
126 static const TfToken &GetSchemaToken();
127
130 USDIMAGING_API
131 static const HdDataSourceLocator &GetDefaultLocator();
132
134
143
145 USDIMAGING_API
146 static const HdDataSourceLocator &GetResolutionLocator();
147
149 USDIMAGING_API
150 static const HdDataSourceLocator &GetPixelAspectRatioLocator();
151
153 USDIMAGING_API
154 static const HdDataSourceLocator &GetAspectRatioConformPolicyLocator();
155
157 USDIMAGING_API
158 static const HdDataSourceLocator &GetDataWindowNDCLocator();
159
161 USDIMAGING_API
162 static const HdDataSourceLocator &GetDisableMotionBlurLocator();
163
165 USDIMAGING_API
166 static const HdDataSourceLocator &GetDisableDepthOfFieldLocator();
167
169 USDIMAGING_API
170 static const HdDataSourceLocator &GetCameraLocator();
171
173 USDIMAGING_API
174 static const HdDataSourceLocator &GetIncludedPurposesLocator();
175
177 USDIMAGING_API
178 static const HdDataSourceLocator &GetMaterialBindingPurposesLocator();
179
181 USDIMAGING_API
182 static const HdDataSourceLocator &GetRenderingColorSpaceLocator();
183
185 USDIMAGING_API
186 static const HdDataSourceLocator &GetProductsLocator();
187
189 USDIMAGING_API
190 static const HdDataSourceLocator &GetNamespacedSettingsLocator();
192
195
203 USDIMAGING_API
204 static HdContainerDataSourceHandle
205 BuildRetained(
206 const HdVec2iDataSourceHandle &resolution,
207 const HdFloatDataSourceHandle &pixelAspectRatio,
208 const HdTokenDataSourceHandle &aspectRatioConformPolicy,
209 const HdVec4fDataSourceHandle &dataWindowNDC,
210 const HdBoolDataSourceHandle &disableMotionBlur,
211 const HdBoolDataSourceHandle &disableDepthOfField,
212 const HdPathDataSourceHandle &camera,
213 const HdTokenArrayDataSourceHandle &includedPurposes,
214 const HdTokenArrayDataSourceHandle &materialBindingPurposes,
215 const HdTokenDataSourceHandle &renderingColorSpace,
216 const HdPathArrayDataSourceHandle &products,
217 const HdContainerDataSourceHandle &namespacedSettings
218 );
219
226 class Builder
227 {
228 public:
229 USDIMAGING_API
230 Builder &SetResolution(
231 const HdVec2iDataSourceHandle &resolution);
232 USDIMAGING_API
233 Builder &SetPixelAspectRatio(
234 const HdFloatDataSourceHandle &pixelAspectRatio);
235 USDIMAGING_API
236 Builder &SetAspectRatioConformPolicy(
237 const HdTokenDataSourceHandle &aspectRatioConformPolicy);
238 USDIMAGING_API
239 Builder &SetDataWindowNDC(
240 const HdVec4fDataSourceHandle &dataWindowNDC);
241 USDIMAGING_API
242 Builder &SetDisableMotionBlur(
243 const HdBoolDataSourceHandle &disableMotionBlur);
244 USDIMAGING_API
245 Builder &SetDisableDepthOfField(
246 const HdBoolDataSourceHandle &disableDepthOfField);
247 USDIMAGING_API
248 Builder &SetCamera(
249 const HdPathDataSourceHandle &camera);
250 USDIMAGING_API
251 Builder &SetIncludedPurposes(
252 const HdTokenArrayDataSourceHandle &includedPurposes);
253 USDIMAGING_API
254 Builder &SetMaterialBindingPurposes(
255 const HdTokenArrayDataSourceHandle &materialBindingPurposes);
256 USDIMAGING_API
257 Builder &SetRenderingColorSpace(
258 const HdTokenDataSourceHandle &renderingColorSpace);
259 USDIMAGING_API
260 Builder &SetProducts(
261 const HdPathArrayDataSourceHandle &products);
262 USDIMAGING_API
263 Builder &SetNamespacedSettings(
264 const HdContainerDataSourceHandle &namespacedSettings);
265
267 USDIMAGING_API
268 HdContainerDataSourceHandle Build();
269
270 private:
271 HdVec2iDataSourceHandle _resolution;
272 HdFloatDataSourceHandle _pixelAspectRatio;
273 HdTokenDataSourceHandle _aspectRatioConformPolicy;
274 HdVec4fDataSourceHandle _dataWindowNDC;
275 HdBoolDataSourceHandle _disableMotionBlur;
276 HdBoolDataSourceHandle _disableDepthOfField;
277 HdPathDataSourceHandle _camera;
278 HdTokenArrayDataSourceHandle _includedPurposes;
279 HdTokenArrayDataSourceHandle _materialBindingPurposes;
280 HdTokenDataSourceHandle _renderingColorSpace;
281 HdPathArrayDataSourceHandle _products;
282 HdContainerDataSourceHandle _namespacedSettings;
283
284 };
285
287};
288
289PXR_NAMESPACE_CLOSE_SCOPE
290
291#endif
Builder
Helper class for storing intermediate results when building a variable expression.
Definition variableExpression.h:248
HdDataSourceLocator
Represents an object that can identify the location of a data source.
Definition dataSourceLocator.h:59
HdSchema
Schema classes represent a structured view of the inherently unstructured container data source passe...
Definition schema.h:26
TfToken
Token for efficient comparison, assignment, and hashing of known strings.
Definition token.h:71
UsdImagingUsdRenderSettingsSchema::Builder::Build
USDIMAGING_API HdContainerDataSourceHandle Build()
Returns a container data source containing the members set thus far.
TF_DECLARE_PUBLIC_TOKENS
#define TF_DECLARE_PUBLIC_TOKENS(...)
Macro to define public tokens.
Definition staticTokens.h:92