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

Represents an render pass that renders to a draw target. More...

Inherits noncopyable.

Public Member Functions

HDX_API HdxDrawTargetRenderPass (HdRenderIndex *index)
 
HDX_API void SetDrawTarget (const GlfDrawTargetRefPtr &drawTarget)
 Sets the target draw object of this render pass containing the color buffers and depth buffer to use. More...
 
HDX_API GlfDrawTargetRefPtr GetDrawTarget ()
 Returns the draw target associated to this render pass. More...
 
HDX_API void SetRenderPassState (const HdStDrawTargetRenderPassState *renderPassState)
 Sets the non-context dependent state. More...
 
HDX_API void SetRprimCollection (HdRprimCollection const &col)
 Sets the collection of rprims associated to this render pass. More...
 
HDX_API void Sync ()
 Sync the draw target render pass. More...
 
HDX_API void Prepare ()
 Prepare the draw target render pass. More...
 
HDX_API void Execute (HdRenderPassStateSharedPtr const &renderPassState, TfTokenVector const &renderTags)
 Execute the draw target render pass. More...
 

Detailed Description

Represents an render pass that renders to a draw target.

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

Definition at line 51 of file drawTargetRenderPass.h.

Member Function Documentation

HDX_API void Execute ( HdRenderPassStateSharedPtr const &  renderPassState,
TfTokenVector const &  renderTags 
)

Execute the draw target render pass.

HDX_API GlfDrawTargetRefPtr GetDrawTarget ( )

Returns the draw target associated to this render pass.

HDX_API void Prepare ( )

Prepare the draw target render pass.

HDX_API void SetDrawTarget ( const GlfDrawTargetRefPtr &  drawTarget)

Sets the target draw object of this render pass containing the color buffers and depth buffer to use.

HDX_API void SetRenderPassState ( const HdStDrawTargetRenderPassState renderPassState)

Sets the non-context dependent state.

The object is expected to live longer than this class.

HDX_API void SetRprimCollection ( HdRprimCollection const &  col)

Sets the collection of rprims associated to this render pass.

HDX_API void Sync ( )

Sync the draw target render pass.


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