HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HdStRenderParam Class Referencefinal

#include <renderParam.h>

+ Inheritance diagram for HdStRenderParam:

Public Member Functions

 HdStRenderParam ()
 
 ~HdStRenderParam () override
 
HDST_API void MarkDrawBatchesDirty ()
 Draw items cache and batch invalidation. More...
 
HDST_API unsigned int GetDrawBatchesVersion () const
 
HDST_API void MarkMaterialTagsDirty ()
 
HDST_API unsigned int GetMaterialTagsVersion () const
 
void SetGarbageCollectionNeeded ()
 Garbage collection tracking. More...
 
void ClearGarbageCollectionNeeded ()
 
bool IsGarbageCollectionNeeded () const
 
- Public Member Functions inherited from HdRenderParam
 HdRenderParam ()
 
virtual HD_API ~HdRenderParam ()
 

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 42 of file renderParam.h.

Constructor & Destructor Documentation

HdStRenderParam::HdStRenderParam ( )
HdStRenderParam::~HdStRenderParam ( )
override

Member Function Documentation

void HdStRenderParam::ClearGarbageCollectionNeeded ( )
inline

Definition at line 74 of file renderParam.h.

HDST_API unsigned int HdStRenderParam::GetDrawBatchesVersion ( ) const
HDST_API unsigned int HdStRenderParam::GetMaterialTagsVersion ( ) const
bool HdStRenderParam::IsGarbageCollectionNeeded ( ) const
inline

Definition at line 78 of file renderParam.h.

HDST_API void HdStRenderParam::MarkDrawBatchesDirty ( )

Draw items cache and batch invalidation.

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

HDST_API void HdStRenderParam::MarkMaterialTagsDirty ( )

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

void HdStRenderParam::SetGarbageCollectionNeeded ( )
inline

Garbage collection tracking.

Definition at line 70 of file renderParam.h.


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