HdStDrawTargetRenderPassState Class Reference

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

#include <drawTargetRenderPassState.h>

Public Member Functions
const HdRenderPassAovBindingVector &	GetAovBindings () const
HDST_API void	SetAovBindings (const HdRenderPassAovBindingVector &aovBindings)
HDST_API void	SetDepthPriority (HdDepthPriority priority)
	Sets the priority of values in the depth buffer.
HDST_API void	SetCamera (const SdfPath &cameraId)
	Set the path to the camera to use to draw this render path from.
HDST_API void	SetRprimCollection (HdRprimCollection const &col)
HdDepthPriority	GetDepthPriority () const
const SdfPath &	GetCamera () const
	Returns the path to the camera to render from.
unsigned int	GetRprimCollectionVersion () const
	Returns an increasing version number for when the collection object is changed.
const HdRprimCollection &	GetRprimCollection () const
	Returns the collection associated with this draw target.

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 32 of file drawTargetRenderPassState.h.

Member Function Documentation

GetAovBindings()

const HdRenderPassAovBindingVector & GetAovBindings ( ) const

inline

Definition at line 40 of file drawTargetRenderPassState.h.

GetCamera()

const SdfPath & GetCamera ( ) const

inline

Returns the path to the camera to render from.

Definition at line 63 of file drawTargetRenderPassState.h.

GetDepthPriority()

HdDepthPriority GetDepthPriority ( ) const

inline

Definition at line 59 of file drawTargetRenderPassState.h.

GetRprimCollection()

const HdRprimCollection & GetRprimCollection ( ) const

inline

Returns the collection associated with this draw target.

Definition at line 75 of file drawTargetRenderPassState.h.

GetRprimCollectionVersion()

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 69 of file drawTargetRenderPassState.h.

SetCamera()

HDST_API void SetCamera

(

const SdfPath &

cameraId

)

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

SetDepthPriority()

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.

---

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

• pxr/imaging/hdSt/drawTargetRenderPassState.h