All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HdxSkydomeTask Class Reference

#include <skydomeTask.h>

+ Inheritance diagram for HdxSkydomeTask:

Public Member Functions

HDX_API HdxSkydomeTask (HdSceneDelegate *delegate, SdfPath const &id)
HDX_API ~HdxSkydomeTask () override
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)
HDX_API ~HdxTask () override
virtual HDX_API bool IsConverged () const
void Sync (HdSceneDelegate *delegate, HdTaskContext *ctx, HdDirtyBits *dirtyBits) overridefinal
- Public Member Functions inherited from HdTask
HD_API HdTask (SdfPath const &id)
virtual HD_API ~HdTask ()
virtual HD_API const
GetRenderTags () const
SdfPath constGetId () const
virtual HD_API HdDirtyBits GetInitialDirtyBitsMask () const

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
- Protected Member Functions inherited from HdTask
template<class T >
bool _GetTaskParams (HdSceneDelegate *delegate, T *outValue)
HD_API TfTokenVector _GetTaskRenderTags (HdSceneDelegate *delegate)

Additional Inherited Members

- 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. More...
template<class T >
static bool _GetTaskContextData (HdTaskContext const *ctx, TfToken const &id, T *outValue)
template<class T >
static T _GetDriver (HdTaskContext const *ctx, TfToken const &driverName)
- Protected Attributes inherited from HdxTask

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.

Constructor & Destructor Documentation

HDX_API HdxSkydomeTask::HdxSkydomeTask ( HdSceneDelegate delegate,
SdfPath const id 
HDX_API HdxSkydomeTask::~HdxSkydomeTask ( )

Member Function Documentation

HDX_API void HdxSkydomeTask::_Sync ( HdSceneDelegate delegate,
HdTaskContext ctx,
HdDirtyBits dirtyBits 

Sync the render pass resources.

Implements HdxTask.

HDX_API void HdxSkydomeTask::Execute ( HdTaskContext ctx)

Execute render pass task.

Implements HdTask.

HDX_API void HdxSkydomeTask::Prepare ( HdTaskContext ctx,
HdRenderIndex renderIndex 

Prepare the tasks resources.

Implements HdTask.

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