G3D::FilmSettings Class Reference

More...

Public Member Functions
	FilmSettings ()
	FilmSettings (const Any &any)
bool	antialiasingEnabled () const
float	antialiasingFilterRadius () const
bool	antialiasingHighQuality () const
float	bloomRadiusFraction () const
	Bloom filter kernel radius as a fraction of the larger of image width/height. More...
float	bloomStrength () const
	0 = no bloom, 1 = blurred out image. More...
int	debugZoom () const
	If > 1, enlarge pixels by this amount relative to the center of the screen for aid in debugging. More...
bool	diskFramebuffer () const
	If true, only compute post-processing within a disk, for VR headsets. More...
ResampleFilter	downscaleFilter () const
bool	effectsEnabled () const
	If false, skips all processing and just blits to the output. More...
void	extendGBufferSpecification (GBuffer::Specification &spec) const
	Ensures the GBuffer specification has all the fields needed to render this effect More...
float	gamma () const
	Monitor gamma used in tone-mapping. More...
bool	invertX () const
	For use when targeting optically-inverted displays such as rear projectors, or other special cases. More...
bool	invertY () const
	For use when targeting optically-inverted displays or other special cases. More...
void	makeGui (class GuiPane *, float maxSensitivity=10.0f, float sliderWidth=180, float controlIndent=0.0f)
	Adds controls for these settings to the specified GuiPane. More...
float	sensitivity () const
	Scale factor applied to the pixel values during exposeAndRender() More...
void	setAntialiasingEnabled (bool e)
	Enabled screen-space antialiasing post-processing. More...
void	setAntialiasingFilterRadius (float f)
	0 = FXAA within a pixel. More...
void	setAntialiasingHighQuality (bool b)
void	setBloomRadiusFraction (float f)
void	setBloomStrength (float s)
void	setBurnoutToneCurve ()
void	setCelluloidToneCurve ()
void	setContrastToneCurve ()
void	setDebugZoom (int z)
void	setDiskFramebuffer (bool b)
void	setDownscaleFilter (ResampleFilter f)
void	setEffectsEnabled (bool b)
void	setGamma (float g)
void	setIdentityToneCurve ()
void	setInvertX (bool b)
void	setInvertY (bool b)
void	setNegativeToneCurve ()
void	setSaturateToneCurve ()
void	setSensitivity (float s)
void	setSuperboostToneCurve ()
void	setTemporalAntialiasingEnabled (bool b)
void	setUpscaleFilter (ResampleFilter f)
void	setVignetteBottomStrength (float s)
void	setVignetteSizeFraction (float s)
void	setVignetteTopStrength (float s)
bool	temporalAntialiasingEnabled () const
Any	toAny () const
const Spline< float > &	toneCurve () const
ResampleFilter	upscaleFilter () const
float	vignetteBottomStrength () const
	Amount of darkness due to vignetting for the bottom of the screen, on the range [0, 1]. More...
float	vignetteSizeFraction () const
	Fraction of the diagonal radius of the screen covered by vignette, on the range [0, 1]. More...
float	vignetteTopStrength () const
	Amount of darkness due to vignetting for the top of the screen, on the range [0, 1]. More...

Detailed Description

See also

G3D::Film, G3D::Camera

Constructor & Destructor Documentation

FilmSettings() [1/2]

G3D::FilmSettings::FilmSettings

(

)

FilmSettings() [2/2]

G3D::FilmSettings::FilmSettings

(

const Any &

any

)

FilmSettings {
  gamma = <number>;
  sensitivity = <number>;
  bloomStrength = <number>;
  bloomRadiusFraction = <number>;
  temporalAntialiasingEnabled = <boolean>;
  antialiasingEnabled = <boolean>;
  antialiasingFilterRadius = <number>;
  antialiasingHighQuality = <boolean>;
  vignetteTopStrength = <number>;
  vignetteBottomStrength = <number>;
  vignetteSizeFraction = <number>;
  toneCurve = IDENTITY | CONTRAST | CELLULOID | SUPERBOOST | SATURATE | BURNOUT | NEGATIVE | spline;
  debugZoom = <number>;
  effectsEnabled = <boolean>;
  invertX = <boolean>;
  invertY = <boolean>;
  upscaleFilter = NEAREST | BILINEAR | BICUBIC | BICUBIC_SHARPER;
  downscaleFilter = NEAREST | BILINEAR | BICUBIC | BICUBIC_SHARPER;
}

Member Function Documentation

antialiasingEnabled()

bool G3D::FilmSettings::antialiasingEnabled ( ) const

inline

antialiasingFilterRadius()

float G3D::FilmSettings::antialiasingFilterRadius ( ) const

inline

antialiasingHighQuality()

bool G3D::FilmSettings::antialiasingHighQuality ( ) const

inline

bloomRadiusFraction()

float G3D::FilmSettings::bloomRadiusFraction ( ) const

inline

Bloom filter kernel radius as a fraction of the larger of image width/height.

bloomStrength()

float G3D::FilmSettings::bloomStrength ( ) const

inline

0 = no bloom, 1 = blurred out image.

debugZoom()

int G3D::FilmSettings::debugZoom ( ) const

inline

If > 1, enlarge pixels by this amount relative to the center of the screen for aid in debugging.

Enabling debugZoom may compromise performance.

diskFramebuffer()

bool G3D::FilmSettings::diskFramebuffer ( ) const

inline

If true, only compute post-processing within a disk, for VR headsets.

The exact disk radius is different for each framebuffer within the Film stack pass and has been tuned to look good on all VR headsets.

This parameter must be set at runtime. It is not persisted to any files.

downscaleFilter()

ResampleFilter G3D::FilmSettings::downscaleFilter ( ) const

inline

effectsEnabled()

bool G3D::FilmSettings::effectsEnabled ( ) const

inline

If false, skips all processing and just blits to the output.

extendGBufferSpecification()

void G3D::FilmSettings::extendGBufferSpecification

(

GBuffer::Specification &

spec

)

const

Ensures the GBuffer specification has all the fields needed to render this effect

See also

GApp::extendGBufferSpecification

gamma()

float G3D::FilmSettings::gamma ( ) const

inline

Monitor gamma used in tone-mapping.

Default is 2.0.

invertX()

bool G3D::FilmSettings::invertX ( ) const

inline

For use when targeting optically-inverted displays such as rear projectors, or other special cases.

invertY()

bool G3D::FilmSettings::invertY ( ) const

inline

For use when targeting optically-inverted displays or other special cases.

makeGui()

void G3D::FilmSettings::makeGui	(	class GuiPane *	,
		float	maxSensitivity = 10.0f,
		float	sliderWidth = 180,
		float	controlIndent = 0.0f
	)

Adds controls for these settings to the specified GuiPane.

sensitivity()

float G3D::FilmSettings::sensitivity ( ) const

inline

Scale factor applied to the pixel values during exposeAndRender()

setAntialiasingEnabled()

void G3D::FilmSettings::setAntialiasingEnabled ( bool  e )

inline

Enabled screen-space antialiasing post-processing.

This reduces the artifacts from undersampling edges but may blur textures. By default, this is disabled.

The antialiasing algorithm is "FXAA 13", which is a modified version of Timothy Lottes' FXAA 11 and 12 algorithms.

setAntialiasingFilterRadius()

void G3D::FilmSettings::setAntialiasingFilterRadius ( float  f )

inline

0 = FXAA within a pixel.

Any larger value blurs taps that are separated from the center by f pixels

setAntialiasingHighQuality()

void G3D::FilmSettings::setAntialiasingHighQuality ( bool  b )

inline

setBloomRadiusFraction()

void G3D::FilmSettings::setBloomRadiusFraction ( float  f )

inline

setBloomStrength()

void G3D::FilmSettings::setBloomStrength ( float  s )

inline

setBurnoutToneCurve()

void G3D::FilmSettings::setBurnoutToneCurve

(

)

setCelluloidToneCurve()

void G3D::FilmSettings::setCelluloidToneCurve

(

)

setContrastToneCurve()

void G3D::FilmSettings::setContrastToneCurve

(

)

setDebugZoom()

void G3D::FilmSettings::setDebugZoom ( int  z )

inline

setDiskFramebuffer()

void G3D::FilmSettings::setDiskFramebuffer ( bool  b )

inline

See also

diskFramebuffer

setDownscaleFilter()

void G3D::FilmSettings::setDownscaleFilter ( ResampleFilter  f )

inline

setEffectsEnabled()

void G3D::FilmSettings::setEffectsEnabled ( bool  b )

inline

setGamma()

void G3D::FilmSettings::setGamma ( float  g )

inline

setIdentityToneCurve()

void G3D::FilmSettings::setIdentityToneCurve

(

)

setInvertX()

void G3D::FilmSettings::setInvertX ( bool  b )

inline

setInvertY()

void G3D::FilmSettings::setInvertY ( bool  b )

inline

setNegativeToneCurve()

void G3D::FilmSettings::setNegativeToneCurve

(

)

setSaturateToneCurve()

void G3D::FilmSettings::setSaturateToneCurve

(

)

setSensitivity()

void G3D::FilmSettings::setSensitivity ( float  s )

inline

setSuperboostToneCurve()

void G3D::FilmSettings::setSuperboostToneCurve

(

)

setTemporalAntialiasingEnabled()

void G3D::FilmSettings::setTemporalAntialiasingEnabled ( bool  b )

inline

setUpscaleFilter()

void G3D::FilmSettings::setUpscaleFilter ( ResampleFilter  f )

inline

setVignetteBottomStrength()

void G3D::FilmSettings::setVignetteBottomStrength ( float  s )

inline

setVignetteSizeFraction()

void G3D::FilmSettings::setVignetteSizeFraction ( float  s )

inline

setVignetteTopStrength()

void G3D::FilmSettings::setVignetteTopStrength ( float  s )

inline

temporalAntialiasingEnabled()

bool G3D::FilmSettings::temporalAntialiasingEnabled ( ) const

inline

toAny()

Any G3D::FilmSettings::toAny

(

)

const

toneCurve()

const Spline<float>& G3D::FilmSettings::toneCurve ( ) const

inline

upscaleFilter()

ResampleFilter G3D::FilmSettings::upscaleFilter ( ) const

inline

vignetteBottomStrength()

float G3D::FilmSettings::vignetteBottomStrength ( ) const

inline

Amount of darkness due to vignetting for the bottom of the screen, on the range [0, 1].

vignetteSizeFraction()

float G3D::FilmSettings::vignetteSizeFraction ( ) const

inline

Fraction of the diagonal radius of the screen covered by vignette, on the range [0, 1].

vignetteTopStrength()

float G3D::FilmSettings::vignetteTopStrength ( ) const

inline

Amount of darkness due to vignetting for the top of the screen, on the range [0, 1].