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

A task for taking the final result of the aovs and compositing it over the currently bound framebuffer. More...

+ Inheritance diagram for HdxPresentTask:

Public Member Functions

HDX_API HdxPresentTask (HdSceneDelegate *delegate, SdfPath const &id)
 
HDX_API void Prepare (HdTaskContext *ctx, HdRenderIndex *renderIndex) override
 
HDX_API void Execute (HdTaskContext *ctx) override
 
- Public Member Functions inherited from HdxTask
HDX_API HdxTask (SdfPath const &id)
 
virtual HDX_API bool IsConverged () const
 This function returns true when a (progressive) task considers its execution results converged. More...
 
void Sync (HdSceneDelegate *delegate, HdTaskContext *ctx, HdDirtyBits *dirtyBits) final
 We override HdTask::Sync, but make it 'final' to make sure derived classes can't override it and instead override _Sync. 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...
 

Static Public Member Functions

static HDX_API bool IsFormatSupported (HgiFormat aovFormat)
 

Protected Member Functions

HDX_API void _Sync (HdSceneDelegate *delegate, HdTaskContext *ctx, HdDirtyBits *dirtyBits) override
 
- 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)
 Extracts a typed value out of the task context at the given id. More...
 
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)
 Extracts a typed value out of the task context at the given id. More...
 
template<class T >
static T _GetDriver (HdTaskContext const *ctx, TfToken const &driverName)
 Extract an object from a HdDriver inside the task context. More...
 
- Protected Attributes inherited from HdxTask
Hgi_hgi
 

Detailed Description

A task for taking the final result of the aovs and compositing it over the currently bound framebuffer.

This task uses the 'color' and optionally 'depth' aov's in the task context. The 'color' aov is expected to use non-integer (i.e., float or norm) types to keep the interop step simple.

Definition at line 78 of file presentTask.h.


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