Loading...
Searching...
No Matches
HdxShadowTask Class Reference

A task for generating shadow maps. More...

#include <shadowTask.h>

+ Inheritance diagram for HdxShadowTask:

Public Types

using TaskParams = HdxShadowTaskParams
 

Public Member Functions

HDX_API HdxShadowTask (HdSceneDelegate *delegate, SdfPath const &id)
 
HDX_API void Sync (HdSceneDelegate *delegate, HdTaskContext *ctx, HdDirtyBits *dirtyBits) override
 Sync the render pass resources.
 
HDX_API void Prepare (HdTaskContext *ctx, HdRenderIndex *renderIndex) override
 Prepare the tasks resources.
 
HDX_API void Execute (HdTaskContext *ctx) override
 Execute render pass task.
 
HDX_API const TfTokenVectorGetRenderTags () const override
 Collect Render Tags used by the task.
 
- 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 TfTokenVectorGetRenderTags () 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.
 

Additional Inherited Members

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

A task for generating shadow maps.

Definition at line 72 of file shadowTask.h.

Member Typedef Documentation

◆ TaskParams

using TaskParams = HdxShadowTaskParams

Definition at line 75 of file shadowTask.h.

Member Function Documentation

◆ Execute()

HDX_API void Execute ( HdTaskContext *  ctx)
overridevirtual

Execute render pass task.

Implements HdTask.

◆ GetRenderTags()

HDX_API const TfTokenVector & GetRenderTags ( ) const
overridevirtual

Collect Render Tags used by the task.

Reimplemented from HdTask.

◆ Prepare()

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

Prepare the tasks resources.

Implements HdTask.

◆ Sync()

HDX_API void Sync ( HdSceneDelegate delegate,
HdTaskContext *  ctx,
HdDirtyBits *  dirtyBits 
)
overridevirtual

Sync the render pass resources.

Implements HdTask.


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