HdStRenderParam Class Reference

The render delegate can create an object of type HdRenderParam, to pass to each prim during Sync(). More...

#include <renderParam.h>

Inheritance diagram for HdStRenderParam:

Public Member Functions
HDST_API void	MarkDrawBatchesDirty ()
	Draw items cache and batch invalidation.
HDST_API unsigned int	GetDrawBatchesVersion () const
HDST_API void	MarkMaterialTagsDirty ()
	Marks material tags dirty, meaning that the draw items associated with the collection of a render pass need to be re-gathered.
HDST_API unsigned int	GetMaterialTagsVersion () const
HDST_API void	MarkGeomSubsetDrawItemsDirty ()
	Marks geom subsets draw items dirty, meaning that the draw items associated with the collection of a render pass need to be re-gathered.
HDST_API unsigned int	GetGeomSubsetDrawItemsVersion () const
HDST_API bool	HasMaterialTag (const TfToken &materialTag) const
	Material tag tracking.
HDST_API void	IncreaseMaterialTagCount (const TfToken &materialTag)
	Register that there is an rprim with given materialTag.
HDST_API void	DecreaseMaterialTagCount (const TfToken &materialTag)
	Unregister that there is an rprim with given materialTag.
HDST_API bool	HasAnyRenderTag (const TfTokenVector &renderTags) const
	Render tag tracking.
HDST_API void	IncreaseRenderTagCount (const TfToken &renderTag)
	Register that there is an rprim with given renderTag.
HDST_API void	DecreaseRenderTagCount (const TfToken &renderTag)
	Unregister that there is an rprim with given renderTag.
HDST_API void	MarkActiveDrawTargetSetDirty ()
	Draw targets.
HDST_API unsigned int	GetActiveDrawTargetSetVersion () const
void	SetGarbageCollectionNeeded ()
	Garbage collection tracking.
void	ClearGarbageCollectionNeeded ()
bool	IsGarbageCollectionNeeded () const
Public Member Functions inherited from HdRenderParam
virtual HD_API bool	SetArbitraryValue (const TfToken &key, const VtValue &value)
	Set a custom value in the render param's implementation.
virtual HD_API VtValue	GetArbitraryValue (const TfToken &key) const
	Retrieve a custom value identified by key from the render param's implementation.
virtual HD_API bool	HasArbitraryValue (const TfToken &key) const
	Check whether a valid custom value exists for the specified key in the render param's implementation.
virtual HD_API bool	IsValid () const

Detailed Description

The render delegate can create an object of type HdRenderParam, to pass to each prim during Sync().

Storm uses this class to house global counters amd flags that assist invalidation of draw batch caches.

Definition at line 26 of file renderParam.h.

Member Function Documentation

ClearGarbageCollectionNeeded()

void ClearGarbageCollectionNeeded ( )

inline

Definition at line 113 of file renderParam.h.

DecreaseMaterialTagCount()

HDST_API void DecreaseMaterialTagCount

(

const TfToken &

materialTag

)

Unregister that there is an rprim with given materialTag.

DecreaseRenderTagCount()

HDST_API void DecreaseRenderTagCount

(

const TfToken &

renderTag

)

Unregister that there is an rprim with given renderTag.

HasAnyRenderTag()

HDST_API bool HasAnyRenderTag

(

const TfTokenVector &

renderTags

)

const

Render tag tracking.

Does render index have rprims with given renderTag?

HasMaterialTag()

HDST_API bool HasMaterialTag

(

const TfToken &

materialTag

)

const

Material tag tracking.

Does render index have rprims with given materialTag? Note that for performance reasons and ease of implementation (HdRprimSharedData::materialTag initializes to the default material tag), this always returns true for the default (and empty) material tag.

IncreaseMaterialTagCount()

HDST_API void IncreaseMaterialTagCount

(

const TfToken &

materialTag

)

Register that there is an rprim with given materialTag.

IncreaseRenderTagCount()

HDST_API void IncreaseRenderTagCount

(

const TfToken &

renderTag

)

Register that there is an rprim with given renderTag.

IsGarbageCollectionNeeded()

bool IsGarbageCollectionNeeded ( ) const

inline

Definition at line 117 of file renderParam.h.

MarkActiveDrawTargetSetDirty()

HDST_API void MarkActiveDrawTargetSetDirty

(

)

Draw targets.

Marks all draw targets dirty, meaning that clients that keep track of the set of active draw targets needs to refresh that set.

MarkDrawBatchesDirty()

HDST_API void MarkDrawBatchesDirty

(

)

Draw items cache and batch invalidation.

Marks all batches dirty, meaning they need to be validated and potentially rebuilt.

MarkGeomSubsetDrawItemsDirty()

HDST_API void MarkGeomSubsetDrawItemsDirty

(

)

Marks geom subsets draw items dirty, meaning that the draw items associated with the collection of a render pass need to be re-gathered.

MarkMaterialTagsDirty()

HDST_API void MarkMaterialTagsDirty

(

)

Marks material tags dirty, meaning that the draw items associated with the collection of a render pass need to be re-gathered.

SetGarbageCollectionNeeded()

void SetGarbageCollectionNeeded ( )

inline

Garbage collection tracking.

Definition at line 109 of file renderParam.h.

---

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

• pxr/imaging/hdSt/renderParam.h