HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
renderProductSchema.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 //
7 ////////////////////////////////////////////////////////////////////////
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_IMAGING_HD_RENDER_PRODUCT_SCHEMA_H
19 #define PXR_IMAGING_HD_RENDER_PRODUCT_SCHEMA_H
20 
21 /// \file
22 
23 #include "pxr/imaging/hd/api.h"
25 
26 #include "pxr/imaging/hd/schema.h"
27 
28 // --(BEGIN CUSTOM CODE: Includes)--
29 // --(END CUSTOM CODE: Includes)--
30 
31 // --(BEGIN CUSTOM CODE: Includes)--
32 // --(END CUSTOM CODE: Includes)--
33 
35 
36 // --(BEGIN CUSTOM CODE: Declares)--
37 // --(END CUSTOM CODE: Declares)--
38 
39 #define HD_RENDER_PRODUCT_SCHEMA_TOKENS \
40  (renderProduct) \
41  (path) \
42  (type) \
43  (name) \
44  (resolution) \
45  (renderVars) \
46  (cameraPrim) \
47  (pixelAspectRatio) \
48  (aspectRatioConformPolicy) \
49  (apertureSize) \
50  (dataWindowNDC) \
51  (disableMotionBlur) \
52  (disableDepthOfField) \
53  (namespacedSettings) \
54 
55 TF_DECLARE_PUBLIC_TOKENS(HdRenderProductSchemaTokens, HD_API,
57 
58 //-----------------------------------------------------------------------------
59 
60 
62 {
63 public:
64  /// \name Schema retrieval
65  /// @{
66 
67  HdRenderProductSchema(HdContainerDataSourceHandle container)
68  : HdSchema(container) {}
69 
70  /// Retrieves a container data source with the schema's default name token
71  /// "renderProduct" from the parent container and constructs a
72  /// HdRenderProductSchema instance.
73  /// Because the requested container data source may not exist, the result
74  /// should be checked with IsDefined() or a bool comparison before use.
75  HD_API
77  const HdContainerDataSourceHandle &fromParentContainer);
78 
79  /// @}
80 
81 // --(BEGIN CUSTOM CODE: Schema Methods)--
82 // --(END CUSTOM CODE: Schema Methods)--
83 
84  /// \name Member accessor
85  /// @{
86 
87  HD_API
89 
90  HD_API
92 
93  HD_API
95 
96  HD_API
98 
99  HD_API
101 
102  HD_API
104 
105  HD_API
107 
108  HD_API
110 
111  HD_API
113 
114  HD_API
116 
117  HD_API
119 
120  HD_API
122 
123  HD_API
124  HdContainerDataSourceHandle GetNamespacedSettings() const;
125 
126  /// @}
127 
128  /// \name Schema location
129  /// @{
130 
131  /// Returns a token where the container representing this schema is found in
132  /// a container by default.
133  HD_API
134  static const TfToken &GetSchemaToken();
135 
136  /// Returns an HdDataSourceLocator (relative to the prim-level data source)
137  /// where the container representing this schema is found by default.
138  HD_API
139  static const HdDataSourceLocator &GetDefaultLocator();
140 
141  /// @}
142 
143  /// \name Data source locators for members
144  ///
145  /// The following methods return an HdDataSourceLocator (relative to the
146  /// prim-level data source) where the data source for a member can be found.
147  ///
148  /// This is often useful for checking intersection against the
149  /// HdDataSourceLocatorSet sent with HdDataSourceObserver::PrimsDirtied.
150  /// @{
151 
152  /// Prim-level relative data source locator to locate resolution.
153  HD_API
155 
156  /// Prim-level relative data source locator to locate renderVars.
157  HD_API
159 
160  /// Prim-level relative data source locator to locate namespacedSettings.
161  HD_API
163  /// @}
164 
165  /// \name Schema construction
166  /// @{
167 
168  /// \deprecated Use Builder instead.
169  ///
170  /// Builds a container data source which includes the provided child data
171  /// sources. Parameters with nullptr values are excluded. This is a
172  /// low-level interface. For cases in which it's desired to define
173  /// the container with a sparse set of child fields, the Builder class
174  /// is often more convenient and readable.
175  HD_API
176  static HdContainerDataSourceHandle
182  const HdVectorDataSourceHandle &renderVars,
183  const HdPathDataSourceHandle &cameraPrim,
186  const HdVec2fDataSourceHandle &apertureSize,
189  const HdBoolDataSourceHandle &disableDepthOfField,
190  const HdContainerDataSourceHandle &namespacedSettings
191  );
192 
193  /// \class HdRenderProductSchema::Builder
194  ///
195  /// Utility class for setting sparse sets of child data source fields to be
196  /// filled as arguments into BuildRetained. Because all setter methods
197  /// return a reference to the instance, this can be used in the "builder
198  /// pattern" form.
199  class Builder
200  {
201  public:
202  HD_API
203  Builder &SetPath(
205  HD_API
206  Builder &SetType(
208  HD_API
209  Builder &SetName(
211  HD_API
214  HD_API
216  const HdVectorDataSourceHandle &renderVars);
217  HD_API
219  const HdPathDataSourceHandle &cameraPrim);
220  HD_API
223  HD_API
226  HD_API
228  const HdVec2fDataSourceHandle &apertureSize);
229  HD_API
232  HD_API
235  HD_API
237  const HdBoolDataSourceHandle &disableDepthOfField);
238  HD_API
240  const HdContainerDataSourceHandle &namespacedSettings);
241 
242  /// Returns a container data source containing the members set thus far.
243  HD_API
244  HdContainerDataSourceHandle Build();
245 
246  private:
250  HdVec2iDataSourceHandle _resolution;
251  HdVectorDataSourceHandle _renderVars;
252  HdPathDataSourceHandle _cameraPrim;
253  HdFloatDataSourceHandle _pixelAspectRatio;
254  HdTokenDataSourceHandle _aspectRatioConformPolicy;
255  HdVec2fDataSourceHandle _apertureSize;
256  HdVec4fDataSourceHandle _dataWindowNDC;
257  HdBoolDataSourceHandle _disableMotionBlur;
258  HdBoolDataSourceHandle _disableDepthOfField;
259  HdContainerDataSourceHandle _namespacedSettings;
260 
261  };
262 
263  /// @}
264 };
265 
267 
268 #endif
static HD_API const HdDataSourceLocator & GetResolutionLocator()
Prim-level relative data source locator to locate resolution.
static HD_API const HdDataSourceLocator & GetNamespacedSettingsLocator()
Prim-level relative data source locator to locate namespacedSettings.
HdFloatDataSource::Handle HdFloatDataSourceHandle
static HD_API const TfToken & GetSchemaToken()
HD_API HdFloatDataSourceHandle GetPixelAspectRatio() const
HD_API HdPathDataSourceHandle GetPath() const
GLsizei const GLchar *const * path
Definition: glcorearb.h:3341
HD_API Builder & SetDisableMotionBlur(const HdBoolDataSourceHandle &disableMotionBlur)
HD_API HdRenderVarVectorSchema GetRenderVars() const
HD_API HdVec4fDataSourceHandle GetDataWindowNDC() const
HD_API Builder & SetType(const HdTokenDataSourceHandle &type)
HD_API Builder & SetRenderVars(const HdVectorDataSourceHandle &renderVars)
#define HD_API
Definition: api.h:23
HD_API HdBoolDataSourceHandle GetDisableMotionBlur() const
HdVec4fDataSource::Handle HdVec4fDataSourceHandle
HUSD_API const char * aspectRatioConformPolicy()
static HD_API HdRenderProductSchema GetFromParent(const HdContainerDataSourceHandle &fromParentContainer)
HD_API Builder & SetName(const HdTokenDataSourceHandle &name)
#define HD_RENDER_PRODUCT_SCHEMA_TOKENS
static HD_API const HdDataSourceLocator & GetDefaultLocator()
GLint GLint GLsizei GLint GLenum GLenum type
Definition: glcorearb.h:108
Definition: token.h:70
static HD_API HdContainerDataSourceHandle BuildRetained(const HdPathDataSourceHandle &path, const HdTokenDataSourceHandle &type, const HdTokenDataSourceHandle &name, const HdVec2iDataSourceHandle &resolution, const HdVectorDataSourceHandle &renderVars, const HdPathDataSourceHandle &cameraPrim, const HdFloatDataSourceHandle &pixelAspectRatio, const HdTokenDataSourceHandle &aspectRatioConformPolicy, const HdVec2fDataSourceHandle &apertureSize, const HdVec4fDataSourceHandle &dataWindowNDC, const HdBoolDataSourceHandle &disableMotionBlur, const HdBoolDataSourceHandle &disableDepthOfField, const HdContainerDataSourceHandle &namespacedSettings)
HD_API HdContainerDataSourceHandle GetNamespacedSettings() const
HD_API HdTokenDataSourceHandle GetAspectRatioConformPolicy() const
HD_API HdBoolDataSourceHandle GetDisableDepthOfField() const
HdBoolDataSource::Handle HdBoolDataSourceHandle
HdVec2fDataSource::Handle HdVec2fDataSourceHandle
HdRenderProductSchema(HdContainerDataSourceHandle container)
HD_API Builder & SetDisableDepthOfField(const HdBoolDataSourceHandle &disableDepthOfField)
HD_API HdVec2iDataSourceHandle GetResolution() const
HD_API Builder & SetResolution(const HdVec2iDataSourceHandle &resolution)
HD_API Builder & SetCameraPrim(const HdPathDataSourceHandle &cameraPrim)
HUSD_API const char * resolution()
GLuint const GLchar * name
Definition: glcorearb.h:786
HD_API Builder & SetNamespacedSettings(const HdContainerDataSourceHandle &namespacedSettings)
HUSD_API const char * pixelAspectRatio()
HD_API Builder & SetApertureSize(const HdVec2fDataSourceHandle &apertureSize)
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1425
HD_API Builder & SetPath(const HdPathDataSourceHandle &path)
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:74
HD_API Builder & SetDataWindowNDC(const HdVec4fDataSourceHandle &dataWindowNDC)
HdVec2iDataSource::Handle HdVec2iDataSourceHandle
HD_API HdTokenDataSourceHandle GetName() const
HUSD_API const char * dataWindowNDC()
TF_DECLARE_PUBLIC_TOKENS(HdRenderProductSchemaTokens, HD_API, HD_RENDER_PRODUCT_SCHEMA_TOKENS)
HD_API Builder & SetAspectRatioConformPolicy(const HdTokenDataSourceHandle &aspectRatioConformPolicy)
HD_API HdTokenDataSourceHandle GetType() const
HD_API HdContainerDataSourceHandle Build()
Returns a container data source containing the members set thus far.
HdPathDataSource::Handle HdPathDataSourceHandle
HD_API HdVec2fDataSourceHandle GetApertureSize() const
static HD_API const HdDataSourceLocator & GetRenderVarsLocator()
Prim-level relative data source locator to locate renderVars.
HdTokenDataSource::Handle HdTokenDataSourceHandle
HD_API Builder & SetPixelAspectRatio(const HdFloatDataSourceHandle &pixelAspectRatio)
HD_API HdPathDataSourceHandle GetCameraPrim() const
HUSD_API const char * disableMotionBlur()