tokens.h

Go to the documentation of this file.

//
// Copyright 2016 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_IMAGING_HD_TOKENS_H
#define PXR_IMAGING_HD_TOKENS_H

#include "pxr/pxr.h"
#include "pxr/imaging/hd/api.h"
#include "pxr/imaging/hd/version.h"
#include "pxr/base/tf/staticTokens.h"
#include "pxr/base/tf/envSetting.h"

PXR_NAMESPACE_OPEN_SCOPE

#define HD_TOKENS                               \
    (accelerations)                             \
    (adjacency)                                 \
    (angularVelocities)                         \
    (bboxLocalMin)                              \
    (bboxLocalMax)                              \
    (bbox)                                      \
    (bezier)                                    \
    (bspline)                                   \
    (blurScale)                                 \
    (camera)                                    \
    (catmullRom)                                \
    (centripetalCatmullRom)                     \
    (collection)                                \
    (computeShader)                             \
    (coordSysBindings)                          \
    (cubic)                                     \
    (cullStyle)                                 \
    (doubleSided)                               \
    (dispatchCount)                             \
    (displayColor)                              \
    (displayOpacity)                            \
    (displayStyle)                              \
    (drawDispatch)                              \
    (drawingShader)                             \
    (drawingCoord0)                             \
    (drawingCoord1)                             \
    (drawingCoord2)                             \
    (drawingCoordI)                             \
    (drivers)                                   \
    (edgeIndices)                               \
    (elementCount)                              \
    (elementsVisibility)                        \
    (extent)                                    \
    (faceColors)                                \
    (filters)                                   \
    (full)                                      \
    (geometry)                                  \
    (hermite)                                   \
    (hullIndices)                               \
    (indices)                                   \
    (isFlipped)                                 \
    (itemsDrawn)                                \
    (layout)                                    \
    (leftHanded)                                \
    (linear)                                    \
    (lightLink)                                 \
    (filterLink)                                \
    (lightFilterLink)                           \
    (lightFilterType)                           \
    (meshLight)                                 \
    (materialParams)                            \
    (materialSyncMode)                          \
    (nonlinearSampleCount)                      \
    (nonperiodic)                               \
    (normals)                                   \
    (params)                                    \
    (patchParam)                                \
    (periodic)                                  \
    (pinned)                                    \
    (points)                                    \
    (pointsIndices)                             \
    (portals)                                   \
    (power)                                     \
    (preview)                                   \
    (pointsVisibility)                          \
    (primvar)                                   \
    (primID)                                    \
    (primitiveParam)                            \
    (tessFactors)                               \
    (quadInfo)                                  \
    (renderTags)                                \
    (rightHanded)                               \
    (segmented)                                 \
    (shadowLink)                                \
    (subdivTags)                                \
    (taskState)                                 \
    (taskParams)                                \
    (topology)                                  \
    (topologyVisibility)                        \
    (totalItemCount)                            \
    (transform)                                 \
    (transformInverse)                          \
    (velocities)                                \
    (visibility)                                \
    (widths)                                    \
    (isLight)                                   \
                                                \
    /* Legacy tokens. */                        \
                                                \
    /* bSpline is a legacy alias so that */     \
    /* render delegates can compile without */  \
    /* code change. The new token for */        \
    /* bspline follows USD and has no */        \
    /* capital letters. */                      \
    ((bSpline, "bspline"))

#define HD_INSTANCER_TOKENS                                \
    (culledInstanceIndices)                                \
    (instancer)                                            \
    (instancerTransform)                                   \
    (instancerTransformInverse)                            \
    (instanceIndices)                                      \
    (instanceIndexBase)                                    \
                                                           \
    /* New instance xform tokens */                        \
    ((instanceTransforms,   "hydra:instanceTransforms"))   \
    ((instanceRotations,    "hydra:instanceRotations"))    \
    ((instanceScales,       "hydra:instanceScales"))       \
    ((instanceTranslations, "hydra:instanceTranslations"))

#define HD_REPR_TOKENS                          \
    (disabled)                                  \
    (hull)                                      \
    (points)                                    \
    (smoothHull)                                \
    (refined)                                   \
    (refinedWire)                               \
    (refinedWireOnSurf)                         \
    (refinedSolidWireOnSurf)                    \
    (wire)                                      \
    (wireOnSurf)                                \
    (solidWireOnSurf)

#define HD_CULLSTYLE_TOKENS \
    (dontCare) \
    (nothing) \
    (back) \
    (front) \
    (backUnlessDoubleSided) \
    (frontUnlessDoubleSided)

#define HD_MODEL_DRAWMODE_TOKENS                \
    (inherited)                                 \
    (origin)                                    \
    (bounds)                                    \
    (cards)                                     \
    ((default_, "default"))                     \
    (cross)                                     \
    (box)                                       \
    (fromTexture)

#define HD_PERF_TOKENS                          \
    (adjacencyBufSize)                          \
    (basisCurvesTopology)                       \
    (bufferSourcesResolved)                     \
    (bufferArrayRangeMigrated)                  \
    (bufferArrayRangeContainerResized)          \
    (committed)                                 \
    (computationsCommitted)                     \
    (drawBatches)                               \
    (drawCalls)                                 \
    (dirtyLists)                                \
    (dirtyListsRebuilt)                         \
    (garbageCollected)                          \
    (garbageCollectedSsbo)                      \
    (garbageCollectedUbo)                       \
    (garbageCollectedVbo)                       \
    (gpuMemoryUsed)                             \
    (instBasisCurvesTopology)                   \
    (instBasisCurvesTopologyRange)              \
    (instExtComputationDataRange)               \
    (instMeshTopology)                          \
    (instMeshTopologyRange)                     \
    (instPrimvarRange)                          \
    (instVertexAdjacency)                       \
    (meshTopology)                              \
    (nonUniformSize)                            \
    (numCompletedSamples)                       \
    (quadrangulateCPU)                          \
    (quadrangulateGPU)                          \
    (quadrangulateFaceVarying)                  \
    (quadrangulatedVerts)                       \
    (rebuildBatches)                            \
    (singleBufferSize)                          \
    (ssboSize)                                  \
    (skipInvisibleRprimSync)                    \
    (sourcesCommitted)                          \
    (subdivisionRefineCPU)                      \
    (subdivisionRefineGPU)                      \
    (textureMemory)                             \
    (triangulateFaceVarying)                    \
    (uboSize)                                   \
    (vboRelocated)

// XXX Move to hdSt.
#define HD_SHADER_TOKENS                        \
    (alphaThreshold)                            \
    (clipPlanes)                                \
    (commonShaderSource)                        \
    (computeShader)                             \
    (cullStyle)                                 \
    (drawRange)                                 \
    (environmentMap)                            \
    (linearExposure)                            \
    (displacementShader)                        \
    (fragmentShader)                            \
    (geometryShader)                            \
    (imageToWorldMatrix)                        \
    (imageToHorizontallyNormalizedFilmback)     \
    (indicatorColor)                            \
    (lightingBlendAmount)                       \
    (overrideColor)                             \
    (maskColor)                                 \
    (projectionMatrix)                          \
    (pointColor)                                \
    (pointSize)                                 \
    (pointSelectedSize)                         \
    (materialTag)                               \
    (numClipPlanes)                             \
    (tessControlShader)                         \
    (tessEvalShader)                            \
    (postTessControlShader)                     \
    (postTessVertexShader)                      \
    (tessLevel)                                 \
    (viewport)                                  \
    (vertexShader)                              \
    (wireframeColor)                            \
    (worldToViewMatrix)                         \
    (worldToViewInverseMatrix)                  \
    (stepSize)                                  \
    (stepSizeLighting)                          \
    (multisampleCount)

// Deprecated. Use: HdStMaterialTagTokens
#define HD_MATERIALTAG_TOKENS                   \
    (defaultMaterialTag)

/* Terminal keys used in material networks.
 */
#define HD_MATERIAL_TERMINAL_TOKENS             \
    (surface)                                   \
    (displacement)                              \
    (volume)                                    \
    (volumeFilter)                              \
    (light)                                     \
    (lightFilter)                               \
    (imageShader)

#define HD_RENDERTAG_TOKENS                     \
    (geometry)                                  \
    (guide)                                     \
    (hidden)                                    \
    (proxy)                                     \
    (render)

#define HD_RENDER_CONTEXT_TOKENS                \
    ((universal, ""))

#define HD_OPTION_TOKENS                        \
    (parallelRprimSync)

#define HD_RPRIMTYPE_TOKENS                     \
    /* Rprims */                                \
    (capsule)                                   \
    (cone)                                      \
    (cube)                                      \
    (cylinder)                                  \
    (geomSubset)                                \
    (mesh)                                      \
    (tetMesh)                                   \
    (nurbsPatch)                                \
    (basisCurves)                               \
    (nurbsCurves)                               \
    (particleField)                             \
    (plane)                                     \
    (points)                                    \
    (sphere)                                    \
    (volume)                                    \
    (model)

// XXX Unfortunately, we export a function of the name HdLightPrimTypeTokens.
//     Omit 'Prim' from the name.
#define HD_LIGHT_TYPE_TOKENS                    \
    (cylinderLight)                             \
    (diskLight)                                 \
    (distantLight)                              \
    (domeLight)                                 \
    (light)                                     \
    (meshLight)                                 \
    (pluginLight)                               \
    (rectLight)                                 \
    (simpleLight)                               \
    (sphereLight)

#define HD_LIGHT_FILTER_TYPE_TOKENS             \
    (lightFilter)

#define HD_SPRIMTYPE_TOKENS                     \
    /* Sprims */                                \
    (camera)                                    \
    (drawTarget)                                \
    (material)                                  \
    (coordSys)                                  \
    (instancer)                                 \
    (instance)                                  \
    (integrator)                                \
    (sampleFilter)                              \
    (displayFilter)                             \
    (imageShader)                               \
                                                \
    HD_LIGHT_TYPE_TOKENS                        \
    HD_LIGHT_FILTER_TYPE_TOKENS                 \
                                                \
    /* Sprims ExtComputations */                \
    (extComputation)                            \

#define HD_BPRIMTYPE_TOKENS                     \
    /* Bprims */                                \
    (renderBuffer)                              \
    (renderSettings)

#define HD_PRIMTYPE_TOKENS                      \
    HD_RPRIMTYPE_TOKENS                         \
    HD_SPRIMTYPE_TOKENS                         \
    HD_BPRIMTYPE_TOKENS                         \
    /* Scene-index-only prim types */           \
    (renderPass)                                \
    (task)

HD_API
bool HdPrimTypeIsGprim(TfToken const& primType);

HD_API
bool HdPrimTypeIsLight(TfToken const& primType);

HD_API
bool HdPrimTypeSupportsGeomSubsets(const TfToken& primType);

HD_API
const TfTokenVector &HdLightPrimTypeTokens();

#define HD_PRIMVAR_ROLE_TOKENS                  \
    ((none, ""))                                \
    (color)                                     \
    (vector)                                    \
    (normal)                                    \
    (point)                                     \
    (textureCoordinate)

/* Schema for "Alternate Output Values" rendering,
 * describing which values a renderpass should
 * compute and write at render time.
 */
#define HD_AOV_TOKENS                           \
    /* Standard rendering outputs */            \
                                                \
    /* HdAovTokens->color represents the final
     * fragment RGBA color. For correct compositing
     * using Hydra, it should have pre-multiplied alpha.
     */                                         \
    (color)                                     \
    /* HdAovTokens->depth represents the clip-space
     * depth of the final fragment.
     */                                         \
    (depth)                                     \
    /* HdAovTokens->depthStencil represents the clip-space
     * depth of the final fragment w/ 8-bit stencil.
     */                                         \
    (depthStencil)                              \
    /* HdAovTokens->cameraDepth represents the camera-space
     * depth of the final fragment.
     */                                         \
    (cameraDepth)                               \
    /* ID rendering - these tokens represent the
     * prim, instance, and subprim ids of the final
     * fragment.
     */                                         \
    (primId)                                    \
    (instanceId)                                \
    (elementId)                                 \
    (edgeId)                                    \
    (pointId)                                   \
    /* Geometric data */                        \
    (Peye)                                      \
    (Neye)                                      \
    (patchCoord)                                \
    (primitiveParam)                            \
    (normal)                                    \
    /* Others we might want to add:
     * https://rmanwiki.pixar.com/display/REN/Arbitrary+Output+Variables
     * - curvature
     * - tangent
     * - velocity
     */                                         \
    /* Primvars:
     *   The tokens don't try to enumerate primvars,
     *   but instead provide an identifying namespace.
     *   The "color" primvar is addressable as "primvars:color".
     */                                         \
    ((primvars, "primvars:"))                   \
    /* Light path expressions:
     *   Applicable only to raytracers, these tell
     *   the renderer to output specific shading
     *   components for specific classes of lightpath.
     *
     *   Lightpath syntax is defined here:
     *   https://rmanwiki.pixar.com/display/REN/Light+Path+Expressions
     *   ... so for example, you could specify
     *   "lpe:CD[<L.>O]"
     */                                         \
    ((lpe, "lpe:"))                             \
    /* Shader signals:
     *   This tells the renderer to output a partial shading signal,
     *   whether from the BXDF (e.g. bxdf.diffuse) or from an intermediate
     *   shading node (e.g. fractal.rgb).
     *   XXX: The exact format is TBD.
     */                                         \
    ((shader, "shader:"))

HD_API
TfToken HdAovTokensMakePrimvar(TfToken const& primvar);

HD_API
TfToken HdAovTokensMakeLpe(TfToken const& lpe);

HD_API
TfToken HdAovTokensMakeShader(TfToken const& shader);

/* Schema for application-configurable render settings. */
#define HD_RENDER_SETTINGS_TOKENS                     \
    /* General graphical options */                   \
    (enableShadows)                                   \
    (enableSceneMaterials)                            \
    (enableSceneLights)                               \
    (enableExposureCompensation)                      \
    (domeLightCameraVisibility)                       \
    /* Raytracer sampling settings */                 \
    (convergedVariance)                               \
    (convergedSamplesPerPixel)                        \
    /* thread limit settings */                       \
    (threadLimit)                                     \
    /* interactive vs offline */                      \
    (enableInteractive)                               \
    /* To pass HdRendererCreateArgs to HdRendererPlugin::CreateDelegate */ \
    (rendererCreateArgs)

#define HD_RENDER_SETTINGS_PRIM_TOKENS                \
    (active)                                          \
    (namespacedSettings)                              \
    (renderProducts)                                  \
    (includedPurposes)                                \
    (materialBindingPurposes)                         \
    (renderingColorSpace)                             \
    (unionedSamplingInterval)                         \
    (camera)                                          \
    (disableDepthOfField)                             \
    (disableMotionBlur)

/* Aspect Ratio Conform Policy Tokens used on render settings prims
 * Note that these mirror the conform policy tokens in UsdRenderTokens */
#define HD_ASPECT_RATIO_CONFORM_POLICY                \
    (adjustApertureWidth)                             \
    (adjustApertureHeight)                            \
    (expandAperture)                                  \
    (cropAperture)                                    \
    (adjustPixelAspectRatio)                          \

#define HD_RESOURCE_TYPE_TOKENS                       \
    (texture)                                         \
    (shaderFile)

#define HD_SCENE_INDEX_EMULATION_TOKENS               \
    (sceneDelegate)                                   \

/* Tokens used to emulate collections for light linking. The collection names
   match the UsdLuxLightAPI. Hydra 1.0 uses lightFilterLink instead of
   filterLink.
*/
#define HD_COLLECTION_EMULATION_TOKENS                \
    ((lightLinkCollection,  "lightLink"))             \
    ((shadowLinkCollection, "shadowLink"))            \
    ((filterLinkCollection, "filterLink"))            \
    (lightLinkCollectionMembershipExpression)         \
    (shadowLinkCollectionMembershipExpression)        \
    (filterLinkCollectionMembershipExpression)

/* Inputs required for UsdSkel skinning. */
#define HD_SKINNING_INPUT_TOKENS                                        \
    ((skinningXforms,            "hydra:skinningXforms"))               \
    ((skinningDualQuats,         "hydra:skinningDualQuats"))            \
    ((skinningScaleXforms,       "hydra:skinningScaleXforms"))          \
    ((blendShapeWeights,         "hydra:blendShapeWeights"))            \
    ((skelLocalToCommonSpace,    "hydra:skelLocalToWorld"))             \
    ((commonSpaceToPrimLocal,    "hydra:primWorldToLocal"))             \
    ((blendShapeOffsets,         "hydra:blendShapeOffsets"))            \
    ((blendShapeOffsetRanges,    "hydra:blendShapeOffsetRanges"))       \
    ((numBlendShapeOffsetRanges, "hydra:numBlendShapeOffsetRanges"))    \
                                                                        \
    ((hasConstantInfluences,     "hydra:hasConstantInfluences"))        \
    ((numInfluencesPerComponent, "hydra:numInfluencesPerComponent"))    \
    ((influences,                "hydra:influences"))                   \
    /* skinningMethod primvar on the skel schema is a token, we provide a
     * numeric alternative to pass to storm's vertex shader.
     */                                                                 \
    ((numSkinningMethod,         "hydra:numSkinningMethod"))            \
    /* Extra primvars for computing instance/vertex offsets to index into
     * concatenated skinningXForms/blendShapeWeights constant primvars.
     */                                                                 \
    ((numJoints,                 "hydra:numJoints"))                    \
    ((numBlendShapeWeights,      "hydra:numBlendShapeWeights"))

/* Skinning inputs that already exist on skel binding. */
#define HD_SKINNING_SKEL_INPUT_TOKENS                                   \
    /* HYD-3510
     * these two already exist and they are the source of influences and
     * numInfluencesPerComponent above. but currently hydra doesn't handle
     * tensor valued vertex primvar correctly. once that's addressed, we
     * can access these two in the vertex shader directly and remove the
     * two above. see imaging/hdSt/mesh.cpp _PopulateVertexPrimvars()#1417
     * buffer source array size is currently hardcoded to 1.
     *
     *((jointIndices,            "skel:jointIndices"))
     *((jointWeights,            "skel:jointWeights"))
     */                                                                 \
    ((geomBindTransform,         "skel:geomBindTransform"))


TF_DECLARE_PUBLIC_TOKENS(HdTokens, HD_API, HD_TOKENS);
TF_DECLARE_PUBLIC_TOKENS(HdInstancerTokens, HD_API, HD_INSTANCER_TOKENS);
TF_DECLARE_PUBLIC_TOKENS(HdReprTokens, HD_API, HD_REPR_TOKENS);
TF_DECLARE_PUBLIC_TOKENS(HdCullStyleTokens, HD_API, HD_CULLSTYLE_TOKENS);
TF_DECLARE_PUBLIC_TOKENS(HdModelDrawModeTokens, HD_API,
                         HD_MODEL_DRAWMODE_TOKENS);
TF_DECLARE_PUBLIC_TOKENS(HdPerfTokens, HD_API, HD_PERF_TOKENS);
TF_DECLARE_PUBLIC_TOKENS(HdShaderTokens, HD_API, HD_SHADER_TOKENS);
TF_DECLARE_PUBLIC_TOKENS(HdMaterialTagTokens, HD_API, HD_MATERIALTAG_TOKENS);
TF_DECLARE_PUBLIC_TOKENS(HdMaterialTerminalTokens, HD_API,
                         HD_MATERIAL_TERMINAL_TOKENS);
TF_DECLARE_PUBLIC_TOKENS(HdRenderTagTokens, HD_API, HD_RENDERTAG_TOKENS);
TF_DECLARE_PUBLIC_TOKENS(HdRenderContextTokens, HD_API, HD_RENDER_CONTEXT_TOKENS);
TF_DECLARE_PUBLIC_TOKENS(HdOptionTokens, HD_API, HD_OPTION_TOKENS);
TF_DECLARE_PUBLIC_TOKENS(HdLightTypeTokens, HD_API, HD_LIGHT_TYPE_TOKENS);
TF_DECLARE_PUBLIC_TOKENS(HdLightFilterTypeTokens, HD_API,
                         HD_LIGHT_FILTER_TYPE_TOKENS);
TF_DECLARE_PUBLIC_TOKENS(HdRprimTypeTokens, HD_API, HD_RPRIMTYPE_TOKENS);
TF_DECLARE_PUBLIC_TOKENS(HdSprimTypeTokens, HD_API, HD_SPRIMTYPE_TOKENS);
TF_DECLARE_PUBLIC_TOKENS(HdBprimTypeTokens, HD_API, HD_BPRIMTYPE_TOKENS);
TF_DECLARE_PUBLIC_TOKENS(HdPrimTypeTokens, HD_API, HD_PRIMTYPE_TOKENS);
TF_DECLARE_PUBLIC_TOKENS(HdPrimvarRoleTokens, HD_API, HD_PRIMVAR_ROLE_TOKENS);
TF_DECLARE_PUBLIC_TOKENS(HdAovTokens, HD_API, HD_AOV_TOKENS);
TF_DECLARE_PUBLIC_TOKENS(HdRenderSettingsTokens, HD_API, HD_RENDER_SETTINGS_TOKENS);
TF_DECLARE_PUBLIC_TOKENS(HdRenderSettingsPrimTokens, HD_API,
                         HD_RENDER_SETTINGS_PRIM_TOKENS);
TF_DECLARE_PUBLIC_TOKENS(HdAspectRatioConformPolicyTokens, HD_API,
                         HD_ASPECT_RATIO_CONFORM_POLICY);
TF_DECLARE_PUBLIC_TOKENS(HdResourceTypeTokens, HD_API, HD_RESOURCE_TYPE_TOKENS);
TF_DECLARE_PUBLIC_TOKENS(HdSceneIndexEmulationTokens, HD_API,
                         HD_SCENE_INDEX_EMULATION_TOKENS);
TF_DECLARE_PUBLIC_TOKENS(HdCollectionEmulationTokens, HD_API,
                         HD_COLLECTION_EMULATION_TOKENS);
TF_DECLARE_PUBLIC_TOKENS(HdSkinningInputTokens, HD_API,
                         HD_SKINNING_INPUT_TOKENS);
TF_DECLARE_PUBLIC_TOKENS(HdSkinningSkelInputTokens, HD_API,
                         HD_SKINNING_SKEL_INPUT_TOKENS);

PXR_NAMESPACE_CLOSE_SCOPE

#endif //PXR_IMAGING_HD_TOKENS_H