HdxSkydomeTask Class Reference

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

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 51 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 )

override

Execute render pass task.

Prepare()

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

override

Prepare the tasks resources.

---

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

• pxr/imaging/hdx/skydomeTask.h