Loading...
Searching...
No Matches
UsdHydraTokensType Class Reference

UsdHydraTokens provides static, efficient TfTokens for use in all public USD API. More...

#include <tokens.h>

Public Attributes

const TfToken black
 "black"
 
const TfToken clamp
 "clamp"
 
const TfToken displayLookBxdf
 "displayLook:bxdf"
 
const TfToken faceIndex
 "faceIndex"
 
const TfToken faceOffset
 "faceOffset"
 
const TfToken frame
 "frame"
 
const TfToken HwPrimvar_1
 "HwPrimvar_1"
 
const TfToken HwPtexTexture_1
 "HwPtexTexture_1"
 
const TfToken HwUvTexture_1
 "HwUvTexture_1"
 
const TfToken hydraGenerativeProcedural
 "hydraGenerativeProcedural"
 
const TfToken infoFilename
 "inputs:file"
 
const TfToken infoVarname
 "inputs:varname"
 
const TfToken linear
 "linear"
 
const TfToken linearMipmapLinear
 "linearMipmapLinear"
 
const TfToken linearMipmapNearest
 "linearMipmapNearest"
 
const TfToken magFilter
 "magFilter"
 
const TfToken minFilter
 "minFilter"
 
const TfToken mirror
 "mirror"
 
const TfToken nearest
 "nearest"
 
const TfToken nearestMipmapLinear
 "nearestMipmapLinear"
 
const TfToken nearestMipmapNearest
 "nearestMipmapNearest"
 
const TfToken primvarsHdGpProceduralType
 "primvars:hdGp:proceduralType"
 
const TfToken proceduralSystem
 "proceduralSystem"
 
const TfToken repeat
 "repeat"
 
const TfToken textureMemory
 "textureMemory"
 
const TfToken useMetadata
 "useMetadata"
 
const TfToken uv
 "uv"
 
const TfToken wrapS
 "wrapS"
 
const TfToken wrapT
 "wrapT"
 
const TfToken HydraGenerativeProceduralAPI
 "HydraGenerativeProceduralAPI"
 
const std::vector< TfTokenallTokens
 A vector of all of the tokens listed above.
 

Detailed Description

UsdHydraTokens provides static, efficient TfTokens for use in all public USD API.

These tokens are auto-generated from the module's schema, representing property names, for when you need to fetch an attribute or relationship directly by name, e.g. UsdPrim::GetAttribute(), in the most efficient manner, and allow the compiler to verify that you spelled the name correctly.

UsdHydraTokens also contains all of the allowedTokens values declared for schema builtin attributes of 'token' scene description type. Use UsdHydraTokens like so:

gprim.GetMyTokenValuedAttr().Set(UsdHydraTokens->black);
USDHYDRA_API TfStaticData< UsdHydraTokensType > UsdHydraTokens
A global variable with static, efficient TfTokens for use in all public USD API.

Definition at line 63 of file tokens.h.

Member Data Documentation

◆ allTokens

const std::vector<TfToken> allTokens

A vector of all of the tokens listed above.

Definition at line 186 of file tokens.h.

◆ black

const TfToken black

"black"

Possible value for "wrapT" and "wrapS" inputs on a "UvTexture" shader prim. Causes black to be returned when sampling outside the bounds of the texture.

Definition at line 68 of file tokens.h.

◆ clamp

const TfToken clamp

"clamp"

Possible value for "wrapT" and "wrapS" inputs on a "UvTexture" shader prim. Causes the the texture coordinate to be clamped to [0,1].

Definition at line 72 of file tokens.h.

◆ displayLookBxdf

const TfToken displayLookBxdf

"displayLook:bxdf"

deprecated This has been deprecated in favor of the glslfx:surface output. Relationship on a material that targets the "bxdf" or the surface shader prim.

Definition at line 76 of file tokens.h.

◆ faceIndex

const TfToken faceIndex

"faceIndex"

The "faceIndex" shader input on a hydra "PtexTexture" shader.

Definition at line 80 of file tokens.h.

◆ faceOffset

const TfToken faceOffset

"faceOffset"

The "faceOffset" shader input on a hydra "PtexTexture" shader.

Definition at line 84 of file tokens.h.

◆ frame

const TfToken frame

"frame"

A shader input on a "Texture" shader.

Definition at line 88 of file tokens.h.

◆ HwPrimvar_1

const TfToken HwPrimvar_1

"HwPrimvar_1"

The id value of a Primvar shader.

Definition at line 92 of file tokens.h.

◆ HwPtexTexture_1

const TfToken HwPtexTexture_1

"HwPtexTexture_1"

The id value of a PtexTexture shader.

Definition at line 96 of file tokens.h.

◆ HwUvTexture_1

const TfToken HwUvTexture_1

"HwUvTexture_1"

The id value of a UvTexture shader.

Definition at line 100 of file tokens.h.

◆ hydraGenerativeProcedural

const TfToken hydraGenerativeProcedural

"hydraGenerativeProcedural"

Fallback value for UsdHydraGenerativeProceduralAPI::GetProceduralSystemAttr()

Definition at line 104 of file tokens.h.

◆ HydraGenerativeProceduralAPI

const TfToken HydraGenerativeProceduralAPI

"HydraGenerativeProceduralAPI"

Schema identifer and family for UsdHydraGenerativeProceduralAPI

Definition at line 184 of file tokens.h.

◆ infoFilename

const TfToken infoFilename

"inputs:file"

The special "info:filename" property of a hydra Texture shader, which points to a resolvable texture asset.

Definition at line 108 of file tokens.h.

◆ infoVarname

const TfToken infoVarname

"inputs:varname"

Definition at line 112 of file tokens.h.

◆ linear

const TfToken linear

"linear"

A weighted linear blend of nearest adjacent samples. Possible value for "minFilter" and "magFilter" inputs on a UvTextureshader.

Definition at line 116 of file tokens.h.

◆ linearMipmapLinear

const TfToken linearMipmapLinear

"linearMipmapLinear"

See https://www.opengl.org/wiki/Sampler_Object , Possible value for the "minFilter" input on a UvTexture shader.

Definition at line 120 of file tokens.h.

◆ linearMipmapNearest

const TfToken linearMipmapNearest

"linearMipmapNearest"

See https://www.opengl.org/wiki/Sampler_Object Possible value for the "minFilter" input on a UvTexture shader.

Definition at line 124 of file tokens.h.

◆ magFilter

const TfToken magFilter

"magFilter"

An input on a UvTexture shader.

Definition at line 128 of file tokens.h.

◆ minFilter

const TfToken minFilter

"minFilter"

An input on a UvTexture shader.

Definition at line 132 of file tokens.h.

◆ mirror

const TfToken mirror

"mirror"

Possible value for "wrapT" and "wrapS" inputs on a "UvTexture" shader prim. Causes the texture coordinate to wrap around like a mirror. -0.2 becomes 0.2, -1.2 becomes 0.8, etc. ,

Definition at line 136 of file tokens.h.

◆ nearest

const TfToken nearest

"nearest"

Selects the nearest sample for the given coordinate Possible value for "minFilter" and "magFilter" inputs on a UvTexture shader.

Definition at line 140 of file tokens.h.

◆ nearestMipmapLinear

const TfToken nearestMipmapLinear

"nearestMipmapLinear"

See https://www.opengl.org/wiki/Sampler_Object Possible value for "minFilter" and "magFilter" inputs on a UvTexture shader.

Definition at line 144 of file tokens.h.

◆ nearestMipmapNearest

const TfToken nearestMipmapNearest

"nearestMipmapNearest"

See https://www.opengl.org/wiki/Sampler_Object Possible value for the "minFilter" input on a UvTexture shader.

Definition at line 148 of file tokens.h.

◆ primvarsHdGpProceduralType

const TfToken primvarsHdGpProceduralType

"primvars:hdGp:proceduralType"

UsdHydraGenerativeProceduralAPI

Definition at line 152 of file tokens.h.

◆ proceduralSystem

const TfToken proceduralSystem

"proceduralSystem"

UsdHydraGenerativeProceduralAPI

Definition at line 156 of file tokens.h.

◆ repeat

const TfToken repeat

"repeat"

Possible value for "wrapT" and "wrapS" inputs on a "UvTexture" shader prim. Causes the texture coordinate to wrap around the texture. So a texture coordinate of -0.2 becomes the equivalent of 0.8.

Definition at line 160 of file tokens.h.

◆ textureMemory

const TfToken textureMemory

"textureMemory"

A shader input on a hydra Texture shader.

Definition at line 164 of file tokens.h.

◆ useMetadata

const TfToken useMetadata

"useMetadata"

Possible value for "wrapT" and "wrapS" inputs on a "UvTexture" shader prim. Causes the wrap value to be loaded from the texture file instead of being specified in the prim. If the texture file doesn't support metadata or the metadata doesn't contain a wrap mode, the "black" wrap mode is used.

Definition at line 168 of file tokens.h.

◆ uv

const TfToken uv

"uv"

A shader input on a hydra UvTexture shader.

Definition at line 172 of file tokens.h.

◆ wrapS

const TfToken wrapS

"wrapS"

A shader input on a hydra UvTexture shader which defines the behavior of texture coordinates that are outside the bounds of the texture.

Definition at line 176 of file tokens.h.

◆ wrapT

const TfToken wrapT

"wrapT"

A shader input on a hydra UvTexture shader which defines the behavior of texture coordinates that are outside the bounds of the texture.

Definition at line 180 of file tokens.h.


The documentation for this class was generated from the following file: