HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
tokens.h
Go to the documentation of this file.
1 //
2 // Copyright 2016 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 //
24 #ifndef USDRENDER_TOKENS_H
25 #define USDRENDER_TOKENS_H
26 
27 /// \file usdRender/tokens.h
28 
29 // XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
30 //
31 // This is an automatically generated file (by usdGenSchema.py).
32 // Do not hand-edit!
33 //
34 // XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
35 
36 #include "pxr/pxr.h"
37 #include "pxr/usd/usdRender/api.h"
38 #include "pxr/base/tf/staticData.h"
39 #include "pxr/base/tf/token.h"
40 #include <vector>
41 
43 
44 
45 /// \class UsdRenderTokensType
46 ///
47 /// \link UsdRenderTokens \endlink provides static, efficient
48 /// \link TfToken TfTokens\endlink for use in all public USD API.
49 ///
50 /// These tokens are auto-generated from the module's schema, representing
51 /// property names, for when you need to fetch an attribute or relationship
52 /// directly by name, e.g. UsdPrim::GetAttribute(), in the most efficient
53 /// manner, and allow the compiler to verify that you spelled the name
54 /// correctly.
55 ///
56 /// UsdRenderTokens also contains all of the \em allowedTokens values
57 /// declared for schema builtin attributes of 'token' scene description type.
58 /// Use UsdRenderTokens like so:
59 ///
60 /// \code
61 /// gprim.GetMyTokenValuedAttr().Set(UsdRenderTokens->adjustApertureHeight);
62 /// \endcode
65  /// \brief "adjustApertureHeight"
66  ///
67  /// Possible value for UsdRenderSettingsBase::GetAspectRatioConformPolicyAttr()
69  /// \brief "adjustApertureWidth"
70  ///
71  /// Possible value for UsdRenderSettingsBase::GetAspectRatioConformPolicyAttr()
73  /// \brief "adjustPixelAspectRatio"
74  ///
75  /// Possible value for UsdRenderSettingsBase::GetAspectRatioConformPolicyAttr()
77  /// \brief "aspectRatioConformPolicy"
78  ///
79  /// UsdRenderSettingsBase
81  /// \brief "camera"
82  ///
83  /// UsdRenderSettingsBase
84  const TfToken camera;
85  /// \brief "color3f"
86  ///
87  /// Default value for UsdRenderVar::GetDataTypeAttr()
89  /// \brief "cropAperture"
90  ///
91  /// Possible value for UsdRenderSettingsBase::GetAspectRatioConformPolicyAttr()
93  /// \brief "dataType"
94  ///
95  /// UsdRenderVar
97  /// \brief "dataWindowNDC"
98  ///
99  /// UsdRenderSettingsBase
101  /// \brief "disableMotionBlur"
102  ///
103  /// UsdRenderSettingsBase
105  /// \brief "expandAperture"
106  ///
107  /// Possible value for UsdRenderSettingsBase::GetAspectRatioConformPolicyAttr(), Default value for UsdRenderSettingsBase::GetAspectRatioConformPolicyAttr()
109  /// \brief "full"
110  ///
111  /// Possible value for UsdRenderSettings::GetMaterialBindingPurposesAttr()
112  const TfToken full;
113  /// \brief "includedPurposes"
114  ///
115  /// UsdRenderSettings
117  /// \brief "instantaneousShutter"
118  ///
119  /// UsdRenderSettingsBase
121  /// \brief "intrinsic"
122  ///
123  /// Possible value for UsdRenderVar::GetSourceTypeAttr()
125  /// \brief "lpe"
126  ///
127  /// Possible value for UsdRenderVar::GetSourceTypeAttr()
128  const TfToken lpe;
129  /// \brief "materialBindingPurposes"
130  ///
131  /// UsdRenderSettings
133  /// \brief "orderedVars"
134  ///
135  /// UsdRenderProduct
137  /// \brief "pixelAspectRatio"
138  ///
139  /// UsdRenderSettingsBase
141  /// \brief "preview"
142  ///
143  /// Possible value for UsdRenderSettings::GetMaterialBindingPurposesAttr()
145  /// \brief "primvar"
146  ///
147  /// Possible value for UsdRenderVar::GetSourceTypeAttr()
149  /// \brief "productName"
150  ///
151  /// UsdRenderProduct
153  /// \brief "products"
154  ///
155  /// UsdRenderSettings
157  /// \brief "productType"
158  ///
159  /// UsdRenderProduct
161  /// \brief "raster"
162  ///
163  /// RenderProduct productType value that indicates a 2D raster image of pixels., Default value for UsdRenderProduct::GetProductTypeAttr()
165  /// \brief "raw"
166  ///
167  /// Possible value for UsdRenderVar::GetSourceTypeAttr(), Default value for UsdRenderVar::GetSourceTypeAttr()
168  const TfToken raw;
169  /// \brief "renderSettingsPrimPath"
170  ///
171  /// Stage-level metadata that encodes the path to UsdRenderSettingsPrim to use for rendering.
173  /// \brief "resolution"
174  ///
175  /// UsdRenderSettingsBase
177  /// \brief "sourceName"
178  ///
179  /// UsdRenderVar
181  /// \brief "sourceType"
182  ///
183  /// UsdRenderVar
185  /// A vector of all of the tokens listed above.
186  const std::vector<TfToken> allTokens;
187 };
188 
189 /// \var UsdRenderTokens
190 ///
191 /// A global variable with static, efficient \link TfToken TfTokens\endlink
192 /// for use in all public USD API. \sa UsdRenderTokensType
194 
196 
197 #endif
const TfToken resolution
"resolution"
Definition: tokens.h:176
const TfToken raster
"raster"
Definition: tokens.h:164
const TfToken raw
"raw"
Definition: tokens.h:168
const TfToken primvar
"primvar"
Definition: tokens.h:148
#define USDRENDER_API
Definition: api.h:40
const TfToken camera
"camera"
Definition: tokens.h:84
const TfToken full
"full"
Definition: tokens.h:112
const TfToken aspectRatioConformPolicy
"aspectRatioConformPolicy"
Definition: tokens.h:80
const TfToken lpe
"lpe"
Definition: tokens.h:128
const TfToken includedPurposes
"includedPurposes"
Definition: tokens.h:116
const std::vector< TfToken > allTokens
A vector of all of the tokens listed above.
Definition: tokens.h:186
const TfToken productName
"productName"
Definition: tokens.h:152
const TfToken renderSettingsPrimPath
"renderSettingsPrimPath"
Definition: tokens.h:172
const TfToken disableMotionBlur
"disableMotionBlur"
Definition: tokens.h:104
const TfToken pixelAspectRatio
"pixelAspectRatio"
Definition: tokens.h:140
Definition: token.h:87
const TfToken adjustApertureWidth
"adjustApertureWidth"
Definition: tokens.h:72
const TfToken sourceType
"sourceType"
Definition: tokens.h:184
const TfToken orderedVars
"orderedVars"
Definition: tokens.h:136
const TfToken preview
"preview"
Definition: tokens.h:144
const TfToken intrinsic
"intrinsic"
Definition: tokens.h:124
USDRENDER_API UsdRenderTokensType()
const TfToken adjustPixelAspectRatio
"adjustPixelAspectRatio"
Definition: tokens.h:76
const TfToken instantaneousShutter
"instantaneousShutter"
Definition: tokens.h:120
const TfToken productType
"productType"
Definition: tokens.h:160
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1394
const TfToken dataType
"dataType"
Definition: tokens.h:96
const TfToken color3f
"color3f"
Definition: tokens.h:88
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
const TfToken adjustApertureHeight
"adjustApertureHeight"
Definition: tokens.h:68
const TfToken materialBindingPurposes
"materialBindingPurposes"
Definition: tokens.h:132
const TfToken dataWindowNDC
"dataWindowNDC"
Definition: tokens.h:100
const TfToken sourceName
"sourceName"
Definition: tokens.h:180
USDRENDER_API TfStaticData< UsdRenderTokensType > UsdRenderTokens
const TfToken cropAperture
"cropAperture"
Definition: tokens.h:92
const TfToken products
"products"
Definition: tokens.h:156
const TfToken expandAperture
"expandAperture"
Definition: tokens.h:108