VTK
9.1.0
|
Implement a post-processing Tone Mapping. More...
#include <vtkToneMappingPass.h>
Public Types | |
enum | { Clamp = 0 , Reinhard = 1 , Exponential = 2 , GenericFilmic = 3 } |
Enumeration of tone mapping algorithms. More... | |
typedef vtkImageProcessingPass | Superclass |
![]() | |
typedef vtkOpenGLRenderPass | Superclass |
![]() | |
typedef vtkRenderPass | Superclass |
![]() | |
typedef vtkObject | Superclass |
Public Member Functions | |
virtual vtkTypeBool | IsA (const char *type) |
Return 1 if this class is the same type of (or a subclass of) the named class. More... | |
vtkToneMappingPass * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. More... | |
void | Render (const vtkRenderState *s) override |
Perform rendering according to a render state. More... | |
void | ReleaseGraphicsResources (vtkWindow *w) override |
Release graphics resources and ask components to release their own resources. More... | |
void | SetGenericFilmicDefaultPresets () |
Set function to set uncharted 2 presets, and default presets. More... | |
void | SetGenericFilmicUncharted2Presets () |
Set function to set uncharted 2 presets, and default presets. More... | |
virtual void | SetToneMappingType (int) |
Get/Set the tone mapping type. More... | |
virtual int | GetToneMappingType () |
Get/Set the tone mapping type. More... | |
virtual float | GetExposure () |
Get/Set Exposure coefficient used for exponential and Generic Filmic tone mapping. More... | |
virtual void | SetExposure (float) |
Get/Set Exposure coefficient used for exponential and Generic Filmic tone mapping. More... | |
virtual void | SetContrast (float) |
Contrast adjust the toe of the curve. More... | |
virtual float | GetContrast () |
Contrast adjust the toe of the curve. More... | |
virtual void | SetShoulder (float) |
Shoulder limit the output in the shoulder region of the curve. More... | |
virtual float | GetShoulder () |
Shoulder limit the output in the shoulder region of the curve. More... | |
virtual void | SetMidIn (float) |
Mid level anchor input. More... | |
virtual float | GetMidIn () |
Mid level anchor input. More... | |
virtual void | SetMidOut (float) |
Mid level anchor output. More... | |
virtual float | GetMidOut () |
Mid level anchor output. More... | |
virtual void | SetHdrMax (float) |
Maximum HDR input that is not clipped. More... | |
virtual float | GetHdrMax () |
Maximum HDR input that is not clipped. More... | |
virtual void | SetUseACES (bool) |
Apply or not the Academy Color Encoding System (ACES). More... | |
virtual bool | GetUseACES () |
Apply or not the Academy Color Encoding System (ACES). More... | |
![]() | |
virtual vtkTypeBool | IsA (const char *type) |
Return 1 if this class is the same type of (or a subclass of) the named class. More... | |
vtkImageProcessingPass * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. More... | |
void | ReleaseGraphicsResources (vtkWindow *w) override |
Release graphics resources and ask components to release their own resources. More... | |
virtual vtkRenderPass * | GetDelegatePass () |
Delegate for rendering the image to be processed. More... | |
virtual void | SetDelegatePass (vtkRenderPass *delegatePass) |
Delegate for rendering the image to be processed. More... | |
![]() | |
virtual vtkTypeBool | IsA (const char *type) |
Return 1 if this class is the same type of (or a subclass of) the named class. More... | |
vtkOpenGLRenderPass * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. More... | |
virtual bool | SetShaderParameters (vtkShaderProgram *program, vtkAbstractMapper *mapper, vtkProp *prop, vtkOpenGLVertexArrayObject *VAO=nullptr) |
Update the uniforms of the shader program. More... | |
virtual vtkMTimeType | GetShaderStageMTime () |
For multi-stage render passes that need to change shader code during a single pass, use this method to notify a mapper that the shader needs to be rebuilt (rather than reuse the last cached shader. More... | |
virtual void | SetActiveDrawBuffers (unsigned int) |
Number of active draw buffers. More... | |
virtual unsigned int | GetActiveDrawBuffers () |
virtual bool | PreReplaceShaderValues (std::string &vertexShader, std::string &geometryShader, std::string &fragmentShader, vtkAbstractMapper *mapper, vtkProp *prop) |
Use vtkShaderProgram::Substitute to replace. More... | |
virtual bool | PostReplaceShaderValues (std::string &vertexShader, std::string &geometryShader, std::string &fragmentShader, vtkAbstractMapper *mapper, vtkProp *prop) |
Use vtkShaderProgram::Substitute to replace. More... | |
![]() | |
virtual vtkTypeBool | IsA (const char *type) |
Return 1 if this class is the same type of (or a subclass of) the named class. More... | |
vtkRenderPass * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. More... | |
virtual void | Render (const vtkRenderState *s)=0 |
Perform rendering according to a render state s . More... | |
virtual void | ReleaseGraphicsResources (vtkWindow *w) |
Release graphics resources and ask components to release their own resources. More... | |
virtual int | GetNumberOfRenderedProps () |
Number of props rendered at the last Render call. More... | |
![]() | |
vtkBaseTypeMacro (vtkObject, vtkObjectBase) | |
virtual void | DebugOn () |
Turn debugging output on. More... | |
virtual void | DebugOff () |
Turn debugging output off. More... | |
bool | GetDebug () |
Get the value of the debug flag. More... | |
void | SetDebug (bool debugFlag) |
Set the value of the debug flag. More... | |
virtual void | Modified () |
Update the modification time for this object. More... | |
virtual vtkMTimeType | GetMTime () |
Return this object's modified time. More... | |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. More... | |
void | RemoveObserver (unsigned long tag) |
void | RemoveObservers (unsigned long event) |
void | RemoveObservers (const char *event) |
void | RemoveAllObservers () |
vtkTypeBool | HasObserver (unsigned long event) |
vtkTypeBool | HasObserver (const char *event) |
int | InvokeEvent (unsigned long event) |
int | InvokeEvent (const char *event) |
unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
vtkCommand * | GetCommand (unsigned long tag) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
void | RemoveObserver (vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
void | RemoveObservers (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
void | RemoveObservers (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
template<class U , class T > | |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f) |
Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More... | |
template<class U , class T > | |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More... | |
template<class U , class T > | |
unsigned long | AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
Allow user to set the AbortFlagOn() with the return value of the callback method. More... | |
int | InvokeEvent (unsigned long event, void *callData) |
This method invokes an event and return whether the event was aborted or not. More... | |
int | InvokeEvent (const char *event, void *callData) |
This method invokes an event and return whether the event was aborted or not. More... | |
![]() | |
const char * | GetClassName () const |
Return the class name as a string. More... | |
virtual vtkTypeBool | IsA (const char *name) |
Return 1 if this class is the same type of (or a subclass of) the named class. More... | |
virtual vtkIdType | GetNumberOfGenerationsFromBase (const char *name) |
Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More... | |
virtual void | Delete () |
Delete a VTK object. More... | |
virtual void | FastDelete () |
Delete a reference to this object. More... | |
void | InitializeObjectBase () |
void | Print (ostream &os) |
Print an object to an ostream. More... | |
virtual void | Register (vtkObjectBase *o) |
Increase the reference count (mark as used by another object). More... | |
virtual void | UnRegister (vtkObjectBase *o) |
Decrease the reference count (release by another object). More... | |
int | GetReferenceCount () |
Return the current reference count of this object. More... | |
void | SetReferenceCount (int) |
Sets the reference count. More... | |
bool | GetIsInMemkind () const |
A local state flag that remembers whether this object lives in the normal or extended memory space. More... | |
virtual void | PrintHeader (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. More... | |
virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. More... | |
Static Public Member Functions | |
static vtkToneMappingPass * | New () |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkToneMappingPass * | SafeDownCast (vtkObjectBase *o) |
![]() | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkImageProcessingPass * | SafeDownCast (vtkObjectBase *o) |
![]() | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkOpenGLRenderPass * | SafeDownCast (vtkObjectBase *o) |
static vtkInformationObjectBaseVectorKey * | RenderPasses () |
Key containing information about the current pass. More... | |
![]() | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkRenderPass * | SafeDownCast (vtkObjectBase *o) |
![]() | |
static vtkObject * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
static void | BreakOnError () |
This method is called when vtkErrorMacro executes. More... | |
static void | SetGlobalWarningDisplay (int val) |
This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
static void | GlobalWarningDisplayOn () |
This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
static void | GlobalWarningDisplayOff () |
This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
static int | GetGlobalWarningDisplay () |
This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
![]() | |
static vtkTypeBool | IsTypeOf (const char *name) |
Return 1 if this class type is the same type of (or a subclass of) the named class. More... | |
static vtkIdType | GetNumberOfGenerationsFromBaseType (const char *name) |
Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More... | |
static vtkObjectBase * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
static void | SetMemkindDirectory (const char *directoryname) |
The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More... | |
static bool | GetUsingMemkind () |
A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More... | |
Protected Member Functions | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkToneMappingPass ()=default | |
~vtkToneMappingPass () override | |
void | PreComputeAnchorCurveGenericFilmic () |
Pre compute ClippingPoint and ToeSpeed. More... | |
![]() | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkImageProcessingPass () | |
Default constructor. More... | |
~vtkImageProcessingPass () override | |
Destructor. More... | |
void | RenderDelegate (const vtkRenderState *s, int width, int height, int newWidth, int newHeight, vtkOpenGLFramebufferObject *fbo, vtkTextureObject *target) |
Render delegate with a image of different dimensions than the original one. More... | |
![]() | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkOpenGLRenderPass () | |
~vtkOpenGLRenderPass () override | |
void | PreRender (const vtkRenderState *s) |
Call before rendering to update the actors' information keys. More... | |
void | PostRender (const vtkRenderState *s) |
Call after rendering to clean up the actors' information keys. More... | |
![]() | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkRenderPass () | |
Default constructor. More... | |
~vtkRenderPass () override | |
Destructor. More... | |
void | UpdateCamera (vtkRenderer *renderer) |
Call UpdateCamera() on Renderer. More... | |
void | ClearLights (vtkRenderer *renderer) |
Call ClearLights() on Renderer. More... | |
void | UpdateLightGeometry (vtkRenderer *renderer) |
Call UpdateLightGeometry() on Renderer. More... | |
void | UpdateLights (vtkRenderer *renderer) |
Call UpdateLights() on Renderer. More... | |
void | UpdateGeometry (vtkRenderer *renderer, vtkFrameBufferObjectBase *fbo=nullptr) |
Call UpdateGeometry() on Renderer. More... | |
void | SetLastRenderingUsedDepthPeeling (vtkRenderer *renderer, bool value) |
Modify protected member LastRenderingUsedDepthPeeling on Renderer. More... | |
![]() | |
vtkObject () | |
~vtkObject () override | |
void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
void | InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr) |
These methods allow a command to exclusively grab all events. More... | |
void | InternalReleaseFocus () |
These methods allow a command to exclusively grab all events. More... | |
![]() | |
vtkObjectBase () | |
virtual | ~vtkObjectBase () |
virtual void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) |
virtual void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) |
virtual void | ReportReferences (vtkGarbageCollector *) |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
Protected Attributes | |
vtkOpenGLFramebufferObject * | FrameBufferObject = nullptr |
Graphics resources. More... | |
vtkTextureObject * | ColorTexture = nullptr |
vtkOpenGLQuadHelper * | QuadHelper = nullptr |
vtkMTimeType | PreComputeMTime = 0 |
int | ToneMappingType = GenericFilmic |
float | Exposure = 1.0 |
float | Contrast = 1.6773 |
Parameters for Generic Filmic Tonemapping. More... | |
float | Shoulder = 0.9714 |
float | MidIn = 0.18 |
float | MidOut = 0.18 |
float | HdrMax = 11.0785 |
bool | UseACES = true |
bool | UseACESChangeValue = true |
Used to recompile the shader if UseACES is modified. More... | |
float | ClippingPoint = 1.117427 |
Computed from previous parameters. More... | |
float | ToeSpeed = 0.244676 |
![]() | |
vtkRenderPass * | DelegatePass |
![]() | |
unsigned int | ActiveDrawBuffers = 0 |
![]() | |
int | NumberOfRenderedProps |
![]() | |
bool | Debug |
vtkTimeStamp | MTime |
vtkSubjectHelper * | SubjectHelper |
![]() | |
std::atomic< int32_t > | ReferenceCount |
vtkWeakPointerBase ** | WeakPointers |
Additional Inherited Members | |
![]() | |
static vtkMallocingFunction | GetCurrentMallocFunction () |
static vtkReallocingFunction | GetCurrentReallocFunction () |
static vtkFreeingFunction | GetCurrentFreeFunction () |
static vtkFreeingFunction | GetAlternateFreeFunction () |
Implement a post-processing Tone Mapping.
Tone mapping is the process of mapping HDR colors to [0;1] range. This render pass supports four different modes:
Advanced tone mapping like GenericFilmic, Reinhard or Exponential can be useful when several lights are added to the renderer.
Definition at line 87 of file vtkToneMappingPass.h.
Definition at line 91 of file vtkToneMappingPass.h.
anonymous enum |
Enumeration of tone mapping algorithms.
Enumerator | |
---|---|
Clamp | |
Reinhard | |
Exponential | |
GenericFilmic |
Definition at line 115 of file vtkToneMappingPass.h.
|
protecteddefault |
|
overrideprotected |
|
static |
|
static |
|
virtual |
Return 1 if this class is the same type of (or a subclass of) the named class.
Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkImageProcessingPass.
|
static |
|
protectedvirtual |
Reimplemented from vtkImageProcessingPass.
vtkToneMappingPass * vtkToneMappingPass::NewInstance | ( | ) | const |
|
overridevirtual |
Methods invoked by print to print information about the object including superclasses.
Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.
Reimplemented from vtkImageProcessingPass.
|
overridevirtual |
Perform rendering according to a render state.
Implements vtkRenderPass.
|
overridevirtual |
Release graphics resources and ask components to release their own resources.
Reimplemented from vtkImageProcessingPass.
void vtkToneMappingPass::SetGenericFilmicDefaultPresets | ( | ) |
Set function to set uncharted 2 presets, and default presets.
void vtkToneMappingPass::SetGenericFilmicUncharted2Presets | ( | ) |
Set function to set uncharted 2 presets, and default presets.
|
virtual |
Get/Set the tone mapping type.
Default is GenericFilmic
|
virtual |
Get/Set the tone mapping type.
Default is GenericFilmic
|
virtual |
Get/Set Exposure coefficient used for exponential and Generic Filmic tone mapping.
Default is 1.0
|
virtual |
Get/Set Exposure coefficient used for exponential and Generic Filmic tone mapping.
Default is 1.0
|
virtual |
Contrast adjust the toe of the curve.
Typically in [1-2]. Default is 1.6773
|
virtual |
Contrast adjust the toe of the curve.
Typically in [1-2]. Default is 1.6773
|
virtual |
Shoulder limit the output in the shoulder region of the curve.
Typically in [0.9-1]. Default is 0.9714
|
virtual |
Shoulder limit the output in the shoulder region of the curve.
Typically in [0.9-1]. Default is 0.9714
|
virtual |
Mid level anchor input.
Default is 0.18 (in percent gray)
|
virtual |
Mid level anchor input.
Default is 0.18 (in percent gray)
|
virtual |
Mid level anchor output.
Default is 0.18 (in percent gray)
|
virtual |
Mid level anchor output.
Default is 0.18 (in percent gray)
|
virtual |
Maximum HDR input that is not clipped.
Default is 11.0785
|
virtual |
Maximum HDR input that is not clipped.
Default is 11.0785
|
virtual |
Apply or not the Academy Color Encoding System (ACES).
Default is true
|
virtual |
Apply or not the Academy Color Encoding System (ACES).
Default is true
|
protected |
Pre compute ClippingPoint and ToeSpeed.
|
protected |
Graphics resources.
Definition at line 203 of file vtkToneMappingPass.h.
|
protected |
Definition at line 204 of file vtkToneMappingPass.h.
|
protected |
Definition at line 205 of file vtkToneMappingPass.h.
|
protected |
Definition at line 207 of file vtkToneMappingPass.h.
|
protected |
Definition at line 209 of file vtkToneMappingPass.h.
|
protected |
Definition at line 210 of file vtkToneMappingPass.h.
|
protected |
Parameters for Generic Filmic Tonemapping.
Definition at line 215 of file vtkToneMappingPass.h.
|
protected |
Definition at line 216 of file vtkToneMappingPass.h.
|
protected |
Definition at line 217 of file vtkToneMappingPass.h.
|
protected |
Definition at line 218 of file vtkToneMappingPass.h.
|
protected |
Definition at line 219 of file vtkToneMappingPass.h.
|
protected |
Definition at line 220 of file vtkToneMappingPass.h.
|
protected |
Used to recompile the shader if UseACES is modified.
Definition at line 225 of file vtkToneMappingPass.h.
|
protected |
Computed from previous parameters.
Allow to anchor the curve. Default value are for GenericFilmic default preset
Definition at line 232 of file vtkToneMappingPass.h.
|
protected |
Definition at line 233 of file vtkToneMappingPass.h.