If we have a domelight present in the lighting context the SkydomeTask will render the associated environment map as a Skydome. More...

#include <skydomeTask.h>

Inheritance diagram for HdxSkydomeTask:

Public Types
using	TaskParams = HdxRenderTaskParams

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

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

HDX_API void	Execute (HdTaskContext *ctx) override
	Execute render pass 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

If we have a domelight present in the lighting context the SkydomeTask will render the associated environment map as a Skydome.

Otherwise, it will simply clear the AOVs.

Note that this task is intended to be the first "Render Task" in the HdxTaskController so that the AOV's are properly cleared, however it does not spawn a HdRenderPass.

Definition at line 34 of file skydomeTask.h.

Member Typedef Documentation

◆ TaskParams

using TaskParams = HdxRenderTaskParams

Definition at line 37 of file skydomeTask.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 render pass task.

Implements HdTask.

◆ Prepare()

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

overridevirtual

Prepare the tasks resources.

Implements HdTask.

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

pxr/imaging/hdx/skydomeTask.h

Public Types

Public Member Functions

Protected Member Functions