VerticesEngine.Graphics.vxRenderPass Class Reference

The base class for creating a Post Processor for the Vertices Engine. More...

Inheritance diagram for VerticesEngine.Graphics.vxRenderPass:

Public Member Functions
	vxRenderPass (string name, Effect shader)
	Constructor for a render feature.
virtual void	RegisterRenderTargetsForDebug ()
	Register any render targets with the debug system here.
virtual void	LoadContent ()
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 Attributes
Matrix	OrthogonalProjection
Matrix	HalfPixelOffset
Vector2	_halfPixel
Public Attributes inherited from VerticesEngine.vxGameObject
bool	OnlySelectInSandbox = false

Protected Member Functions
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
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]

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

The base class for creating a Post Processor for the Vertices Engine.

Constructor & Destructor Documentation

vxRenderPass()

VerticesEngine.Graphics.vxRenderPass.vxRenderPass	(	string	name,
		Effect	shader )

Constructor for a render feature.

Parameters

name	The human readable name for this render feature.
shader	The main Microsoft.Xna.Framework.Graphics.Effect to used with this render feature.

Member Function Documentation

DrawFullscreenQuad() [1/2]

void VerticesEngine.Graphics.vxRenderPass.DrawFullscreenQuad	(	string	tag,
		Texture2D	texture,
		int	width,
		int	height )

Draws With No Effect Used.

Parameters

texture
width
height

DrawFullscreenQuad() [2/2]

void VerticesEngine.Graphics.vxRenderPass.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.

Parameters

texture
width
height
effect

OnDisposed()

override void VerticesEngine.Graphics.vxRenderPass.OnDisposed ( )

protectedvirtual

Called when the entity is disposed.

Reimplemented from VerticesEngine.vxGameObject.

Reimplemented in VerticesEngine.Graphics.vxSceneBlurPostProcess, VerticesEngine.Graphics.vxSelectedItemEdgePostProcess, and VerticesEngine.Graphics.vxSunLightPostProcess.

OnGraphicsRefresh()

override void VerticesEngine.Graphics.vxRenderPass.OnGraphicsRefresh ( )

virtual

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

Reimplemented from VerticesEngine.vxGameObject.

Reimplemented in VerticesEngine.Graphics.vxSceneBlurPostProcess, VerticesEngine.Graphics.vxSelectedItemEdgePostProcess, and VerticesEngine.Graphics.vxSunLightPostProcess.

OnInitialised()

virtual void VerticesEngine.Graphics.vxRenderPass.OnInitialised ( )

protectedvirtual

Called when the render pipeline is initialised. This is where you can query the renderer for other render passes.

Reimplemented in VerticesEngine.Graphics.vxDistortionPostProcess, VerticesEngine.Graphics.vxDistortionPostProcess2D, VerticesEngine.Graphics.vxEdgeDetectPostProcess, VerticesEngine.Graphics.vxSelectedItemEdgePostProcess, VerticesEngine.Graphics.vxDebugRenderPass, VerticesEngine.Graphics.vxGBufferRenderingPass, and VerticesEngine.Graphics.vxSceneLightRenderingPass.

RegisterRenderTargetsForDebug()

virtual void VerticesEngine.Graphics.vxRenderPass.RegisterRenderTargetsForDebug ( )

virtual

Register any render targets with the debug system here.

Reimplemented in VerticesEngine.Graphics.vxBlurEffectsPostProcess, VerticesEngine.Graphics.vxSceneBlurPostProcess, VerticesEngine.Graphics.vxSelectedItemEdgePostProcess, VerticesEngine.Graphics.vxSunLightPostProcess, VerticesEngine.Graphics.vxCascadeShadowRenderPass, VerticesEngine.Graphics.vxGBufferRenderingPass, and VerticesEngine.Graphics.vxSceneLightRenderingPass.

---

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

• /github/workspace/src/VerticesEngine/src.shared/Graphics/Render Passes/vxRenderPass.cs