Descriptor to configure the drawItem(s) for a repr. More...

#include <mesh.h>

Public Member Functions
	HdMeshReprDesc (HdMeshGeomStyle geomStyle=HdMeshGeomStyleInvalid, HdCullStyle cullStyle=HdCullStyleDontCare, TfToken shadingTerminal=HdMeshReprDescTokens->surfaceShader, bool flatShadingEnabled=false, bool blendWireframeColor=true, bool forceOpaqueEdges=true, bool surfaceEdgeIds=false, bool doubleSided=false, float lineWidth=0, bool useCustomDisplacement=true, bool enableScalarOverride=true)

bool	IsEmpty () const

Public Attributes
HdMeshGeomStyle	geomStyle
	The rendering style: draw refined/unrefined, edge, points, etc.

HdCullStyle	cullStyle
	The culling style: draw front faces, back faces, etc.

TfToken	shadingTerminal
	Specifies how the fragment color should be computed from surfaceShader; this can be used to render a mesh lit, unlit, unshaded, etc.

bool	flatShadingEnabled
	Does this mesh want flat shading?

bool	blendWireframeColor
	Should the wireframe color be blended into the color primvar?

bool	forceOpaqueEdges
	If the geom style includes edges, should those edges be forced to be fully opaque, ignoring any applicable opacity inputs.

bool	surfaceEdgeIds
	Generate edge ids for surface and hull geom styles that do not otherwise render edges, e.g.

bool	doubleSided
	Should this mesh be treated as double-sided? The resolved value is (prim.doubleSided \|\| repr.doubleSided).

float	lineWidth
	How big (in pixels) should line drawing be?

bool	useCustomDisplacement
	Should this mesh use displacementShader() to displace points?

bool	enableScalarOverride
	Should scalar override be allowed on this drawItem.

Detailed Description

Descriptor to configure the drawItem(s) for a repr.

Definition at line 37 of file mesh.h.

Constructor & Destructor Documentation

◆ HdMeshReprDesc()

HdMeshReprDesc	(	HdMeshGeomStyle	geomStyle = `HdMeshGeomStyleInvalid`,
		HdCullStyle	cullStyle = `HdCullStyleDontCare`,
		TfToken	shadingTerminal = `HdMeshReprDescTokens->surfaceShader`,
		bool	flatShadingEnabled = `false`,
		bool	blendWireframeColor = `true`,
		bool	forceOpaqueEdges = `true`,
		bool	surfaceEdgeIds = `false`,
		bool	doubleSided = `false`,
		float	lineWidth = `0`,
		bool	useCustomDisplacement = `true`,
		bool	enableScalarOverride = `true`
	)

inline

Definition at line 39 of file mesh.h.

Member Function Documentation

◆ IsEmpty()

bool IsEmpty ( ) const

inline

Definition at line 63 of file mesh.h.

Member Data Documentation

◆ blendWireframeColor

bool blendWireframeColor

Should the wireframe color be blended into the color primvar?

Definition at line 77 of file mesh.h.

◆ cullStyle

HdCullStyle cullStyle

The culling style: draw front faces, back faces, etc.

Definition at line 70 of file mesh.h.

◆ doubleSided

bool doubleSided

Should this mesh be treated as double-sided? The resolved value is (prim.doubleSided || repr.doubleSided).

Definition at line 88 of file mesh.h.

◆ enableScalarOverride

bool enableScalarOverride

Should scalar override be allowed on this drawItem.

scalar override allows for visualization of a single float value across a prim.

Definition at line 96 of file mesh.h.

◆ flatShadingEnabled

bool flatShadingEnabled

Does this mesh want flat shading?

Definition at line 75 of file mesh.h.

◆ forceOpaqueEdges

bool forceOpaqueEdges

If the geom style includes edges, should those edges be forced to be fully opaque, ignoring any applicable opacity inputs.

Does not apply to patch edges.

Definition at line 81 of file mesh.h.

◆ geomStyle

HdMeshGeomStyle geomStyle

The rendering style: draw refined/unrefined, edge, points, etc.

Definition at line 68 of file mesh.h.

◆ lineWidth

float lineWidth

How big (in pixels) should line drawing be?

Definition at line 90 of file mesh.h.

◆ shadingTerminal

TfToken shadingTerminal

Specifies how the fragment color should be computed from surfaceShader; this can be used to render a mesh lit, unlit, unshaded, etc.

Definition at line 73 of file mesh.h.

◆ surfaceEdgeIds

bool surfaceEdgeIds

Generate edge ids for surface and hull geom styles that do not otherwise render edges, e.g.

to support picking and highlighting of edges with these mesh geom styles.

Definition at line 85 of file mesh.h.

◆ useCustomDisplacement

bool useCustomDisplacement

Should this mesh use displacementShader() to displace points?

Definition at line 92 of file mesh.h.

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

pxr/imaging/hd/mesh.h

Public Member Functions

Public Attributes