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

#include <renderTask.h>

+ Inheritance diagram for HdxRenderTask:

Public Member Functions

HDX_API HdxRenderTask (HdSceneDelegate *delegate, SdfPath const &id)
 
virtual HDX_API ~HdxRenderTask ()
 
virtual bool IsConverged () const override
 Hooks for progressive rendering (delegated to renderpasses). 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...
 
virtual HDX_API const
TfTokenVector
GetRenderTags () const override
 Collect Render Tags used by the task. More...
 
- Public Member Functions inherited from HdxTask
HDX_API HdxTask (SdfPath const &id)
 
HDX_API ~HdxTask () override
 
void Sync (HdSceneDelegate *delegate, HdTaskContext *ctx, HdDirtyBits *dirtyBits) final
 
- Public Member Functions inherited from HdTask
HD_API HdTask (SdfPath const &id)
 
virtual HD_API ~HdTask ()
 
SdfPath constGetId () const
 
virtual HD_API HdDirtyBits GetInitialDirtyBitsMask () const
 

Protected Member Functions

virtual HDX_API void _Sync (HdSceneDelegate *delegate, HdTaskContext *ctx, HdDirtyBits *dirtyBits) override
 Sync the render pass resources. More...
 
HDX_API HdRenderPassStateSharedPtr _GetRenderPassState (HdTaskContext *ctx) const
 
HDX_API size_t _GetDrawItemCount () const
 
- 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
Hgi_hgi
 

Detailed Description

A task for rendering geometry to pixels.

Rendering state management can be handled two ways: 1.) An application can create an HdxRenderTask and pass it the HdxRenderTaskParams struct as "params". 2.) An application can create an HdxRenderSetupTask and an HdxRenderTask, and pass params to the setup task. In this case the setup task must run first.

Parameter unpacking is handled by HdxRenderSetupTask; in case #1, HdxRenderTask creates a dummy setup task internally to manage the sync process.

Case #2 introduces complexity; the benefit is that by changing which setup task you run before the render task, you can change the render parameters without incurring a hydra sync or rebuilding any resources.

Definition at line 64 of file renderTask.h.

Constructor & Destructor Documentation

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

Member Function Documentation

HDX_API size_t HdxRenderTask::_GetDrawItemCount ( ) const
protected
HDX_API HdRenderPassStateSharedPtr HdxRenderTask::_GetRenderPassState ( HdTaskContext ctx) const
protected
virtual HDX_API void HdxRenderTask::_Sync ( HdSceneDelegate delegate,
HdTaskContext ctx,
HdDirtyBits dirtyBits 
)
overrideprotectedvirtual

Sync the render pass resources.

Implements HdxTask.

Reimplemented in HdxOitRenderTask, and HdxOitVolumeRenderTask.

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

Execute render pass task.

Implements HdTask.

Reimplemented in HdxOitRenderTask, and HdxOitVolumeRenderTask.

virtual HDX_API const TfTokenVector& HdxRenderTask::GetRenderTags ( ) const
overridevirtual

Collect Render Tags used by the task.

Reimplemented from HdTask.

virtual bool HdxRenderTask::IsConverged ( ) const
overridevirtual

Hooks for progressive rendering (delegated to renderpasses).

Reimplemented from HdxTask.

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

Prepare the tasks resources.

Implements HdTask.

Reimplemented in HdxOitRenderTask, and HdxOitVolumeRenderTask.


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