HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
enums.h File Reference
#include "pxr/pxr.h"
#include "pxr/imaging/hd/api.h"
+ Include dependency graph for enums.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Enumerations

enum  HdCompareFunction {
  HdCmpFuncNever, HdCmpFuncLess, HdCmpFuncEqual, HdCmpFuncLEqual,
  HdCmpFuncGreater, HdCmpFuncNotEqual, HdCmpFuncGEqual, HdCmpFuncAlways,
  HdCmpFuncLast
}
 
enum  HdStencilOp {
  HdStencilOpKeep, HdStencilOpZero, HdStencilOpReplace, HdStencilOpIncrement,
  HdStencilOpIncrementWrap, HdStencilOpDecrement, HdStencilOpDecrementWrap, HdStencilOpInvert,
  HdStencilOpLast
}
 
enum  HdBlendOp {
  HdBlendOpAdd, HdBlendOpSubtract, HdBlendOpReverseSubtract, HdBlendOpMin,
  HdBlendOpMax, HdBlendOpLast
}
 
enum  HdBlendFactor {
  HdBlendFactorZero, HdBlendFactorOne, HdBlendFactorSrcColor, HdBlendFactorOneMinusSrcColor,
  HdBlendFactorDstColor, HdBlendFactorOneMinusDstColor, HdBlendFactorSrcAlpha, HdBlendFactorOneMinusSrcAlpha,
  HdBlendFactorDstAlpha, HdBlendFactorOneMinusDstAlpha, HdBlendFactorConstantColor, HdBlendFactorOneMinusConstantColor,
  HdBlendFactorConstantAlpha, HdBlendFactorOneMinusConstantAlpha, HdBlendFactorSrcAlphaSaturate, HdBlendFactorSrc1Color,
  HdBlendFactorOneMinusSrc1Color, HdBlendFactorSrc1Alpha, HdBlendFactorOneMinusSrc1Alpha, HdBlendFactorLast
}
 
enum  HdCullStyle {
  HdCullStyleDontCare, HdCullStyleNothing, HdCullStyleBack, HdCullStyleFront,
  HdCullStyleBackUnlessDoubleSided, HdCullStyleFrontUnlessDoubleSided
}
 
enum  HdPolygonMode { HdPolygonModeFill, HdPolygonModeLine }
 
enum  HdMeshGeomStyle {
  HdMeshGeomStyleInvalid, HdMeshGeomStyleSurf, HdMeshGeomStyleEdgeOnly, HdMeshGeomStyleEdgeOnSurf,
  HdMeshGeomStyleHull, HdMeshGeomStyleHullEdgeOnly, HdMeshGeomStyleHullEdgeOnSurf, HdMeshGeomStylePoints
}
 
enum  HdBasisCurvesGeomStyle { HdBasisCurvesGeomStyleInvalid, HdBasisCurvesGeomStyleWire, HdBasisCurvesGeomStylePatch, HdBasisCurvesGeomStylePoints }
 
enum  HdPointsGeomStyle { HdPointsGeomStyleInvalid, HdPointsGeomStylePoints }
 
enum  HdWrap {
  HdWrapClamp, HdWrapRepeat, HdWrapBlack, HdWrapMirror,
  HdWrapUseMetadata, HdWrapLegacy
}
 
enum  HdMinFilter {
  HdMinFilterNearest, HdMinFilterLinear, HdMinFilterNearestMipmapNearest, HdMinFilterLinearMipmapNearest,
  HdMinFilterNearestMipmapLinear, HdMinFilterLinearMipmapLinear
}
 
enum  HdMagFilter { HdMagFilterNearest, HdMagFilterLinear }
 
enum  HdInterpolation {
  HdInterpolationConstant = 0, HdInterpolationUniform, HdInterpolationVarying, HdInterpolationVertex,
  HdInterpolationFaceVarying, HdInterpolationInstance, HdInterpolationCount
}
 
enum  HdTextureType { HdTextureType::Uv, HdTextureType::Uvw, HdTextureType::Ptex, HdTextureType::Udim }
 
enum  HdDepthPriority { HdDepthPriorityNearest = 0, HdDepthPriorityFarthest, HdDepthPriorityCount }
 

Functions

HD_API HdCullStyle HdInvertCullStyle (HdCullStyle cs)
 

Enumeration Type Documentation

Enumerator
HdBasisCurvesGeomStyleInvalid 
HdBasisCurvesGeomStyleWire 
HdBasisCurvesGeomStylePatch 
HdBasisCurvesGeomStylePoints 

Definition at line 158 of file enums.h.

Abstraction of the Graphics blend factors.

Enumerator
HdBlendFactorZero 
HdBlendFactorOne 
HdBlendFactorSrcColor 
HdBlendFactorOneMinusSrcColor 
HdBlendFactorDstColor 
HdBlendFactorOneMinusDstColor 
HdBlendFactorSrcAlpha 
HdBlendFactorOneMinusSrcAlpha 
HdBlendFactorDstAlpha 
HdBlendFactorOneMinusDstAlpha 
HdBlendFactorConstantColor 
HdBlendFactorOneMinusConstantColor 
HdBlendFactorConstantAlpha 
HdBlendFactorOneMinusConstantAlpha 
HdBlendFactorSrcAlphaSaturate 
HdBlendFactorSrc1Color 
HdBlendFactorOneMinusSrc1Color 
HdBlendFactorSrc1Alpha 
HdBlendFactorOneMinusSrc1Alpha 
HdBlendFactorLast 

Definition at line 87 of file enums.h.

enum HdBlendOp

Abstraction of the Graphics blend operations.

Enumerator
HdBlendOpAdd 
HdBlendOpSubtract 
HdBlendOpReverseSubtract 
HdBlendOpMin 
HdBlendOpMax 
HdBlendOpLast 

Definition at line 72 of file enums.h.

Abstraction of the Graphics compare functions.

Enumerator
HdCmpFuncNever 
HdCmpFuncLess 
HdCmpFuncEqual 
HdCmpFuncLEqual 
HdCmpFuncGreater 
HdCmpFuncNotEqual 
HdCmpFuncGEqual 
HdCmpFuncAlways 
HdCmpFuncLast 

Definition at line 36 of file enums.h.

Face culling options.

DontCare indicates this prim doesn't determine what should be culled. Any other CullStyle opinion will override this (such as from the viewer).

BackUnlessDoubleSided and FrontUnlessDoubleSided will only cull back or front faces if prim isn't marked as doubleSided.

Enumerator
HdCullStyleDontCare 
HdCullStyleNothing 
HdCullStyleBack 
HdCullStyleFront 
HdCullStyleBackUnlessDoubleSided 
HdCullStyleFrontUnlessDoubleSided 

Definition at line 122 of file enums.h.

Sets the priorities for a depth based operation

  • HdDepthPriorityNearest Prioritize objects nearest to the camera
  • HdDepthPriorityFarthest Prioritize objects farthest from the camera
Enumerator
HdDepthPriorityNearest 
HdDepthPriorityFarthest 
HdDepthPriorityCount 

Definition at line 297 of file enums.h.

Enumerates Hydra's primvar interpolation modes.

Constant: One value remains constant over the entire surface primitive.

Uniform: One value remains constant for each uv patch segment of the surface primitive.

Varying: Four values are interpolated over each uv patch segment of the surface. Bilinear interpolation is used for interpolation between the four values.

Vertex: Values are interpolated between each vertex in the surface primitive. The basis function of the surface is used for interpolation between vertices.

Facevarying: For polygons and subdivision surfaces, four values are interpolated over each face of the mesh. Bilinear interpolation is used for interpolation between the four values.

Instance: One value remains constant across each instance.

Enumerator
HdInterpolationConstant 
HdInterpolationUniform 
HdInterpolationVarying 
HdInterpolationVertex 
HdInterpolationFaceVarying 
HdInterpolationInstance 
HdInterpolationCount 

Definition at line 255 of file enums.h.

Enumerates magFilter attribute type values.

  • HdFilterNearest Nearest to center of the pixel
  • HdFilterLinear Weighted average of the four texture elements closest to the pixel
Enumerator
HdMagFilterNearest 
HdMagFilterLinear 

Definition at line 225 of file enums.h.

Hydra native geom styles.

Enumerator
HdMeshGeomStyleInvalid 
HdMeshGeomStyleSurf 
HdMeshGeomStyleEdgeOnly 
HdMeshGeomStyleEdgeOnSurf 
HdMeshGeomStyleHull 
HdMeshGeomStyleHullEdgeOnly 
HdMeshGeomStyleHullEdgeOnSurf 
HdMeshGeomStylePoints 

Definition at line 147 of file enums.h.

Enumerates minFilter attribute type values.

  • HdMinFilterNearest Nearest to center of the pixel
  • HdMinFilterLinear Weighted average od the four texture elements closest to the pixel
  • HdMinFilterNearestMipmapNearest Nearest to center of the pixel from the nearest mipmaps
  • HdMinFilterLinearMipmapNeares Weighted average using texture elements from the nearest mipmaps
  • HdMinFilterNearestMipmapLinear Weighted average of the nearest pixels from the two nearest mipmaps
  • HdMinFilterLinearMipmapLinear WeightedAverage of the weighted averages from the nearest mipmaps
Enumerator
HdMinFilterNearest 
HdMinFilterLinear 
HdMinFilterNearestMipmapNearest 
HdMinFilterLinearMipmapNearest 
HdMinFilterNearestMipmapLinear 
HdMinFilterLinearMipmapLinear 

Definition at line 206 of file enums.h.

Enumerator
HdPointsGeomStyleInvalid 
HdPointsGeomStylePoints 

Definition at line 165 of file enums.h.

Enumerator
HdPolygonModeFill 
HdPolygonModeLine 

Definition at line 137 of file enums.h.

Abstraction of the Graphics stencil test operations.

Enumerator
HdStencilOpKeep 
HdStencilOpZero 
HdStencilOpReplace 
HdStencilOpIncrement 
HdStencilOpIncrementWrap 
HdStencilOpDecrement 
HdStencilOpDecrementWrap 
HdStencilOpInvert 
HdStencilOpLast 

Definition at line 54 of file enums.h.

enum HdTextureType
strong

Enumerates Hydra's supported texture types.

Uv: Sample the uv coordinates and accesses a single 2d texture.

Uvw: Sample the uvw coordinates and accesses a single 3d texture.

Ptex: Use the ptex connectivity information to sample a ptex texture.

Udim: Remap the uv coordinates into udim coordinates using a maximum tile width of 10 and sample all the udim tiles found in the file system.

Enumerator
Uv 
Uvw 
Ptex 
Udim 

Definition at line 281 of file enums.h.

enum HdWrap

Enumerates wrapping attributes type values.

  • HdWrapClamp Clamp coordinate to range [1/(2N),1-1/(2N)] where N is the size of the texture in the direction of clamping
  • HdWrapRepeat Creates a repeating pattern
  • HdWrapBlack Clamp coordinate to range [-1/(2N),1+1/(2N)] where N is the size of the texture in the direction of clamping
  • HdWrapMirror Creates a mirrored repeating pattern.
  • HdWrapUseMetadata Data Texture can define its own wrap mode, if not defined by the texture it will use HdWrapBlack
  • HdWrapLegacy (deprecated) Texture can define its own wrap mode, if not defined by the texture it will use HdWrapRepeat
Enumerator
HdWrapClamp 
HdWrapRepeat 
HdWrapBlack 
HdWrapMirror 
HdWrapUseMetadata 
HdWrapLegacy 

Definition at line 183 of file enums.h.

Function Documentation

HD_API HdCullStyle HdInvertCullStyle ( HdCullStyle  cs)

Returns the opposite of the given cullstyle; backface culling becomes frontface and vice versa.