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

#include <drawTargetRenderPassState.h>

Public Member Functions

HDST_API HdStDrawTargetRenderPassState ()
 
HDST_API ~HdStDrawTargetRenderPassState ()
 
const
HdRenderPassAovBindingVector
GetAovBindings () const
 
HDST_API void SetAovBindings (const HdRenderPassAovBindingVector &aovBindings)
 
HDST_API void SetDepthPriority (HdDepthPriority priority)
 
HDST_API void SetCamera (const SdfPath &cameraId)
 Set the path to the camera to use to draw this render path from. More...
 
HDST_API void SetRprimCollection (HdRprimCollection const &col)
 
HdDepthPriority GetDepthPriority () const
 
const SdfPathGetCamera () const
 Returns the path to the camera to render from. More...
 
unsigned int GetRprimCollectionVersion () const
 
const HdRprimCollectionGetRprimCollection () const
 Returns the collection associated with this draw target. More...
 

Detailed Description

Represents common non-gl context specific render pass state for a draw target.

Note
This is a temporary API to aid transition to Storm, and is subject to major changes. It is likely this functionality will be absorbed into the base class.

Definition at line 49 of file drawTargetRenderPassState.h.

Constructor & Destructor Documentation

HDST_API HdStDrawTargetRenderPassState::HdStDrawTargetRenderPassState ( )
HDST_API HdStDrawTargetRenderPassState::~HdStDrawTargetRenderPassState ( )

Member Function Documentation

const HdRenderPassAovBindingVector& HdStDrawTargetRenderPassState::GetAovBindings ( ) const
inline

Definition at line 57 of file drawTargetRenderPassState.h.

const SdfPath& HdStDrawTargetRenderPassState::GetCamera ( ) const
inline

Returns the path to the camera to render from.

Definition at line 80 of file drawTargetRenderPassState.h.

HdDepthPriority HdStDrawTargetRenderPassState::GetDepthPriority ( ) const
inline

Definition at line 76 of file drawTargetRenderPassState.h.

const HdRprimCollection& HdStDrawTargetRenderPassState::GetRprimCollection ( ) const
inline

Returns the collection associated with this draw target.

Definition at line 92 of file drawTargetRenderPassState.h.

unsigned int HdStDrawTargetRenderPassState::GetRprimCollectionVersion ( ) const
inline

Returns an increasing version number for when the collection object is changed. Note: This tracks the actual object and not the contents of the collection.

Definition at line 86 of file drawTargetRenderPassState.h.

HDST_API void HdStDrawTargetRenderPassState::SetAovBindings ( const HdRenderPassAovBindingVector aovBindings)
HDST_API void HdStDrawTargetRenderPassState::SetCamera ( const SdfPath cameraId)

Set the path to the camera to use to draw this render path from.

HDST_API void HdStDrawTargetRenderPassState::SetDepthPriority ( HdDepthPriority  priority)

Sets the priority of values in the depth buffer. i.e. should pixels closer or further from the camera win.

HDST_API void HdStDrawTargetRenderPassState::SetRprimCollection ( HdRprimCollection const &  col)

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