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

#include <renderPass.h>

+ Inheritance diagram for HdSt_RenderPass:

Public Member Functions

HDST_API HdSt_RenderPass (HdRenderIndex *index, HdRprimCollection const &collection)
 
virtual HDST_API ~HdSt_RenderPass ()
 
HDST_API size_t GetDrawItemCount () const
 
- Public Member Functions inherited from HdRenderPass
HD_API HdRenderPass (HdRenderIndex *index, HdRprimCollection const &collection)
 
virtual HD_API ~HdRenderPass ()
 
HdRprimCollection constGetRprimCollection () const
 Returns the HdRprimCollection to be drawn by this RenderPass. More...
 
HD_API void SetRprimCollection (HdRprimCollection const &col)
 
HdDirtyListSharedPtr constGetDirtyList () const
 
HdRenderIndexGetRenderIndex () const
 Return the render index. More...
 
HD_API void Sync ()
 Sync the render pass resources. More...
 
HD_API void Prepare (TfTokenVector const &renderTags)
 Prepare renderpass data. More...
 
HD_API void Execute (HdRenderPassStateSharedPtr const &renderPassState, TfTokenVector const &renderTags)
 Execute a subset of buckets of this renderpass. More...
 
virtual bool IsConverged () const
 

Protected Member Functions

virtual void _Prepare (TfTokenVector const &renderTags) override
 Optional API: let derived classes prepare data. More...
 
virtual void _Execute (HdRenderPassStateSharedPtr const &renderPassState, TfTokenVector const &renderTags) override
 Execute the buckets corresponding to renderTags. More...
 
virtual void _MarkCollectionDirty () override
 Optional API: let derived classes mark their collection tracking as dirty. More...
 
- Protected Member Functions inherited from HdRenderPass
virtual void _Sync ()
 Optional API: let derived classes sync data. More...
 

Detailed Description

A single draw pass to a render target/buffer. Stream implementation.

Definition at line 42 of file renderPass.h.

Constructor & Destructor Documentation

HDST_API HdSt_RenderPass::HdSt_RenderPass ( HdRenderIndex index,
HdRprimCollection const collection 
)
virtual HDST_API HdSt_RenderPass::~HdSt_RenderPass ( )
virtual

Member Function Documentation

virtual void HdSt_RenderPass::_Execute ( HdRenderPassStateSharedPtr const renderPassState,
TfTokenVector const renderTags 
)
overrideprotectedvirtual

Execute the buckets corresponding to renderTags.

Implements HdRenderPass.

virtual void HdSt_RenderPass::_MarkCollectionDirty ( )
overrideprotectedvirtual

Optional API: let derived classes mark their collection tracking as dirty.

Reimplemented from HdRenderPass.

virtual void HdSt_RenderPass::_Prepare ( TfTokenVector const renderTags)
overrideprotectedvirtual

Optional API: let derived classes prepare data.

Reimplemented from HdRenderPass.

HDST_API size_t HdSt_RenderPass::GetDrawItemCount ( ) const

Returns the number of draw items used by this render pass. Will only return the correct value after Prepare() has been called on HdRenderPass. Calling this during Sync() will return last frame's drawItem count.


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