HdxPresentTask Class Reference

#include <presentTask.h>

Inheritance diagram for HdxPresentTask:

Public Member Functions
HDX_API	HdxPresentTask (HdSceneDelegate *delegate, SdfPath const &id)
HDX_API	~HdxPresentTask () override
HDX_API void	Prepare (HdTaskContext *ctx, HdRenderIndex *renderIndex) override
HDX_API void	Execute (HdTaskContext *ctx) override
Public Member Functions inherited from HdxTask
HDX_API	HdxTask (SdfPath const &id)
HDX_API	~HdxTask () override
virtual HDX_API bool	IsConverged () const
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 ()
virtual HD_API const TfTokenVector &	GetRenderTags () const
SdfPath const &	GetId () const
virtual HD_API HdDirtyBits	GetInitialDirtyBitsMask () const

Static Public Member Functions
static HDX_API bool	IsFormatSupported (HgiFormat aovFormat)

Protected Member Functions
HDX_API void	_Sync (HdSceneDelegate *delegate, HdTaskContext *ctx, HdDirtyBits *dirtyBits) override
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 taking the final result of the aovs and compositing it over the currently bound framebuffer. This task uses the 'color' and optionally 'depth' aov's in the task context. The 'color' aov is expected to use non-integer (i.e., float or norm) types to keep the interop step simple.

Definition at line 78 of file presentTask.h.

Constructor & Destructor Documentation

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

HDX_API HdxPresentTask::~HdxPresentTask ( )

override

Member Function Documentation

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

overrideprotectedvirtual

Implements HdxTask.

HDX_API void HdxPresentTask::Execute ( HdTaskContext *  ctx )

overridevirtual

Execute Phase: Runs the task.

The execution phase should trigger render delegate processing, such as issuing draw commands.

Task execution is non-parallel and ordered.

The task context is the same as used by the prepare step and is used for inter-task communication.

Implements HdTask.

static HDX_API bool HdxPresentTask::IsFormatSupported ( HgiFormat  aovFormat )

static

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

overridevirtual

Prepare Phase: Resolve bindings and manage resources.

The Prepare phase happens before the Data Commit phase. All tasks in the task list get called for every execute. At this time all Tasks and other prims have completed the phase synced.

This is an opportunity for the task to pull data from other prims (such as a camera prim) by querying the render index.

The task can also use the phase to create, register and update temporary resources with the resource registry or other render delegate specific mechanism.

Tasks are always "Prepared" in execution order.

Inter-task communication is achievable via the task context. The same task context is used for the prepare and execution phases. Data in the task context isn't guaranteed to persist across calls to HdEngine::Execute().

Implements HdTask.

---

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

• pxr/imaging/hdx/presentTask.h