HdxPickFromRenderBufferTask Class Reference

A task for running picking queries against pre-existing id buffers. More...

#include <pickFromRenderBufferTask.h>

Inheritance diagram for HdxPickFromRenderBufferTask:

Public Types
using	TaskParams = HdxPickFromRenderBufferTaskParams

Public Member Functions
HDX_API	HdxPickFromRenderBufferTask (HdSceneDelegate *delegate, SdfPath const &id)
bool	IsConverged () const override
	Hooks for progressive rendering.
HDX_API void	Prepare (HdTaskContext *ctx, HdRenderIndex *renderIndex) override
	Prepare the pick task.
HDX_API void	Execute (HdTaskContext *ctx) override
	Execute the pick task.
Public Member Functions inherited from HdxTask
HDX_API	HdxTask (SdfPath const &id)
HDX_API void	Sync (HdSceneDelegate *delegate, HdTaskContext *ctx, HdDirtyBits *dirtyBits) override final
	We override HdTask::Sync, but make it 'final' to make sure derived classes can't override it and instead override _Sync.
Public Member Functions inherited from HdTask
HD_API	HdTask (SdfPath const &id)
	Construct a new task.
virtual HD_API bool	IsConverged () const
	This function returns true when a (progressive) task considers its execution results converged.
virtual void	Sync (HdSceneDelegate *delegate, HdTaskContext *ctx, HdDirtyBits *dirtyBits)=0
	Sync Phase: Obtain task state from Scene delegate based on change processing.
virtual void	Prepare (HdTaskContext *ctx, HdRenderIndex *renderIndex)=0
	Prepare Phase: Resolve bindings and manage resources.
virtual void	Execute (HdTaskContext *ctx)=0
	Execute Phase: Runs the task.
virtual HD_API const TfTokenVector &	GetRenderTags () const
	Render Tag Gather.
SdfPath const &	GetId () const
virtual HD_API HdDirtyBits	GetInitialDirtyBitsMask () const
	Returns the minimal set of dirty bits to place in the change tracker for use in the first sync of this prim.

Protected Member Functions
HDX_API void	_Sync (HdSceneDelegate *delegate, HdTaskContext *ctx, HdDirtyBits *dirtyBits) override
	Sync the render pass resources.
Protected Member Functions inherited from HdxTask
virtual void	_Sync (HdSceneDelegate *delegate, HdTaskContext *ctx, HdDirtyBits *dirtyBits)=0
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)
	Extracts a typed value out of the task context at the given id.
HD_API TfTokenVector	_GetTaskRenderTags (HdSceneDelegate *delegate)

Additional Inherited Members
Static Public Member Functions inherited from HdxTask
static HDX_API bool	AreTasksConverged (HdRenderIndex *const renderIndex, const SdfPathVector &taskPaths)
	Are all tasks at taskPaths in the render index converged?
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.
template<class T >
static bool	_GetTaskContextData (HdTaskContext const *ctx, TfToken const &id, T *outValue)
	Extracts a typed value out of the task context at the given id.
template<class T >
static T	_GetDriver (HdTaskContext const *ctx, TfToken const &driverName)
	Extract an object from a HdDriver inside the task context.

Detailed Description

A task for running picking queries against pre-existing id buffers.

This task remaps the "pick frustum", provided by HdxPickTaskContextParams, to the camera frustum used to generate the ID buffers. It then runs the pick query against the subset of the ID buffers contained by the pick frustum.

Definition at line 61 of file pickFromRenderBufferTask.h.

Member Typedef Documentation

TaskParams

using TaskParams = HdxPickFromRenderBufferTaskParams

Definition at line 64 of file pickFromRenderBufferTask.h.

Member Function Documentation

_Sync()

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

overrideprotectedvirtual

Sync the render pass resources.

Implements HdxTask.

Execute()

HDX_API void Execute ( HdTaskContext *  ctx )

overridevirtual

Execute the pick task.

Implements HdTask.

IsConverged()

bool IsConverged ( ) const

overridevirtual

Hooks for progressive rendering.

Reimplemented from HdTask.

Prepare()

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

overridevirtual

Prepare the pick task.

Implements HdTask.

---

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

• pxr/imaging/hdx/pickFromRenderBufferTask.h