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

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

Public Member Functions

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)
 Set the clear value for a color buffer that is applied at the beginning of rendering. More...
 
HDST_API void SetDepthClearValue (float clearValue)
 Set the clear value for the depth buffer. More...
 
HDST_API void SetDepthPriority (HdDepthPriority priority)
 Sets the priority of values in the depth buffer. More...
 
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
 Returns the clear color for the specified buffer. More...
 
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
 Returns an increasing version number for when the collection object is changed. More...
 
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 47 of file drawTargetRenderPassState.h.

Member Function Documentation

const SdfPath& GetCamera ( ) const
inline

Returns the path to the camera to render from.

Definition at line 105 of file drawTargetRenderPassState.h.

const VtValue& 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 90 of file drawTargetRenderPassState.h.

float GetDepthClearValue ( ) const
inline

Returns the clear value for the z-buffer.

Definition at line 98 of file drawTargetRenderPassState.h.

size_t GetNumColorAttachments ( ) const
inline

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

Definition at line 86 of file drawTargetRenderPassState.h.

const HdRprimCollection& GetRprimCollection ( ) const
inline

Returns the collection associated with this draw target.

Definition at line 117 of file drawTargetRenderPassState.h.

unsigned int 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 111 of file drawTargetRenderPassState.h.

HDST_API void SetCamera ( const SdfPath cameraId)

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

HDST_API void 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 SetDepthClearValue ( float  clearValue)

Set the clear value for the depth buffer.

It is expected the clear value is a normalize float.

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

Set the number of color buffer's to use.


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