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 SetNumColorAttachments (size_t numAttachments)
 Set the number of color buffer's to use. More...
 
HDST_API void SetColorClearValue (size_t attachmentIdx, const VtValue &clearValue)
 
HDST_API void SetDepthClearValue (float clearValue)
 
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)
 
size_t GetNumColorAttachments () const
 Returns the number of color buffers attached to the draw target. More...
 
const VtValueGetColorClearValue (size_t attachmentIdx) const
 
float GetDepthClearValue () const
 Returns the clear value for the z-buffer. More...
 
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 56 of file drawTargetRenderPassState.h.

const SdfPath& HdStDrawTargetRenderPassState::GetCamera ( ) const
inline

Returns the path to the camera to render from.

Definition at line 114 of file drawTargetRenderPassState.h.

const VtValue& HdStDrawTargetRenderPassState::GetColorClearValue ( size_t  attachmentIdx) const
inline

Returns the clear color for the specified buffer. The type is dependant on the format of the buffer.

Definition at line 99 of file drawTargetRenderPassState.h.

float HdStDrawTargetRenderPassState::GetDepthClearValue ( ) const
inline

Returns the clear value for the z-buffer.

Definition at line 107 of file drawTargetRenderPassState.h.

HdDepthPriority HdStDrawTargetRenderPassState::GetDepthPriority ( ) const
inline

Definition at line 110 of file drawTargetRenderPassState.h.

size_t HdStDrawTargetRenderPassState::GetNumColorAttachments ( ) const
inline

Returns the number of color buffers attached to the draw target.

Definition at line 95 of file drawTargetRenderPassState.h.

const HdRprimCollection& HdStDrawTargetRenderPassState::GetRprimCollection ( ) const
inline

Returns the collection associated with this draw target.

Definition at line 126 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 120 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::SetColorClearValue ( size_t  attachmentIdx,
const VtValue clearValue 
)

Set the clear value for a color buffer that is applied at the beginning of rendering. The expected type of clearValue is dependent on the format of the buffer specified in current draw target at execute time. (i.e. there is no order dependency between setting the draw target and color values. An unexpected formats results in an error and the buffer not being cleared.

HDST_API void HdStDrawTargetRenderPassState::SetDepthClearValue ( float  clearValue)

Set the clear value for the depth buffer. It is expected the clear value is a normalize float.

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::SetNumColorAttachments ( size_t  numAttachments)

Set the number of color buffer's to use.

HDST_API void HdStDrawTargetRenderPassState::SetRprimCollection ( HdRprimCollection const col)

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