HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HdStDrawTarget Class Reference

#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
}
 

Public Member Functions

HDST_API HdStDrawTarget (SdfPath const &id)
 
HDST_API ~HdStDrawTarget () override
 
HDST_API void Sync (HdSceneDelegate *sceneDelegate, HdRenderParam *renderParam, HdDirtyBits *dirtyBits) override
 Synchronizes state from the delegate to this object. More...
 
HDST_API HdDirtyBits GetInitialDirtyBitsMask () const override
 
- Public Member Functions inherited from HdSprim
HD_API HdSprim (SdfPath const &id)
 
virtual HD_API ~HdSprim ()
 
SdfPath constGetId () const
 
virtual HD_API void Finalize (HdRenderParam *renderParam)
 

Draw Target API

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

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 63 of file drawTarget.h.

Member Enumeration Documentation

Dirty bits for the HdStDrawTarget object

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

Enumerator
Clean 
DirtyDTEnable 
DirtyDTCamera 
DirtyDTResolution 
DirtyDTAovBindings 
DirtyDTDepthPriority 
DirtyDTCollection 
AllDirty 

Definition at line 76 of file drawTarget.h.

Constructor & Destructor Documentation

HDST_API HdStDrawTarget::HdStDrawTarget ( SdfPath const id)
HDST_API HdStDrawTarget::~HdStDrawTarget ( )
override

Member Function Documentation

HDST_API HdRprimCollection const& HdStDrawTarget::GetCollection ( ) const
inline

Returns collection of rprims the draw target draws.

Definition at line 116 of file drawTarget.h.

const HdStDrawTargetRenderPassState* HdStDrawTarget::GetDrawTargetRenderPassState ( ) const
inline

Returns collection of rprims the draw target draws.

Definition at line 109 of file drawTarget.h.

static HDST_API void HdStDrawTarget::GetDrawTargets ( HdRenderIndex renderIndex,
HdStDrawTargetPtrVector drawTargets 
)
static

returns all HdStDrawTargets in the render index

HDST_API HdDirtyBits HdStDrawTarget::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.

const GfVec2i& HdStDrawTarget::GetResolution ( ) const
inline

Resolution.

Set during sync.

Definition at line 127 of file drawTarget.h.

bool HdStDrawTarget::IsEnabled ( ) const
inline

Returns collection of rprims the draw target draws.

Definition at line 108 of file drawTarget.h.

HDST_API void HdStDrawTarget::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: