Viewport Setting For The Nitrous Graphics Viewport. More...

#include <IViewportViewSetting2.h>

Inheritance diagram for IViewportViewSetting2:

Public Member Functions
virtual void	SetBloomEnabled (bool bEnabled)=0
	Enable/Disable the Bloom effect in a viewport, bloom effect is a per viewport setting. More...

virtual bool	GetBloomEnabled () const =0
	Get the enabled state of Bloom effect. More...

virtual void	SetBloomTintColor (Point3 c)=0
	Set Bloom tint color , using a Point3 instead of Color because we want float components for r,g,b, there is no limit to this parameter. More...

virtual Point3	GetBloomTintColor () const =0
	Get the Bloom tint color, using a Point3 instead of Color because we want float components for r,g,b. More...

virtual void	SetBloomTintContribution (float tintContrib)=0
	Set Bloom tint contribution (multiplier applied on the tint color), there is no limit to this parameter, it can also be negative. More...

virtual float	GetBloomTintContribution () const =0
	Get the Bloom tint contribution (multiplier applied on the tint color) More...

virtual void	SetBloomThreshold (float threshold)=0
	Set Bloom Threshold, there is no limit to this parameter, values can also be negative. More...

virtual float	GetBloomThreshold () const =0
	Get the Bloom Threshold. More...

virtual void	SetBloomThresholdSmoothing (float smoothWidth)=0
	Set Bloom ThresholdSmoothing, is the size of the window to smooth the threshold with a smoothstep function with float brightness = smoothstep(Threshold, Threshold + ThresholdSmoothing, pixelLuminance) Doing this smoothstep reduces flickering of the Bloom effect There is no limit to this parameter. More...

virtual float	GetBloomThresholdSmoothing () const =0
	Get the Bloom ThresholdSmoothing, is the size of the window to smooth the threshold with a smoothstep function with float brightness = smoothstep(Threshold, Threshold + ThresholdSmoothing, pixelLuminance) More...

virtual void	SetBloomStrength (float strength)=0
	Set Bloom Strength (multiplier on the Bloom effect), there is no limit to this parameter, it can also be negative. More...

virtual float	GetBloomStrength () const =0
	Get the Bloom Strength (multiplier on the Bloom effect) More...

virtual void	SetBloomRadius (int numMipmaps)=0
	Set Bloom Radius, is the number of mipmaps (smaller sub-textures) used to create the blur effect, the more mipmaps there is, the larger and smoother is the effect. More...

virtual int	GetBloomRadius () const =0
	Get the Bloom Radius, is the number of mipmaps (smaller sub-textures) used to create the blur effect, the more mipmaps there is, the larger and smoother is the effect. More...

virtual void	SetBloomQuality (BloomQuality quality)=0
	Set Bloom quality as a BloomQuality enum. More...

virtual BloomQuality	GetBloomQuality () const =0
	Get the Bloom quality as an enum. More...

virtual void	SetBloomDirtMapEnabled (bool bEnabled)=0
	Enable/Disable the Bloom dirt map. More...

virtual bool	GetBloomDirtMapEnabled () const =0
	Get the enabled state of Bloom dirt map. More...

virtual void	SetBloomDirtMapImage (const TSTR &imageFilename)=0
	Set Bloom dirt map as an image filename (is an image blended with the Bloom effect, also called Lens Schmutz) More...

virtual const TSTR &	GetBloomDirtMapImage () const =0
	Get Bloom dirt map as an image filename This will return the string for the bitmap that was set from the UI or by Maxscript, which could be a relative or full path filename. More...

virtual const TSTR &	GetBloomDirtMapImageCachedFullPathFileName () const =0
	Get Bloom dirt map as an image full path filename This will return the full path filename of the bitmap or "" if the bitmap doesn't exist on this machine or hasn't been set The result is cached in a local string so the resolution of any relative filename is not done for every call. More...

virtual void	SetBloomDirtContribution (float dirtContrib)=0
	Set Bloom dirt map contribution (multiplier applied on the dirt map) There is no limit to this parameter. More...

virtual float	GetBloomDirtContribution () const =0
	Get Bloom dirt map contribution (multiplier applied on the dirt map) More...

virtual bool	GetBloomApplyOnBackground () const =0
	Get if Bloom is applied on the background or not. More...

virtual void	SetBloomApplyOnBackground (bool val)=0
	Set if Bloom is applied on the background or not. More...

virtual bool	GetBloomShowBloomPass () const =0
	Get, if instead of the resulting color buffer with bloom applied, we want to display only the bloom pass (w/o the dirt map applied) If GetBloomShowFilterPass() is true or GetBloomShowRadiusPassNumber() is not -1 then SetBloomShowBloomPass is ignored, as the 2 previously mentioned parameters will overwrite GetBloomShowBloomPass. More...

virtual void	SetBloomShowBloomPass (bool val)=0
	Set, if instead of the resulting color buffer with bloom applied, we want to display only the bloom pass (w/o the dirt map applied) If GetBloomShowFilterPass() is true or GetBloomShowRadiusPassNumber() is not -1 then SetBloomShowBloomPass is ignored, as the 2 previously mentioned parameters will overwrite GetBloomShowBloomPass. More...

virtual bool	GetBloomShowFilterPass () const =0
	Get, if instead of the resulting color buffer with bloom applied, we want to display only the filtering pass If GetBloomShowRadiusPassNumber() is not -1 then SetBloomShowFilterPass is ignored, as the previously mentioned parameter will overwrite SetBloomShowFilterPass. More...

virtual void	SetBloomShowFilterPass (bool val)=0
	Set, if instead of the resulting color buffer with bloom applied, we want to display only the filtering pass If GetBloomShowRadiusPassNumber() is not -1 then SetBloomShowFilterPass is ignored, as the previously mentioned parameter will overwrite SetBloomShowFilterPass. More...

virtual int	GetBloomShowRadiusPassNumber () const =0
	Get, if instead of the resulting color buffer with bloom applied, we want to display only the n-th radius pass (mipmap sub-texture). More...

virtual void	SetBloomShowRadiusPassNumber (int val)=0
	Set, if instead of the resulting color buffer with bloom applied, we want to display only the n-th radius pass (mipmap sub-texture). More...

Public Member Functions inherited from IViewportViewSetting
virtual void	SetProgressiveRenderingEnabled (bool enabled)=0
	Enable/Disable progressive rendering. More...

virtual bool	GetProgressiveRenderingEnabled () const =0
	Get the enable state of progressive rendering. More...

virtual void	SetShowEdgedFaces (bool bShowEdgeFaces)=0
	Enable/Disable show edged faces. More...

virtual bool	GetShowEdgedFaces () const =0
	Get the state of showing edged faces. More...

virtual void	SetUseTexture (bool bUseTexture)=0
	Enable/Disable use texture. More...

virtual bool	GetUseTexture () const =0
	Get the state of 'use texture'. More...

virtual void	SetSelectedEdgedFaces (bool bSelEdgedFaces)=0
	Enable/Disable display selected with edged faces. More...

virtual bool	GetSelectedEdgedFaces () const =0
	Get the state of 'display selected with edged faces'. More...

virtual void	SetShowSelectionBrackets (bool bShowSelectionBrackets)=0
	Enable/Disable use selection brackets. More...

virtual bool	GetShowSelectionBrackets () const =0
	Get the state of show selection brackets. More...

virtual void	SetShadeSelectedFaces (bool bShadeSelFaces)=0
	Enable/Disable shade selected faces. More...

virtual bool	GetShadeSelectedFaces () const =0
	Get the state of shade selected edged faces. More...

virtual void	SetViewportDisable (bool bViewportDisable)=0
	Set true to disable viewport or false otherwise. More...

virtual bool	GetViewportDisable () const =0
	Get the state of viewport disable. More...

virtual void	SetViewportClipping (bool bVptClipping)=0
	Enable/Disable viewport clipping. More...

virtual bool	GetViewportClipping () const =0
	Get the state of viewport clipping. More...

virtual void	SetUseEnvironmentBackgroundColor (bool bUseEnvColor)=0
	Enable/Disable use environment background color. More...

virtual bool	GetUseEnvironmentBackgroundColor () const =0
	Get the state of use environment background color. More...

virtual void	SetUseViewportBackground (bool bValue)=0
	Enable/Disable use viewport background. More...

virtual bool	GetUseViewportBackground () const =0
	Get the state of use viewport background. More...

virtual void	SetShowHighLight (bool bShowHighLight)=0
	Enable/Disable show highlight. More...

virtual bool	GetShowHighlight () const =0
	Get the state of show highlight. More...

virtual void	SetViewportVisualStyle (VisualStyle visualStyle)=0
	Set the current view style. More...

virtual VisualStyle	GetViewportVisualStyle () const =0
	Get the viewport visual style of current viewport. More...

virtual void	SetShadeSelectedObjects (bool bShadeSelObj)=0
	Enable/Disable shade selected objects. More...

virtual bool	GetShadeSelectedObjects () const =0
	Get the state of shade selected objects. More...

virtual void	SetAutoDisplaySelectedLight (bool bAutoDisSelLight)=0
	Enable/Disable auto display selected light. More...

virtual bool	GetAutoDisplaySelectedLight () const =0
	Get the state of auto display selected light. More...

virtual void	SetAmbientOcclusionEnabled (bool bAmbientOcclusionEnabled)=0
	Enable/Disable ambient occlusion. More...

virtual bool	GetAmbientOcclusionEnabled () const =0
	Get the enabled state of ambient occlusion. More...

virtual void	SetShadowsEnabled (bool bShadowsEnabled)=0
	Enable/Disable shadow. More...

virtual bool	GetShadowsEnabled () const =0
	Get the state of display shadow. More...

virtual void	SetAdaptiveDegradeAlwaysDegradeLights (bool bDegradeLights)=0
	Enable/Disable degrade to default lights. More...

virtual bool	GetAdaptiveDegradeAlwaysDegradeLights () const =0
	Get the state of degrade to default lights. More...

virtual void	SetAdaptiveDegradeDrawBackfaces (bool bDrawBackfaces)=0
	Enable/Disable draw back faces for wireframe mesh in adaptive degradation. More...

virtual bool	GetAdaptiveDegradeDrawBackfaces () const =0
	Get the state of draw backfaces. More...

virtual void	SetAdaptiveDegradeNeverDegradeGeometry (bool bNeverDegradeGeometry)=0
	Set true to never degrade geometry or false otherwise. More...

virtual bool	GetAdaptiveDegradeNeverDegradeGeometry () const =0
	Get the state of never degrade geometry. More...

Public Member Functions inherited from FPMixinInterface
	FPMixinInterface ()

virtual LifetimeType	LifetimeControl ()

virtual CoreExport bool	RegisterNotifyCallback (InterfaceNotifyCallback *incb)

virtual void	UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)

CoreExport	~FPMixinInterface ()

virtual BaseInterface *	GetInterface (Interface_ID id)

virtual FPInterfaceDesc *	GetDescByID (Interface_ID id)

virtual Interface_ID	GetID ()

Public Member Functions inherited from FPInterface
virtual FPInterfaceDesc *	GetDesc ()=0

virtual CoreExport FPStatus	Invoke (FunctionID fid, TimeValue t=0, FPParams *params=NULL)

virtual FPStatus	Invoke (FunctionID fid, FPParams *params)

virtual CoreExport FPStatus	Invoke (FunctionID fid, TimeValue t, FPValue &result, FPParams *params=NULL)

virtual FPStatus	Invoke (FunctionID fid, FPValue &result, FPParams *params=NULL)

virtual CoreExport FunctionID	FindFn (const MCHAR *name)

virtual CoreExport BOOL	IsEnabled (FunctionID actionID)

virtual CoreExport BOOL	IsChecked (FunctionID actionID)

virtual CoreExport BOOL	IsVisible (FunctionID actionID)

virtual CoreExport FunctionID	GetIsEnabled (FunctionID actionID)

virtual CoreExport FunctionID	GetIsChecked (FunctionID actionID)

virtual CoreExport FunctionID	GetIsVisible (FunctionID actionID)

virtual ActionTable *	GetActionTable ()

virtual void	EnableActions (BOOL onOff)

Public Member Functions inherited from BaseInterface
virtual UtilExport	~BaseInterface ()
	Destructor. More...

virtual BaseInterface *	AcquireInterface ()

virtual void	ReleaseInterface ()

virtual void	DeleteInterface ()

virtual BaseInterface *	CloneInterface (void *remapDir=NULL)

Public Member Functions inherited from InterfaceServer
virtual UtilExport	~InterfaceServer ()
	Destructor. More...

template<class InterfaceType >
InterfaceType *	GetTypedInterface ()

Additional Inherited Members
Public Types inherited from BaseInterface
enum	LifetimeType { noRelease , immediateRelease , wantsRelease , serverControlled }

Static Public Member Functions inherited from MaxHeapOperators
static UtilExport void *	operator new (size_t size)
	Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new (size_t size, const std::nothrow_t &e)
	Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned. More...

static UtilExport void *	operator new (size_t size, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned. More...

static UtilExport void *	operator new (size_t size, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned. More...

static UtilExport void *	operator new[] (size_t size)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...

static UtilExport void *	operator new[] (size_t size, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects. More...

static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...

static UtilExport void *	operator new[] (size_t size, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...

static UtilExport void	operator delete (void *ptr)
	Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen. More...

static UtilExport void	operator delete (void ptr, const char filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete (void ptr, int block_type, const char filename, int line)
	Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete (void ptr, const std::nothrow_t &e, const char filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...

static UtilExport void	operator delete (void *ptr, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen. More...

static UtilExport void	operator delete[] (void *ptr)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen. More...

static UtilExport void	operator delete[] (void ptr, const char filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete[] (void ptr, int block_type, const char filename, int line)
	Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete[] (void ptr, const std::nothrow_t &e, const char filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...

static UtilExport void	operator delete[] (void *ptr, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...

static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator. More...

static UtilExport void	operator delete (void ptr, void placement_ptr)
	Placement delete operator. More...

static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary. More...

static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary. More...

static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc. More...

Static Public Attributes inherited from FPInterface
static CoreExport FPInterfaceDesc	nullInterface

Protected Member Functions inherited from IViewportViewSetting
virtual	~IViewportViewSetting ()

Protected Member Functions inherited from FPMixinInterface
	FPMixinInterface (const FPMixinInterface &rhs)

FPMixinInterface &	operator= (const FPMixinInterface &rhs)

Protected Member Functions inherited from FPInterface
virtual FPStatus	_dispatch_fn (FunctionID fid, TimeValue t, FPValue &result, FPParams *p)

Protected Attributes inherited from FPMixinInterface
Tab< InterfaceNotifyCallback * > *	interfaceNotifyCBs

Detailed Description

Viewport Setting For The Nitrous Graphics Viewport.

Note: To access this interface from a ViewExp object, please call ViewExp::GetInterface(IVIEWPORT_SETTINGS_2_INTERFACE_ID).

Member Function Documentation

◆ SetBloomEnabled()

virtual void SetBloomEnabled ( bool bEnabled )

pure virtual

Enable/Disable the Bloom effect in a viewport, bloom effect is a per viewport setting.

◆ GetBloomEnabled()

virtual bool GetBloomEnabled ( ) const

pure virtual

Get the enabled state of Bloom effect.

Returns: true if Bloom is enabled or false otherwise

◆ SetBloomTintColor()

virtual void SetBloomTintColor ( Point3 c )

pure virtual

Set Bloom tint color , using a Point3 instead of Color because we want float components for r,g,b, there is no limit to this parameter.

◆ GetBloomTintColor()

virtual Point3 GetBloomTintColor ( ) const

pure virtual

Get the Bloom tint color, using a Point3 instead of Color because we want float components for r,g,b.

◆ SetBloomTintContribution()

virtual void SetBloomTintContribution ( float tintContrib )

pure virtual

Set Bloom tint contribution (multiplier applied on the tint color), there is no limit to this parameter, it can also be negative.

◆ GetBloomTintContribution()

virtual float GetBloomTintContribution ( ) const

pure virtual

Get the Bloom tint contribution (multiplier applied on the tint color)

◆ SetBloomThreshold()

virtual void SetBloomThreshold ( float threshold )

pure virtual

Set Bloom Threshold, there is no limit to this parameter, values can also be negative.

◆ GetBloomThreshold()

virtual float GetBloomThreshold ( ) const

pure virtual

Get the Bloom Threshold.

◆ SetBloomThresholdSmoothing()

virtual void SetBloomThresholdSmoothing ( float smoothWidth )

pure virtual

Set Bloom ThresholdSmoothing, is the size of the window to smooth the threshold with a smoothstep function with float brightness = smoothstep(Threshold, Threshold + ThresholdSmoothing, pixelLuminance) Doing this smoothstep reduces flickering of the Bloom effect There is no limit to this parameter.

◆ GetBloomThresholdSmoothing()

virtual float GetBloomThresholdSmoothing ( ) const

pure virtual

Get the Bloom ThresholdSmoothing, is the size of the window to smooth the threshold with a smoothstep function with float brightness = smoothstep(Threshold, Threshold + ThresholdSmoothing, pixelLuminance)

◆ SetBloomStrength()

virtual void SetBloomStrength ( float strength )

pure virtual

Set Bloom Strength (multiplier on the Bloom effect), there is no limit to this parameter, it can also be negative.

◆ GetBloomStrength()

virtual float GetBloomStrength ( ) const

pure virtual

Get the Bloom Strength (multiplier on the Bloom effect)

◆ SetBloomRadius()

virtual void SetBloomRadius ( int numMipmaps )

pure virtual

Set Bloom Radius, is the number of mipmaps (smaller sub-textures) used to create the blur effect, the more mipmaps there is, the larger and smoother is the effect.

This parameter should be greater than 1 and for the mipmap #n it has a size of your viewport size divided by 2 at the power n, so usually 10 is a visual limit as it fills all your viewport

◆ GetBloomRadius()

virtual int GetBloomRadius ( ) const

pure virtual

Get the Bloom Radius, is the number of mipmaps (smaller sub-textures) used to create the blur effect, the more mipmaps there is, the larger and smoother is the effect.

◆ SetBloomQuality()

virtual void SetBloomQuality ( BloomQuality quality )

pure virtual

Set Bloom quality as a BloomQuality enum.

◆ GetBloomQuality()

virtual BloomQuality GetBloomQuality ( ) const

pure virtual

Get the Bloom quality as an enum.

◆ SetBloomDirtMapEnabled()

virtual void SetBloomDirtMapEnabled ( bool bEnabled )

pure virtual

Enable/Disable the Bloom dirt map.

◆ GetBloomDirtMapEnabled()

virtual bool GetBloomDirtMapEnabled ( ) const

pure virtual

Get the enabled state of Bloom dirt map.

Returns: true if Bloom dirt map is enabled or false otherwise

◆ SetBloomDirtMapImage()

virtual void SetBloomDirtMapImage ( const TSTR & imageFilename )

pure virtual

Set Bloom dirt map as an image filename (is an image blended with the Bloom effect, also called Lens Schmutz)

◆ GetBloomDirtMapImage()

virtual const TSTR& GetBloomDirtMapImage ( ) const

pure virtual

Get Bloom dirt map as an image filename This will return the string for the bitmap that was set from the UI or by Maxscript, which could be a relative or full path filename.

We use the asset manager to try to resolve the path if it is relative.

◆ GetBloomDirtMapImageCachedFullPathFileName()

virtual const TSTR& GetBloomDirtMapImageCachedFullPathFileName ( ) const

pure virtual

Get Bloom dirt map as an image full path filename This will return the full path filename of the bitmap or "" if the bitmap doesn't exist on this machine or hasn't been set The result is cached in a local string so the resolution of any relative filename is not done for every call.

◆ SetBloomDirtContribution()

virtual void SetBloomDirtContribution ( float dirtContrib )

pure virtual

Set Bloom dirt map contribution (multiplier applied on the dirt map) There is no limit to this parameter.

◆ GetBloomDirtContribution()

virtual float GetBloomDirtContribution ( ) const

pure virtual

Get Bloom dirt map contribution (multiplier applied on the dirt map)

◆ GetBloomApplyOnBackground()

virtual bool GetBloomApplyOnBackground ( ) const

pure virtual

Get if Bloom is applied on the background or not.

◆ SetBloomApplyOnBackground()

virtual void SetBloomApplyOnBackground ( bool val )

pure virtual

Set if Bloom is applied on the background or not.

◆ GetBloomShowBloomPass()

virtual bool GetBloomShowBloomPass ( ) const

pure virtual

Get, if instead of the resulting color buffer with bloom applied, we want to display only the bloom pass (w/o the dirt map applied) If GetBloomShowFilterPass() is true or GetBloomShowRadiusPassNumber() is not -1 then SetBloomShowBloomPass is ignored, as the 2 previously mentioned parameters will overwrite GetBloomShowBloomPass.

◆ SetBloomShowBloomPass()

virtual void SetBloomShowBloomPass ( bool val )

pure virtual

Set, if instead of the resulting color buffer with bloom applied, we want to display only the bloom pass (w/o the dirt map applied) If GetBloomShowFilterPass() is true or GetBloomShowRadiusPassNumber() is not -1 then SetBloomShowBloomPass is ignored, as the 2 previously mentioned parameters will overwrite GetBloomShowBloomPass.

◆ GetBloomShowFilterPass()

virtual bool GetBloomShowFilterPass ( ) const

pure virtual

Get, if instead of the resulting color buffer with bloom applied, we want to display only the filtering pass If GetBloomShowRadiusPassNumber() is not -1 then SetBloomShowFilterPass is ignored, as the previously mentioned parameter will overwrite SetBloomShowFilterPass.

◆ SetBloomShowFilterPass()

virtual void SetBloomShowFilterPass ( bool val )

pure virtual

Set, if instead of the resulting color buffer with bloom applied, we want to display only the filtering pass If GetBloomShowRadiusPassNumber() is not -1 then SetBloomShowFilterPass is ignored, as the previously mentioned parameter will overwrite SetBloomShowFilterPass.

◆ GetBloomShowRadiusPassNumber()

virtual int GetBloomShowRadiusPassNumber ( ) const

pure virtual

Get, if instead of the resulting color buffer with bloom applied, we want to display only the n-th radius pass (mipmap sub-texture).

A value of -1 means we show the result and not any of these radius passes, if the value is greater than GetBloomRadius() then this is ignored.

◆ SetBloomShowRadiusPassNumber()

virtual void SetBloomShowRadiusPassNumber ( int val )

pure virtual

Set, if instead of the resulting color buffer with bloom applied, we want to display only the n-th radius pass (mipmap sub-texture).

A value of -1 means we show the result and not any of these radius passes, if the value is greater than GetBloomRadius() then this is ignored.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ SetBloomEnabled()

◆ GetBloomEnabled()

◆ SetBloomTintColor()

◆ GetBloomTintColor()

◆ SetBloomTintContribution()

◆ GetBloomTintContribution()

◆ SetBloomThreshold()

◆ GetBloomThreshold()

◆ SetBloomThresholdSmoothing()

◆ GetBloomThresholdSmoothing()

◆ SetBloomStrength()

◆ GetBloomStrength()

◆ SetBloomRadius()

◆ GetBloomRadius()

◆ SetBloomQuality()

◆ GetBloomQuality()

◆ SetBloomDirtMapEnabled()

◆ GetBloomDirtMapEnabled()

◆ SetBloomDirtMapImage()

◆ GetBloomDirtMapImage()

◆ GetBloomDirtMapImageCachedFullPathFileName()

◆ SetBloomDirtContribution()

◆ GetBloomDirtContribution()

◆ GetBloomApplyOnBackground()

◆ SetBloomApplyOnBackground()

◆ GetBloomShowBloomPass()

◆ SetBloomShowBloomPass()

◆ GetBloomShowFilterPass()

◆ SetBloomShowFilterPass()

◆ GetBloomShowRadiusPassNumber()

◆ SetBloomShowRadiusPassNumber()