Public Member Functions | Protected Member Functions | List of all members
HdxColorizeSelectionTask Class Reference

A task for taking ID buffer data and turning it into a "selection overlay" that can be composited on top of hydra's color output. More...

+ Inheritance diagram for HdxColorizeSelectionTask:

Public Member Functions

HDX_API HdxColorizeSelectionTask (HdSceneDelegate *delegate, SdfPath const &id)
 
bool IsConverged () const override
 Hooks for progressive rendering. More...
 
HDX_API void Prepare (HdTaskContext *ctx, HdRenderIndex *renderIndex) override
 Prepare the render pass resources. More...
 
HDX_API void Execute (HdTaskContext *ctx) override
 Execute the task. More...
 
- Public Member Functions inherited from HdxTask
HDX_API HdxTask (SdfPath const &id)
 
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. More...
 

Protected Member Functions

HDX_API void _Sync (HdSceneDelegate *delegate, HdTaskContext *ctx, HdDirtyBits *dirtyBits) override
 Sync the render pass resources. More...
 
- Protected Member Functions inherited from HdxTask
void _ToggleRenderTarget (HdTaskContext *ctx)
 
HDX_API Hgi * _GetHgi () const
 

Additional Inherited Members

- Protected Attributes inherited from HdxTask
Hgi * _hgi
 

Detailed Description

A task for taking ID buffer data and turning it into a "selection overlay" that can be composited on top of hydra's color output.

If enableOutline is true then instead of overlaying the ID buffer as is, an outline with thickness of outlineRadius pixels around the areas with IDs will be overlaid. Otherwise, the ID buffer will be overlaid as is.

Definition at line 72 of file colorizeSelectionTask.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)
override

Execute the task.

◆ IsConverged()

bool IsConverged ( ) const
overridevirtual

Hooks for progressive rendering.

Reimplemented from HdxTask.

◆ Prepare()

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

Prepare the render pass resources.

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