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 PXR_USD_USD_HYDRA_TOKENS_H
25 #define PXR_USD_USD_HYDRA_TOKENS_H
26 
27 /// \file usdHydra/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/usdHydra/api.h"
38 #include "pxr/base/tf/staticData.h"
39 #include "pxr/base/tf/token.h"
40 #include <vector>
41 
43 
44 
45 /// \class UsdHydraTokensType
46 ///
47 /// \link UsdHydraTokens \endlink provides static, efficient
48 /// \link TfToken TfTokens\endlink for use in all public USD API.
49 ///
50 /// These tokens were auto-generated from the deprecated UsdHydra schemas. They
51 /// represent property names, shader input names and associated values. The
52 /// schemas have been deleted, but these tokens are being kept alive to assist
53 /// with the gradual transition to the new style hydra shaders that are based
54 /// off of the new shader registry.
55 ///
58 
59  /// \brief "HwPrimvar_1"
60  ///
61  /// The id value of a Primvar shader.
63 
64  /// \brief "HwPtexTexture_1"
65  ///
66  /// The id value of a PtexTexture shader.
68 
69  /// \brief "HwUvTexture_1"
70  ///
71  /// The id value of a UvTexture shader.
73 
74  /// \brief "displayLook:bxdf"
75  /// \deprecated This has been deprecated in favor of the glslfx:surface output.
76  ///
77  /// Relationship on a material that targets the "bxdf" or the surface
78  /// shader prim.
80 
81  /// \brief "info:filename"
82  ///
83  /// The special "info:filename" property of a hydra Texture shader, which
84  /// points to a resolvable texture asset.
86 
87  /// \brief "info:varname"
88  ///
89  ///
91 
92  /// \brief "textureMemory"
93  ///
94  /// A shader input on a hydra Texture shader.
96 
97  /// \brief "frame"
98  ///
99  /// A shader input on a "Texture" shader.
100  const TfToken frame;
101 
102  /// \brief "uv"
103  ///
104  /// A shader input on a hydra UvTexture shader.
105  const TfToken uv;
106 
107  /// \brief "wrapS"
108  ///
109  /// A shader input on a hydra UvTexture shader which defines the behavior of
110  /// texture coordinates that are outside the bounds of the texture.
111  const TfToken wrapS;
112 
113  /// \brief "wrapT"
114  ///
115  /// A shader input on a hydra UvTexture shader which defines the behavior of
116  /// texture coordinates that are outside the bounds of the texture.
117  const TfToken wrapT;
118 
119  /// \brief "black"
120  ///
121  /// Possible value for "wrapT" and "wrapS" inputs on a "UvTexture"
122  /// shader prim.
123  /// Causes black to be returned when sampling outside the bounds of the
124  /// texture.,
125  const TfToken black;
126 
127  /// \brief "clamp"
128  ///
129  /// Possible value for "wrapT" and "wrapS" inputs on a "UvTexture"
130  /// shader prim.
131  /// Causes the the texture coordinate to be clamped to [0,1].
132  const TfToken clamp;
133 
134  /// \brief "mirror"
135  ///
136  /// Possible value for "wrapT" and "wrapS" inputs on a "UvTexture"
137  /// shader prim.
138  /// Causes the texture coordinate to wrap around like a mirror.
139  /// -0.2 becomes 0.2, -1.2 becomes 0.8, etc. ,
141 
142  /// \brief "repeat"
143  ///
144  /// Possible value for "wrapT" and "wrapS" inputs on a "UvTexture"
145  /// shader prim.
146  /// Causes the texture coordinate to wrap around the texture. So a texture
147  /// coordinate of -0.2 becomes the equivalent of 0.8.
149 
150  /// \brief "useMetadata"
151  ///
152  /// Possible value for "wrapT" and "wrapS" inputs on a "UvTexture"
153  /// shader prim.
154  /// Causes the wrap value to be loaded from the texture file instead
155  /// of being specified in the prim. If the texture file doesn't support
156  /// metadata or the metadata doesn't contain a wrap mode, the "black"
157  /// wrap mode is used.
159 
160  /// \brief "magFilter"
161  ///
162  /// An input on a UvTexture shader.
164 
165  /// \brief "minFilter"
166  ///
167  /// An input on a UvTexture shader.
169 
170  /// \brief "linearMipmapLinear"
171  ///
172  /// See https://www.opengl.org/wiki/Sampler_Object ,
173  /// Possible value for the "minFilter" input on a UvTexture shader.
175 
176  /// \brief "linearMipmapNearest"
177  ///
178  /// See https://www.opengl.org/wiki/Sampler_Object
179  /// Possible value for the "minFilter" input on a UvTexture shader.
181 
182  /// \brief "nearestMipmapNearest"
183  ///
184  /// See https://www.opengl.org/wiki/Sampler_Object
185  /// Possible value for the "minFilter" input on a UvTexture shader.
187 
188  /// \brief "linear"
189  ///
190  /// A weighted linear blend of nearest adjacent samples.
191  /// Possible value for "minFilter" and "magFilter" inputs on a UvTexture
192  /// shader.
194 
195  ///
196  /// \brief "nearest"
197  ///
198  /// Selects the nearest sample for the given coordinate
199  /// Possible value for "minFilter" and "magFilter" inputs on a UvTexture
200  /// shader.
202 
203  /// \brief "nearestMipmapLinear"
204  ///
205  /// See https://www.opengl.org/wiki/Sampler_Object
206  /// Possible value for "minFilter" and "magFilter" inputs on a UvTexture
207  /// shader.
209 
210  /// \brief "faceIndex"
211  ///
212  /// The "faceIndex" shader input on a hydra "PtexTexture" shader.
214 
215  /// \brief "faceOffset"
216  ///
217  /// The "faceOffset" shader input on a hydra "PtexTexture" shader.
219 
220  /// A vector of all of the tokens listed above.
221  const std::vector<TfToken> allTokens;
222 };
223 
224 /// \var UsdHydraTokens
225 ///
226 /// A global variable with static, efficient \link TfToken TfTokens\endlink
227 /// for use in all public USD API. \sa UsdHydraTokensType
229 
231 
232 #endif
const TfToken faceIndex
"faceIndex"
Definition: tokens.h:213
const TfToken repeat
"repeat"
Definition: tokens.h:148
const TfToken HwPrimvar_1
"HwPrimvar_1"
Definition: tokens.h:62
const TfToken frame
"frame"
Definition: tokens.h:100
const TfToken infoFilename
"info:filename"
Definition: tokens.h:85
#define USDHYDRA_API
Definition: api.h:40
const std::vector< TfToken > allTokens
A vector of all of the tokens listed above.
Definition: tokens.h:221
const TfToken mirror
"mirror"
Definition: tokens.h:140
Definition: token.h:87
const TfToken wrapS
"wrapS"
Definition: tokens.h:111
const TfToken linearMipmapNearest
"linearMipmapNearest"
Definition: tokens.h:180
USDHYDRA_API UsdHydraTokensType()
const TfToken textureMemory
"textureMemory"
Definition: tokens.h:95
const TfToken black
"black"
Definition: tokens.h:125
const TfToken uv
"uv"
Definition: tokens.h:105
USDHYDRA_API TfStaticData< UsdHydraTokensType > UsdHydraTokens
const TfToken nearestMipmapLinear
"nearestMipmapLinear"
Definition: tokens.h:208
const TfToken displayLookBxdf
"displayLook:bxdf"
Definition: tokens.h:79
const TfToken linear
"linear"
Definition: tokens.h:193
const TfToken wrapT
"wrapT"
Definition: tokens.h:117
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1394
const TfToken nearestMipmapNearest
"nearestMipmapNearest"
Definition: tokens.h:186
const TfToken clamp
"clamp"
Definition: tokens.h:132
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
const TfToken magFilter
"magFilter"
Definition: tokens.h:163
const TfToken HwPtexTexture_1
"HwPtexTexture_1"
Definition: tokens.h:67
const TfToken faceOffset
"faceOffset"
Definition: tokens.h:218
const TfToken nearest
"nearest"
Definition: tokens.h:201
const TfToken HwUvTexture_1
"HwUvTexture_1"
Definition: tokens.h:72
const TfToken linearMipmapLinear
"linearMipmapLinear"
Definition: tokens.h:174
const TfToken useMetadata
"useMetadata"
Definition: tokens.h:158
const TfToken minFilter
"minFilter"
Definition: tokens.h:168
const TfToken infoVarname
"info:varname"
Definition: tokens.h:90