VerticesEngine.Graphics.vxRenderPipeline Class Reference

This component renders a scene given the camera. More...

Inheritance diagram for VerticesEngine.Graphics.vxRenderPipeline:

Classes
class	Passes
	Collection of Engine Passes. More...

Public Member Functions
override void	OnGraphicsRefresh ()
	Called when there is a reset or refresh of Graphic settings such as resolution or setting.
void	RenderScene (vxCamera camera)
	This renders the scene for the given camera.
void	DrawDebug ()
RenderTarget2D	GetNewTempTarget (string name)
	Gets a new temp target.
RenderTarget2D	GetCurrentTempTarget ()
	Gets the current temp target. This pushes the stack forward. Use peek if you arent' drawing with this one to the new one.
virtual RenderTarget2D	Finalise ()
void	RenderQuad (Vector2 v1, Vector2 v2)
	Render the specified v1 and v2.
T	GetRenderingPass< T > ()
	Returns a Rendering Pass that is registered to this Renderer.
T	AddRenderFeature< T > ()
	Add a render feature to this renderer.
T	AddRenderFeature< T > (int insertIndex)
	Inserts a render feature to this renderer.
Color	GetEncodedIndex (int x, int y)
void	RegisterDebugRenderTarget (string name, RenderTarget2D renderTarget)
void	DrawRT (string name, RenderTarget2D rt)
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
RenderTarget2D	NormalMap
	Normal Render Target.
RenderTarget2D	DepthMap
	Depth Render Target.
RenderTarget2D	SurfaceDataMap
	Render Target which holds Surface Data such as Specular Power, Intensity as well as Shadow Factor.
RenderTarget2D	EntityMaskValues
	This render target holds mask information for different entities (i.e. do edge detection? do motion blur, etc...)
RenderTarget2D	AuxDepthMap
	Aux Depth Map.
RenderTarget2D	BlurredScene
RenderTarget2D[]	PostProcessTargets
	The post process temp targets collection.
int	TempTargetsUsed = 0
	The number of temp targets used.
int	TempTargetCount = 12
Vector3	LightDirection
	Light Direction. In 2D only 'x' and 'y' are taken.
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.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
bool	IsInitialised [get]
	Has this render pipeline been initialised yet?
static vxRenderPipeline	Instance [get]
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

This component renders a scene given the camera.

Member Function Documentation

AddRenderFeature< T >() [1/2]

T VerticesEngine.Graphics.vxRenderPipeline.AddRenderFeature< T >

(

)

Add a render feature to this renderer.

Template Parameters

T

Returns

A reference to the created render feature.

Type Constraints

T

:

vxIRenderPass

AddRenderFeature< T >() [2/2]

T VerticesEngine.Graphics.vxRenderPipeline.AddRenderFeature< T >

(

int

insertIndex

)

Inserts a render feature to this renderer.

Template Parameters

T

Parameters

insertIndex

Returns

A reference to the created render feature.

Type Constraints

T

:

vxIRenderPass

GetCurrentTempTarget()

RenderTarget2D VerticesEngine.Graphics.vxRenderPipeline.GetCurrentTempTarget

(

)

Gets the current temp target. This pushes the stack forward. Use peek if you arent' drawing with this one to the new one.

Returns

The current temp target.

GetNewTempTarget()

RenderTarget2D VerticesEngine.Graphics.vxRenderPipeline.GetNewTempTarget

(

string

name

)

Gets a new temp target.

Returns

The new temp target.

GetRenderingPass< T >()

T VerticesEngine.Graphics.vxRenderPipeline.GetRenderingPass< T >

(

)

Returns a Rendering Pass that is registered to this Renderer.

Template Parameters

T

Returns

Type Constraints

T

:

vxIRenderPass

OnDisposed()

override void VerticesEngine.Graphics.vxRenderPipeline.OnDisposed ( )

protectedvirtual

Called when the entity is disposed.

Reimplemented from VerticesEngine.vxGameObject.

OnGraphicsRefresh()

override void VerticesEngine.Graphics.vxRenderPipeline.OnGraphicsRefresh ( )

virtual

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

Reimplemented from VerticesEngine.vxGameObject.

RenderQuad()

void VerticesEngine.Graphics.vxRenderPipeline.RenderQuad	(	Vector2	v1,
		Vector2	v2 )

Render the specified v1 and v2.

Parameters

v1	V1.
v2	V2.

RenderScene()

void VerticesEngine.Graphics.vxRenderPipeline.RenderScene

(

vxCamera

camera

)

This renders the scene for the given camera.

Parameters

camera

---

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

• /github/workspace/src/VerticesEngine/src.shared/Graphics/vxRenderPipeline.cs