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

#include <colorizeSelectionTask.h>

Inheritance diagram for HdxColorizeSelectionTask:

Public Member Functions
HDX_API	HdxColorizeSelectionTask (HdSceneDelegate *delegate, SdfPath const &id)

bool	IsConverged () const override
	Hooks for progressive rendering.

HDX_API void	Prepare (HdTaskContext ctx, HdRenderIndex renderIndex) override
	Prepare the render pass resources.

HDX_API void	Execute (HdTaskContext *ctx) override
	Execute the task.

Public Member Functions inherited from HdxTask
HDX_API	HdxTask (SdfPath const &id)

virtual HDX_API bool	IsConverged () const
	This function returns true when a (progressive) task considers its execution results converged.

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.

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

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 74 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:

pxr/imaging/hdx/colorizeSelectionTask.h