Ignition Rendering

API Reference

6.3.1
GaussianNoisePass Class Referenceabstract

A render pass that applies Gaussian noise to the render target. More...

#include <GaussianNoisePass.hh>

Public Member Functions

 GaussianNoisePass ()
 Constructor. More...
 
virtual ~GaussianNoisePass ()
 Destructor. More...
 
virtual double Bias () const =0
 Accessor for bias. More...
 
virtual double Mean () const =0
 Accessor for mean. More...
 
virtual void SetBiasMean (double _biasMean)=0
 Set the mean of the bias value. Bias is computed based on the bias mean and bias standard deviation. More...
 
virtual void SetBiasStdDev (double _biasStdDev)=0
 Set the standard deviation of the bias value. Bias is computed based on the bias mean and bias standard deviation. More...
 
virtual void SetMean (double _mean)=0
 Set mean. More...
 
virtual void SetStdDev (double _stdDev)=0
 Set stddev. More...
 
virtual double StdDev () const =0
 Accessor for stddev. More...
 
- Public Member Functions inherited from RenderPass
virtual ~RenderPass ()
 Destructor. More...
 
virtual bool IsEnabled () const =0
 Get whether or not the render pass is enabled. More...
 
virtual void SetEnabled (bool _enabled)=0
 Set to enable or disable the render pass. More...
 
- Public Member Functions inherited from Object
virtual ~Object ()
 Destructor. More...
 
virtual void Destroy ()=0
 Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior. More...
 
virtual unsigned int Id () const =0
 Get the object ID. This ID will be unique across all objects inside a given scene, but necessarily true for objects across different scenes. More...
 
virtual std::string Name () const =0
 Get the object name. This name will be unique across all objects inside a given scene, but necessarily true for objects across different scenes. More...
 
virtual void PostRender ()=0
 Post process this object and any of its children after rendering. More...
 
virtual void PreRender ()=0
 Prepare this object and any of its children for rendering. This should be called for each object in a scene just before rendering, which can be achieved by a single call to Scene::PreRender. More...
 
virtual ScenePtr Scene () const =0
 Get the Scene that created this object. More...
 

Detailed Description

A render pass that applies Gaussian noise to the render target.

Constructor & Destructor Documentation

◆ GaussianNoisePass()

Constructor.

◆ ~GaussianNoisePass()

virtual ~GaussianNoisePass ( )
virtual

Destructor.

Member Function Documentation

◆ Bias()

virtual double Bias ( ) const
pure virtual

Accessor for bias.

Returns
Bias on output.

Implemented in BaseGaussianNoisePass< T >, and BaseGaussianNoisePass< OgreRenderPass >.

◆ Mean()

virtual double Mean ( ) const
pure virtual

Accessor for mean.

Returns
Mean of Gaussian noise.

Implemented in BaseGaussianNoisePass< T >, and BaseGaussianNoisePass< OgreRenderPass >.

◆ SetBiasMean()

virtual void SetBiasMean ( double  _biasMean)
pure virtual

Set the mean of the bias value. Bias is computed based on the bias mean and bias standard deviation.

See also
SetBiasStdDev

Implemented in BaseGaussianNoisePass< T >, and BaseGaussianNoisePass< OgreRenderPass >.

◆ SetBiasStdDev()

virtual void SetBiasStdDev ( double  _biasStdDev)
pure virtual

Set the standard deviation of the bias value. Bias is computed based on the bias mean and bias standard deviation.

See also
SetBiasMean

Implemented in BaseGaussianNoisePass< T >, and BaseGaussianNoisePass< OgreRenderPass >.

◆ SetMean()

virtual void SetMean ( double  _mean)
pure virtual

Set mean.

Parameters
[in]_meanMean of Gaussian noise.

Implemented in BaseGaussianNoisePass< T >, and BaseGaussianNoisePass< OgreRenderPass >.

◆ SetStdDev()

virtual void SetStdDev ( double  _stdDev)
pure virtual

Set stddev.

Parameters
[in]_stdDevStandard deviation of Gaussian noise.

Implemented in BaseGaussianNoisePass< T >, and BaseGaussianNoisePass< OgreRenderPass >.

◆ StdDev()

virtual double StdDev ( ) const
pure virtual

Accessor for stddev.

Returns
Standard deviation of Gaussian noise.

Implemented in BaseGaussianNoisePass< T >, and BaseGaussianNoisePass< OgreRenderPass >.


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