Loading...
Searching...
No Matches
HdStDrawTarget Class Reference

Represents an render to texture render pass. More...

#include <drawTarget.h>

+ Inheritance diagram for HdStDrawTarget:

Public Types

enum  DirtyBits : HdDirtyBits {
  Clean = 0 , DirtyDTEnable = 1 << 0 , DirtyDTCamera = 1 << 1 , DirtyDTResolution = 1 << 2 ,
  DirtyDTAovBindings = 1 << 4 , DirtyDTDepthPriority = 1 << 6 , DirtyDTCollection = 1 << 7 , AllDirty
}
 Dirty bits for the HdStDrawTarget object. More...
 

Public Member Functions

HDST_API HdStDrawTarget (SdfPath const &id)
 
HDST_API void Sync (HdSceneDelegate *sceneDelegate, HdRenderParam *renderParam, HdDirtyBits *dirtyBits) override
 Synchronizes state from the delegate to this object.
 
HDST_API HdDirtyBits GetInitialDirtyBitsMask () const override
 Returns the minimal set of dirty bits to place in the change tracker for use in the first sync of this prim.
 
- Public Member Functions inherited from HdSprim
HD_API HdSprim (SdfPath const &id)
 
SdfPath const & GetId () const
 Returns the identifier by which this state is known.
 
virtual void Sync (HdSceneDelegate *sceneDelegate, HdRenderParam *renderParam, HdDirtyBits *dirtyBits)=0
 Synchronizes state from the delegate to this object.
 
virtual HD_API void Finalize (HdRenderParam *renderParam)
 Finalizes object resources.
 
virtual HdDirtyBits GetInitialDirtyBitsMask () const =0
 Returns the minimal set of dirty bits to place in the change tracker for use in the first sync of this prim.
 

Draw Target API

bool IsEnabled () const
 
const HdStDrawTargetRenderPassStateGetDrawTargetRenderPassState () const
 
HDST_API HdRprimCollection const & GetCollection () const
 Returns collection of rprims the draw target draws.
 
const GfVec2iGetResolution () const
 Resolution.
 
static HDST_API void GetDrawTargets (HdRenderIndex *renderIndex, HdStDrawTargetPtrVector *drawTargets)
 returns all HdStDrawTargets in the render index
 

Detailed Description

Represents an render to texture render pass.

Note
This is a temporary API to aid transition to Storm, and is subject to major changes.

Definition at line 64 of file drawTarget.h.

Member Enumeration Documentation

◆ DirtyBits

enum DirtyBits : HdDirtyBits

Dirty bits for the HdStDrawTarget object.

When GetUseStormTextureSystem() is true, "Legacy" dirty bits are ignored.

Definition at line 77 of file drawTarget.h.

Member Function Documentation

◆ GetCollection()

HDST_API HdRprimCollection const & GetCollection ( ) const
inline

Returns collection of rprims the draw target draws.

Definition at line 117 of file drawTarget.h.

◆ GetDrawTargetRenderPassState()

const HdStDrawTargetRenderPassState * GetDrawTargetRenderPassState ( ) const
inline

Definition at line 110 of file drawTarget.h.

◆ GetDrawTargets()

static HDST_API void GetDrawTargets ( HdRenderIndex renderIndex,
HdStDrawTargetPtrVector *  drawTargets 
)
static

returns all HdStDrawTargets in the render index

◆ GetInitialDirtyBitsMask()

HDST_API HdDirtyBits GetInitialDirtyBitsMask ( ) const
overridevirtual

Returns the minimal set of dirty bits to place in the change tracker for use in the first sync of this prim.

Typically this would be all dirty bits.

Implements HdSprim.

◆ GetResolution()

const GfVec2i & GetResolution ( ) const
inline

Resolution.

Set during sync.

Definition at line 128 of file drawTarget.h.

◆ IsEnabled()

bool IsEnabled ( ) const
inline

Definition at line 109 of file drawTarget.h.

◆ Sync()

HDST_API void Sync ( HdSceneDelegate sceneDelegate,
HdRenderParam renderParam,
HdDirtyBits *  dirtyBits 
)
overridevirtual

Synchronizes state from the delegate to this object.

Implements HdSprim.


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