VerticesEngine.Graphics.vxBlurEffectsPostProcess Class Reference

Takes the current scene and applies Bloom, Depth of Field and Chromatic Aboration to that scene. More...

Inheritance diagram for VerticesEngine.Graphics.vxBlurEffectsPostProcess:

Public Member Functions
override void	LoadContent ()
override void	RegisterRenderTargetsForDebug ()
	Register any render targets with the debug system here.
override void	OnGraphicsRefresh ()
	Called when there is a reset or refresh of Graphic settings such as resolution or setting.
void	Prepare (vxCamera camera)
void	GaussianBlueScene (RenderTarget2D SceneToBlur, RenderTarget2D BlurredScene)
void	Apply (vxCamera camera)
Public Member Functions inherited from VerticesEngine.Graphics.vxRenderPass
	vxRenderPass (string name, Effect shader)
	Constructor for a render feature.
virtual void	RefreshSettings ()
override void	OnGraphicsRefresh ()
	Called when there is a reset or refresh of Graphic settings such as resolution or setting.
void	DrawRenderTargetIntoOther (string tag, Texture2D texture, RenderTarget2D renderTarget, Effect effect)
	Helper for drawing a texture into a rendertarget, using a custom shader to apply postprocessing effects.
void	DrawFullscreenQuad (string tag, Texture2D texture, int width, int height, Effect effect)
	Helper for drawing a texture into the current rendertarget, using a custom shader to apply postprocessing effects.
void	DrawFullscreenQuad (string tag, Texture2D texture, int width, int height)
	Draws With No Effect Used.
void	SetEffectParameter (string param, float value)
void	SetEffectParameter (string param, Vector2 value)
void	SetEffectParameter (string param, Vector3 value)
void	SetEffectParameter (string param, Vector4 value)
void	SetEffectParameter (string param, Color value)
void	SetEffectParameter (string param, Matrix value)
void	SetEffectParameter (string param, Texture2D value)
Public Member Functions inherited from VerticesEngine.vxGameObject
virtual void	OnEnabled ()
	Called on Component Enabled.
virtual void	OnDisabled ()
	Called on Component Disabled.
virtual void	OnSelected ()
	Called when Selected.
virtual void	OnUnSelected ()
	Called when Unselected.
virtual string	GetTitle ()
	Gets the title.
virtual Texture2D	GetIcon (int w, int h)
	Gets the icon for this game object. Override this to provide per-entity cusomtization.
	vxGameObject ()
	Creates a new vxGameObject.
void	Dispose ()
	Dispposes this Object.
Public Member Functions inherited from VerticesEngine.Graphics.vxIRenderPass
void	Dispose ()

Public Attributes
RenderTarget2D	BloomSceneResult
	Render target which holds the final Gaussian Bloom Scene.
RenderTarget2D	BloomExtractResult
	TempRender target for blurring.
RenderTarget2D	BloomTempRenderTarget
	TempRender target for blurring.
Public Attributes inherited from VerticesEngine.Graphics.vxRenderPass
Matrix	OrthogonalProjection
Matrix	HalfPixelOffset
Vector2	_halfPixel
Public Attributes inherited from VerticesEngine.vxGameObject
bool	OnlySelectInSandbox = false

Protected Member Functions
override void	OnDisposed ()
	Called when the entity is disposed.
Protected Member Functions inherited from VerticesEngine.Graphics.vxRenderPass
virtual void	OnInitialised ()
	Called when the render pipeline is initialised. This is where you can query the renderer for other render passes.
override void	OnDisposed ()
	Called when the entity is disposed.
Protected Member Functions inherited from VerticesEngine.vxGameObject
virtual void	OnVisibilityChanged ()
	Called when an Objects Visibility Changes.
virtual bool	HasId ()
virtual void	OnSelectionStateChange ()
	Called when the selection state changes.
virtual string	GetIdPrefix ()

Properties
RenderTarget2D	SceneTexture [set]
	The Scene Texture.
RenderTarget2D	DepthMap [set]
	Depth map of the scene.
static vxEnumQuality	BloomQuality [get, set]
float	BloomBlurAmount [get, set]
	Controls how much blurring is applied to the bloom image. The typical range is from 1 up to 10 or so.
bool	DoFullSceneBloom [get, set]
float	BloomThreshold [get, set]
	Controls how bright a pixel needs to be before it will bloom. Zero makes everything bloom equally, while higher values select only brighter colors. Somewhere between 0.25 and 0.5 is good.
float	BloomIntensity [get, set]
	Controls the amount of the bloom and base images that will be mixed into the final scene. Range 0 to 1.
float	BaseIntensity [get, set]
	The base intensity.
float	BloomSaturation [get, set]
	Independently control the color saturation of the bloom and base images. Zero is totally desaturated, 1.0 leaves saturation unchanged, while higher values increase the saturation level.
float	BaseSaturation [get, set]
	The base saturation.
Vector3[]	RAND_SAMPLES [set]
Properties inherited from VerticesEngine.Graphics.vxRenderPass
virtual string	RenderPass [get]
	This represents a Render pass int which can be overrid to pas a custom designed enum for specifing the rendering pass.
string	Name [get]
	The name of this post processor.
bool	IsInitialised [get]
	Has this render feature been initialised yet? Note that render features must be added during game startup in the vxGame.OnRenderPipelineInitialised(vxRenderPipeline) method.
Effect	Effect [get]
	The main effect for this Post Process.
EffectParameterCollection	Parameters [get]
	The parameters for the main effect.
vxRenderPipeline	Renderer [get]
	The renderering engine which will be using this Post Process.
Vector2	ScreenResolution [set]
Vector2	HalfPixel [get, set]
Matrix	MatrixTransform [get, set]
Properties inherited from VerticesEngine.vxGameObject
bool	IsVisible [get, set]
	Is this Game Object currently visible? Note that an Object can be Enabled, but not visible.
bool	IsEnabled [get, set]
	Is this Game Object Enabled currently.
string	Id [get, set]
	A unqiue string id which allows references to items to be serialised between sessions.
Texture2D	DefaultTexture [get]
	Gets the default texture.
vxEnumSandboxStatus	SandboxState [get]
	State of the Entity which is triggered by the simulation.
vxSelectionState	SelectionState [get, set]
	Gets or sets the selection state.
vxSelectionState	PreviousSelectionState [get]
	Get's the previous selection state.
bool	IsDisposed [get]
Properties inherited from VerticesEngine.Graphics.vxIRenderPass
bool	IsDisposed [get]

Additional Inherited Members
Static Public Attributes inherited from VerticesEngine.vxGameObject
static List< string >	NameRegister = new List<string>()
	The name register.
Events inherited from VerticesEngine.vxGameObject
EventHandler< EventArgs >	Selected
	Event Fired when the Items Selection stat Changes too Hovered.
EventHandler< EventArgs >	UnSelected
	Event Fired when the Items Selection stat Changes too unselected (or unhovered)

Detailed Description

Takes the current scene and applies Bloom, Depth of Field and Chromatic Aboration to that scene.

Member Function Documentation

Apply()

void VerticesEngine.Graphics.vxBlurEffectsPostProcess.Apply

(

vxCamera

camera

)

Implements VerticesEngine.Graphics.vxIRenderPass.

LoadContent()

override void VerticesEngine.Graphics.vxBlurEffectsPostProcess.LoadContent ( )

virtual

Reimplemented from VerticesEngine.Graphics.vxRenderPass.

OnDisposed()

override void VerticesEngine.Graphics.vxBlurEffectsPostProcess.OnDisposed ( )

protectedvirtual

Called when the entity is disposed.

Reimplemented from VerticesEngine.vxGameObject.

OnGraphicsRefresh()

override void VerticesEngine.Graphics.vxBlurEffectsPostProcess.OnGraphicsRefresh ( )

virtual

Called when there is a reset or refresh of Graphic settings such as resolution or setting.

Reimplemented from VerticesEngine.vxGameObject.

Prepare()

void VerticesEngine.Graphics.vxBlurEffectsPostProcess.Prepare

(

vxCamera

camera

)

Implements VerticesEngine.Graphics.vxIRenderPass.

RegisterRenderTargetsForDebug()

override void VerticesEngine.Graphics.vxBlurEffectsPostProcess.RegisterRenderTargetsForDebug ( )

virtual

Register any render targets with the debug system here.

Reimplemented from VerticesEngine.Graphics.vxRenderPass.

---

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

• /github/workspace/src/VerticesEngine/src.shared/Graphics/Post Processors/vxBlurEffectsPostProcess.cs