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 bool	HasDrawItems (TfTokenVector const &renderTags) const
Public Member Functions inherited from HdRenderPass
HD_API	HdRenderPass (HdRenderIndex *index, HdRprimCollection const &collection)
virtual HD_API	~HdRenderPass ()
HdRprimCollection const &	GetRprimCollection () const
	Returns the HdRprimCollection to be drawn by this RenderPass. More...
HD_API void	SetRprimCollection (HdRprimCollection const &col)
HdRenderIndex *	GetRenderIndex () const
	Return the render index. More...
HD_API void	Sync ()
	Sync the render pass resources. 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	_Execute (HdRenderPassStateSharedPtr const &renderPassState, TfTokenVector const &renderTags) override
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 23 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

Virtual API: Execute the buckets corresponding to renderTags; renderTags.empty() implies execute everything.

Implements HdRenderPass.

virtual void HdSt_RenderPass::_MarkCollectionDirty ( )

overrideprotectedvirtual

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

Reimplemented from HdRenderPass.

HDST_API bool HdSt_RenderPass::HasDrawItems

(

TfTokenVector const &

renderTags

)

const

Returns whether the render pass has draw items to be submitted during _Execute. This may be queried during the Prepare and Execute phases of the task owning the render pass. This information is useful to prevent unnecessary resource allocation and pipeline state changes.

---

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

• pxr/imaging/hdSt/renderPass.h