VTK  9.0.20210119
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkToneMappingPass Class Reference

Implement a post-processing Tone Mapping. More...

#include <vtkToneMappingPass.h>

Inheritance diagram for vtkToneMappingPass:
[legend]
Collaboration diagram for vtkToneMappingPass:
[legend]

Public Types

enum  { Clamp = 0, Reinhard = 1, Exponential = 2, GenericFilmic = 3 }
 Enumeration of tone mapping algorithms. More...
 
typedef vtkImageProcessingPass Superclass
 
- Public Types inherited from vtkImageProcessingPass
typedef vtkOpenGLRenderPass Superclass
 
- Public Types inherited from vtkOpenGLRenderPass
typedef vtkRenderPass Superclass
 
- Public Types inherited from vtkRenderPass
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...
 
vtkToneMappingPassNewInstance () 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 ()
 
virtual void SetToneMappingType (int)
 Get/Set the tone mapping type. More...
 
virtual int GetToneMappingType ()
 
virtual float GetExposure ()
 Get/Set Exposure coefficient used for exponential and Generic Filmic tone mapping. More...
 
virtual void SetExposure (float)
 
virtual void SetContrast (float)
 Contrast adjust the toe of the curve. More...
 
virtual float GetContrast ()
 
virtual void SetShoulder (float)
 Shoulder limit the output in the shoulder region of the curve. More...
 
virtual float GetShoulder ()
 
virtual void SetMidIn (float)
 Mid level anchor input. More...
 
virtual float GetMidIn ()
 
virtual void SetMidOut (float)
 Mid level anchor output. More...
 
virtual float GetMidOut ()
 
virtual void SetHdrMax (float)
 Maximum HDR input that is not clipped. More...
 
virtual float GetHdrMax ()
 
virtual void SetUseACES (bool)
 Apply or not the Academy Color Encoding System (ACES). More...
 
virtual bool GetUseACES ()
 
- Public Member Functions inherited from vtkImageProcessingPass
vtkImageProcessingPassNewInstance () const
 
virtual vtkRenderPassGetDelegatePass ()
 Delegate for rendering the image to be processed. More...
 
virtual void SetDelegatePass (vtkRenderPass *delegatePass)
 
- Public Member Functions inherited from vtkOpenGLRenderPass
vtkOpenGLRenderPassNewInstance () const
 
virtual bool PreReplaceShaderValues (std::string &vertexShader, std::string &geometryShader, std::string &fragmentShader, vtkAbstractMapper *mapper, vtkProp *prop)
 Use vtkShaderProgram::Substitute to replace //VTK::XXX:YYY declarations in the shader sources. More...
 
virtual bool PostReplaceShaderValues (std::string &vertexShader, std::string &geometryShader, std::string &fragmentShader, vtkAbstractMapper *mapper, vtkProp *prop)
 Use vtkShaderProgram::Substitute to replace //VTK::XXX:YYY declarations in the shader sources. 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 ()
 
- Public Member Functions inherited from vtkRenderPass
vtkRenderPassNewInstance () const
 
virtual int GetNumberOfRenderedProps ()
 Number of props rendered at the last Render call. More...
 
- Public Member Functions inherited from vtkObject
 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. 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 PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
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...
 

Static Public Member Functions

static vtkToneMappingPassNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkToneMappingPassSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkImageProcessingPass
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkImageProcessingPassSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkOpenGLRenderPass
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkOpenGLRenderPassSafeDownCast (vtkObjectBase *o)
 
static vtkInformationObjectBaseVectorKeyRenderPasses ()
 Key containing information about the current pass. More...
 
- Static Public Member Functions inherited from vtkRenderPass
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkRenderPassSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
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 vtkObjectBaseNew ()
 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 vtkObjectBaseNewInstanceInternal () const
 
 vtkToneMappingPass ()=default
 
 ~vtkToneMappingPass () override
 
void PreComputeAnchorCurveGenericFilmic ()
 Pre compute ClippingPoint and ToeSpeed. More...
 
- Protected Member Functions inherited from vtkImageProcessingPass
 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...
 
- Protected Member Functions inherited from vtkOpenGLRenderPass
 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...
 
- Protected Member Functions inherited from vtkRenderPass
 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...
 
- Protected Member Functions inherited from vtkObject
 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 ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkOpenGLFramebufferObjectFrameBufferObject = nullptr
 Graphics resources. More...
 
vtkTextureObjectColorTexture = nullptr
 
vtkOpenGLQuadHelperQuadHelper = 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
 
- Protected Attributes inherited from vtkImageProcessingPass
vtkRenderPassDelegatePass
 
- Protected Attributes inherited from vtkOpenGLRenderPass
unsigned int ActiveDrawBuffers = 0
 
- Protected Attributes inherited from vtkRenderPass
int NumberOfRenderedProps
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Detailed Description

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.

See also
vtkRenderPass

Definition at line 48 of file vtkToneMappingPass.h.

Member Typedef Documentation

◆ Superclass

Definition at line 52 of file vtkToneMappingPass.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumeration of tone mapping algorithms.

Enumerator
Clamp 
Reinhard 
Exponential 
GenericFilmic 

Definition at line 76 of file vtkToneMappingPass.h.

Constructor & Destructor Documentation

◆ vtkToneMappingPass()

vtkToneMappingPass::vtkToneMappingPass ( )
protecteddefault

◆ ~vtkToneMappingPass()

vtkToneMappingPass::~vtkToneMappingPass ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkToneMappingPass* vtkToneMappingPass::New ( )
static

◆ IsTypeOf()

static vtkTypeBool vtkToneMappingPass::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkToneMappingPass::IsA ( const char *  name)
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.

◆ SafeDownCast()

static vtkToneMappingPass* vtkToneMappingPass::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkToneMappingPass::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkImageProcessingPass.

◆ NewInstance()

vtkToneMappingPass* vtkToneMappingPass::NewInstance ( ) const

◆ PrintSelf()

void vtkToneMappingPass::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
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.

◆ Render()

void vtkToneMappingPass::Render ( const vtkRenderState s)
overridevirtual

Perform rendering according to a render state.

Implements vtkRenderPass.

◆ ReleaseGraphicsResources()

void vtkToneMappingPass::ReleaseGraphicsResources ( vtkWindow w)
overridevirtual

Release graphics resources and ask components to release their own resources.

Reimplemented from vtkImageProcessingPass.

◆ SetGenericFilmicDefaultPresets()

void vtkToneMappingPass::SetGenericFilmicDefaultPresets ( )

Set function to set uncharted 2 presets, and default presets.

◆ SetGenericFilmicUncharted2Presets()

void vtkToneMappingPass::SetGenericFilmicUncharted2Presets ( )

◆ SetToneMappingType()

virtual void vtkToneMappingPass::SetToneMappingType ( int  )
virtual

Get/Set the tone mapping type.

Default is GenericFilmic

◆ GetToneMappingType()

virtual int vtkToneMappingPass::GetToneMappingType ( )
virtual

◆ GetExposure()

virtual float vtkToneMappingPass::GetExposure ( )
virtual

Get/Set Exposure coefficient used for exponential and Generic Filmic tone mapping.

Default is 1.0

◆ SetExposure()

virtual void vtkToneMappingPass::SetExposure ( float  )
virtual

◆ SetContrast()

virtual void vtkToneMappingPass::SetContrast ( float  )
virtual

Contrast adjust the toe of the curve.

Typically in [1-2]. Default is 1.6773

◆ GetContrast()

virtual float vtkToneMappingPass::GetContrast ( )
virtual

◆ SetShoulder()

virtual void vtkToneMappingPass::SetShoulder ( float  )
virtual

Shoulder limit the output in the shoulder region of the curve.

Typically in [0.9-1]. Default is 0.9714

◆ GetShoulder()

virtual float vtkToneMappingPass::GetShoulder ( )
virtual

◆ SetMidIn()

virtual void vtkToneMappingPass::SetMidIn ( float  )
virtual

Mid level anchor input.

Default is 0.18 (in percent gray)

◆ GetMidIn()

virtual float vtkToneMappingPass::GetMidIn ( )
virtual

◆ SetMidOut()

virtual void vtkToneMappingPass::SetMidOut ( float  )
virtual

Mid level anchor output.

Default is 0.18 (in percent gray)

◆ GetMidOut()

virtual float vtkToneMappingPass::GetMidOut ( )
virtual

◆ SetHdrMax()

virtual void vtkToneMappingPass::SetHdrMax ( float  )
virtual

Maximum HDR input that is not clipped.

Default is 11.0785

◆ GetHdrMax()

virtual float vtkToneMappingPass::GetHdrMax ( )
virtual

◆ SetUseACES()

virtual void vtkToneMappingPass::SetUseACES ( bool  )
virtual

Apply or not the Academy Color Encoding System (ACES).

Default is true

◆ GetUseACES()

virtual bool vtkToneMappingPass::GetUseACES ( )
virtual

◆ PreComputeAnchorCurveGenericFilmic()

void vtkToneMappingPass::PreComputeAnchorCurveGenericFilmic ( )
protected

Pre compute ClippingPoint and ToeSpeed.

Member Data Documentation

◆ FrameBufferObject

vtkOpenGLFramebufferObject* vtkToneMappingPass::FrameBufferObject = nullptr
protected

Graphics resources.

Definition at line 164 of file vtkToneMappingPass.h.

◆ ColorTexture

vtkTextureObject* vtkToneMappingPass::ColorTexture = nullptr
protected

Definition at line 165 of file vtkToneMappingPass.h.

◆ QuadHelper

vtkOpenGLQuadHelper* vtkToneMappingPass::QuadHelper = nullptr
protected

Definition at line 166 of file vtkToneMappingPass.h.

◆ PreComputeMTime

vtkMTimeType vtkToneMappingPass::PreComputeMTime = 0
protected

Definition at line 168 of file vtkToneMappingPass.h.

◆ ToneMappingType

int vtkToneMappingPass::ToneMappingType = GenericFilmic
protected

Definition at line 170 of file vtkToneMappingPass.h.

◆ Exposure

float vtkToneMappingPass::Exposure = 1.0
protected

Definition at line 171 of file vtkToneMappingPass.h.

◆ Contrast

float vtkToneMappingPass::Contrast = 1.6773
protected

Parameters for Generic Filmic Tonemapping.

Definition at line 176 of file vtkToneMappingPass.h.

◆ Shoulder

float vtkToneMappingPass::Shoulder = 0.9714
protected

Definition at line 177 of file vtkToneMappingPass.h.

◆ MidIn

float vtkToneMappingPass::MidIn = 0.18
protected

Definition at line 178 of file vtkToneMappingPass.h.

◆ MidOut

float vtkToneMappingPass::MidOut = 0.18
protected

Definition at line 179 of file vtkToneMappingPass.h.

◆ HdrMax

float vtkToneMappingPass::HdrMax = 11.0785
protected

Definition at line 180 of file vtkToneMappingPass.h.

◆ UseACES

bool vtkToneMappingPass::UseACES = true
protected

Definition at line 181 of file vtkToneMappingPass.h.

◆ UseACESChangeValue

bool vtkToneMappingPass::UseACESChangeValue = true
protected

Used to recompile the shader if UseACES is modified.

Definition at line 186 of file vtkToneMappingPass.h.

◆ ClippingPoint

float vtkToneMappingPass::ClippingPoint = 1.117427
protected

Computed from previous parameters.

Allow to anchor the curve. Default value are for GenericFilmic default preset

Definition at line 193 of file vtkToneMappingPass.h.

◆ ToeSpeed

float vtkToneMappingPass::ToeSpeed = 0.244676
protected

Definition at line 194 of file vtkToneMappingPass.h.


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