Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Friends | List of all members
HdxColorCorrectionTask Class Reference

A task for performing color correction (and optionally color grading) on a color buffer to transform its color for display. More...

#include <colorCorrectionTask.h>

+ Inheritance diagram for HdxColorCorrectionTask:

Public Member Functions

HDX_API HdxColorCorrectionTask (HdSceneDelegate *delegate, SdfPath const &id)
 
HDX_API void Prepare (HdTaskContext *ctx, HdRenderIndex *renderIndex) override
 Prepare the tasks resources.
 
HDX_API void Execute (HdTaskContext *ctx) override
 Execute the color correction task.
 
- 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.
 
HDX_API void Sync (HdSceneDelegate *delegate, HdTaskContext *ctx, HdDirtyBits *dirtyBits) override final
 We override HdTask::Sync, but make it 'final' to make sure derived classes can't override it and instead override _Sync.
 

Protected Member Functions

HDX_API void _Sync (HdSceneDelegate *delegate, HdTaskContext *ctx, HdDirtyBits *dirtyBits) override
 Sync the render pass resources.
 
- Protected Member Functions inherited from HdxTask
virtual void _Sync (HdSceneDelegate *delegate, HdTaskContext *ctx, HdDirtyBits *dirtyBits)=0
 
HDX_API void _ToggleRenderTarget (HdTaskContext *ctx)
 
HDX_API void _ToggleDepthTarget (HdTaskContext *ctx)
 
HDX_API void _SwapTextures (HdTaskContext *ctx, const TfToken &textureToken, const TfToken &textureIntermediateToken)
 
HDX_API Hgi * _GetHgi () const
 

Friends

struct HdxColorCorrectionTask_UboBuilder
 

Detailed Description

A task for performing color correction (and optionally color grading) on a color buffer to transform its color for display.

Definition at line 88 of file colorCorrectionTask.h.

Member Function Documentation

◆ _Sync()

HDX_API void _Sync ( HdSceneDelegate *  delegate,
HdTaskContext *  ctx,
HdDirtyBits *  dirtyBits 
)
overrideprotectedvirtual

Sync the render pass resources.

Implements HdxTask.

◆ Execute()

HDX_API void Execute ( HdTaskContext *  ctx)
override

Execute the color correction task.

◆ Prepare()

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

Prepare the tasks resources.

Friends And Related Function Documentation

◆ HdxColorCorrectionTask_UboBuilder

friend struct HdxColorCorrectionTask_UboBuilder
friend

Definition at line 133 of file colorCorrectionTask.h.

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