HdxRenderTask Class Reference

#include <renderTask.h>

Inheritance diagram for HdxRenderTask:

Public Member Functions
HDX_API	HdxRenderTask (HdSceneDelegate *delegate, SdfPath const &id)
HDX_API	~HdxRenderTask () override
HDX_API bool	IsConverged () const override
	Hooks for progressive rendering (delegated to renderpasses). More...
HDX_API void	Prepare (HdTaskContext *ctx, HdRenderIndex *renderIndex) override
	Prepare the tasks resources. More...
HDX_API void	Execute (HdTaskContext *ctx) override
	Execute render pass task. More...
HDX_API const TfTokenVector &	GetRenderTags () const override
	Collect Render Tags used by the task. More...
Public Member Functions inherited from HdxTask
HDX_API	HdxTask (SdfPath const &id)
HDX_API	~HdxTask () override
HDX_API void	Sync (HdSceneDelegate *delegate, HdTaskContext *ctx, HdDirtyBits *dirtyBits) overridefinal
Public Member Functions inherited from HdTask
HD_API	HdTask (SdfPath const &id)
virtual HD_API	~HdTask ()
SdfPath const &	GetId () const
virtual HD_API HdDirtyBits	GetInitialDirtyBitsMask () const

Protected Member Functions
HDX_API void	_Sync (HdSceneDelegate *delegate, HdTaskContext *ctx, HdDirtyBits *dirtyBits) override
	Sync the render pass resources. More...
HDX_API HdRenderPassStateSharedPtr	_GetRenderPassState (HdTaskContext *ctx) const
HDX_API bool	_HasDrawItems () const
Protected Member Functions inherited from HdxTask
HDX_API void	_ToggleRenderTarget (HdTaskContext *ctx)
HDX_API void	_ToggleDepthTarget (HdTaskContext *ctx)
HDX_API void	_SwapTextures (HdTaskContext *ctx, const TfToken &textureToken, const TfToken &textureIntermediateToken)
HDX_API Hgi *	_GetHgi () const
Protected Member Functions inherited from HdTask
template<class T >
bool	_GetTaskParams (HdSceneDelegate *delegate, T *outValue)
HD_API TfTokenVector	_GetTaskRenderTags (HdSceneDelegate *delegate)

Additional Inherited Members
Static Protected Member Functions inherited from HdTask
static HD_API bool	_HasTaskContextData (HdTaskContext const *ctx, TfToken const &id)
	Check if the shared context contains a value for the given id. More...
template<class T >
static bool	_GetTaskContextData (HdTaskContext const *ctx, TfToken const &id, T *outValue)
template<class T >
static T	_GetDriver (HdTaskContext const *ctx, TfToken const &driverName)

Detailed Description

A task for rendering geometry to pixels.

Rendering state management can be handled two ways: 1.) An application can create an HdxRenderTask and pass it the HdxRenderTaskParams struct as "params". 2.) An application can create an HdxRenderSetupTask and an HdxRenderTask, and pass params to the setup task. In this case the setup task must run first.

Parameter unpacking is handled by HdxRenderSetupTask; in case #1, HdxRenderTask creates a dummy setup task internally to manage the sync process.

Case #2 introduces complexity; the benefit is that by changing which setup task you run before the render task, you can change the render parameters without incurring a hydra sync or rebuilding any resources.

Definition at line 64 of file renderTask.h.

Constructor & Destructor Documentation

HDX_API HdxRenderTask::HdxRenderTask	(	HdSceneDelegate *	delegate,
		SdfPath const &	id
	)

HDX_API HdxRenderTask::~HdxRenderTask ( )

override

Member Function Documentation

HDX_API HdRenderPassStateSharedPtr HdxRenderTask::_GetRenderPassState ( HdTaskContext *  ctx ) const

protected

HDX_API bool HdxRenderTask::_HasDrawItems ( ) const

protected

HDX_API void HdxRenderTask::_Sync ( HdSceneDelegate *  delegate, HdTaskContext *  ctx, HdDirtyBits *  dirtyBits  )

overrideprotectedvirtual

Sync the render pass resources.

Implements HdxTask.

HDX_API void HdxRenderTask::Execute ( HdTaskContext *  ctx )

overridevirtual

Execute render pass task.

Implements HdTask.

HDX_API const TfTokenVector& HdxRenderTask::GetRenderTags ( ) const

overridevirtual

Collect Render Tags used by the task.

Reimplemented from HdTask.

HDX_API bool HdxRenderTask::IsConverged ( ) const

overridevirtual

Hooks for progressive rendering (delegated to renderpasses).

Reimplemented from HdxTask.

HDX_API void HdxRenderTask::Prepare ( HdTaskContext *  ctx, HdRenderIndex *  renderIndex  )

overridevirtual

Prepare the tasks resources.

Implements HdTask.

---

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

• pxr/imaging/hdx/renderTask.h