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

#include <renderSetupTask.h>

+ Inheritance diagram for HdxRenderSetupTask:

Public Member Functions

HDX_API HdxRenderSetupTask (HdSceneDelegate *delegate, SdfPath const &id)
 
virtual HDX_API ~HdxRenderSetupTask ()
 
HDX_API void SyncParams (HdSceneDelegate *delegate, HdxRenderTaskParams const &params)
 
HDX_API void PrepareCamera (HdRenderIndex *renderIndex)
 
HdRenderPassStateSharedPtr constGetRenderPassState () 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)
 
virtual HD_API ~HdTask ()
 
virtual HD_API const
TfTokenVector
GetRenderTags () const
 
SdfPath constGetId () const
 
virtual HD_API HdDirtyBits GetInitialDirtyBitsMask () const
 

Additional Inherited Members

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

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 66 of file renderSetupTask.h.

Constructor & Destructor Documentation

HDX_API HdxRenderSetupTask::HdxRenderSetupTask ( HdSceneDelegate delegate,
SdfPath const id 
)
virtual HDX_API HdxRenderSetupTask::~HdxRenderSetupTask ( )
virtual

Member Function Documentation

virtual HDX_API void HdxRenderSetupTask::Execute ( HdTaskContext ctx)
overridevirtual

Execute render pass task.

Implements HdTask.

HdRenderPassStateSharedPtr const& HdxRenderSetupTask::GetRenderPassState ( ) const
inline

Definition at line 82 of file renderSetupTask.h.

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

Prepare the tasks resources.

Implements HdTask.

HDX_API void HdxRenderSetupTask::PrepareCamera ( HdRenderIndex renderIndex)
virtual HDX_API void HdxRenderSetupTask::Sync ( HdSceneDelegate delegate,
HdTaskContext ctx,
HdDirtyBits dirtyBits 
)
overridevirtual

Sync the render pass resources.

Implements HdTask.

HDX_API void HdxRenderSetupTask::SyncParams ( HdSceneDelegate delegate,
HdxRenderTaskParams const params 
)

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