All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HdxSelectionTask Class Reference

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. More...

Inherits HdTask.

Public Member Functions

HDX_API HdxSelectionTask (HdSceneDelegate *delegate, SdfPath const &id)
 
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)
 Construct a new task. More...
 
virtual void Sync (HdSceneDelegate *delegate, HdTaskContext *ctx, HdDirtyBits *dirtyBits)=0
 Sync Phase: Obtain task state from Scene delegate based on change processing. More...
 
virtual void Prepare (HdTaskContext *ctx, HdRenderIndex *renderIndex)=0
 Prepare Phase: Resolve bindings and manage resources. More...
 
virtual void Execute (HdTaskContext *ctx)=0
 Execute Phase: Runs the task. More...
 
virtual HD_API const
TfTokenVector
GetRenderTags () const
 Render Tag Gather. More...
 
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. More...
 

Additional Inherited Members

- 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. More...
 
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)
 Extracts a typed value out of the task context at the given id. More...
 
template<class T >
static T _GetDriver (HdTaskContext const *ctx, TfToken const &driverName)
 Extract an object from a HdDriver inside the task context. More...
 

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.

Member Function Documentation

HDX_API void Execute ( HdTaskContext *  ctx)
override

Execute render pass task.

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

Prepare the tasks resources.

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

Sync the render pass resources.


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