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

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

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: