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

A task for setting up render pass state (camera, renderpass shader, GL states). More...

Inherits HdTask.

Public Member Functions

HDX_API HdxRenderSetupTask (HdSceneDelegate *delegate, SdfPath const &id)
 
HDX_API void SyncParams (HdSceneDelegate *delegate, HdxRenderTaskParams const &params)
 
HDX_API void PrepareCamera (HdRenderIndex *renderIndex)
 
HdRenderPassStateSharedPtr const & GetRenderPassState () const
 
virtual HDX_API void Sync (HdSceneDelegate *delegate, HdTaskContext *ctx, HdDirtyBits *dirtyBits) override
 Sync the render pass resources. More...
 
virtual HDX_API void Prepare (HdTaskContext *ctx, HdRenderIndex *renderIndex) override
 Prepare the tasks resources. More...
 
virtual HDX_API void Execute (HdTaskContext *ctx) override
 Execute render pass task. More...
 
- Public Member Functions inherited from HdTask
HD_API HdTask (SdfPath const &id)
 Construct a new task. More...
 
virtual void Sync (HdSceneDelegate *delegate, HdTaskContext *ctx, HdDirtyBits *dirtyBits)=0
 Sync Phase: Obtain task state from Scene delegate based on change processing. More...
 
virtual void Prepare (HdTaskContext *ctx, HdRenderIndex *renderIndex)=0
 Prepare Phase: Resolve bindings and manage resources. More...
 
virtual void Execute (HdTaskContext *ctx)=0
 Execute Phase: Runs the task. More...
 
virtual HD_API const
TfTokenVector
GetRenderTags () const
 Render Tag Gather. More...
 
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. More...
 

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. More...
 
HD_API TfTokenVector _GetTaskRenderTags (HdSceneDelegate *delegate)
 
- Static Protected Member Functions inherited from HdTask
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. More...
 

Detailed Description

A task for setting up render pass state (camera, renderpass shader, GL states).

HdxRenderTask depends on the output of this task. Applications can choose to create a render setup task, and pass it the HdxRenderTaskParams; or they can pass the HdxRenderTaskParams directly to the render task, which will create a render setup task internally. See the HdxRenderTask documentation for details.

Definition at line 63 of file renderSetupTask.h.

Member Function Documentation

virtual HDX_API void Execute ( HdTaskContext *  ctx)
overridevirtual

Execute render pass task.

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

Prepare the tasks resources.

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

Sync the render pass resources.


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