HdxSelectionTask Class Reference

#include <selectionTask.h>

Inheritance diagram for HdxSelectionTask:

Public Member Functions
HDX_API	HdxSelectionTask (HdSceneDelegate *delegate, SdfPath const &id)
HDX_API	~HdxSelectionTask () override
HDX_API void	Sync (HdSceneDelegate *delegate, HdTaskContext *ctx, HdDirtyBits *dirtyBits) override
	Sync the render pass resources. 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...
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

Additional Inherited Members
Protected Member Functions inherited from HdTask
template<class T >
bool	_GetTaskParams (HdSceneDelegate *delegate, T *outValue)
HD_API TfTokenVector	_GetTaskRenderTags (HdSceneDelegate *delegate)
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

The SelectionTask is responsible for setting up render pass global buffers for selection and depositing those buffers into the task context for down stream consumption. Any render pass which wants to display selection may extract those buffers and bind them into the current render pass shader to enable selection highlighting.

Definition at line 61 of file selectionTask.h.

Constructor & Destructor Documentation

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

HDX_API HdxSelectionTask::~HdxSelectionTask ( )

override

Member Function Documentation

HDX_API void HdxSelectionTask::Execute ( HdTaskContext *  ctx )

overridevirtual

Execute render pass task.

Implements HdTask.

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

overridevirtual

Prepare the tasks resources.

Implements HdTask.

HDX_API void HdxSelectionTask::Sync ( HdSceneDelegate *  delegate, HdTaskContext *  ctx, HdDirtyBits *  dirtyBits  )

overridevirtual

Sync the render pass resources.

Implements HdTask.

---

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

• pxr/imaging/hdx/selectionTask.h