C# Class Axiom.Graphics.CompositionPass

Object representing one pass or operation in a composition sequence. This provides a method to conviently interleave RenderSystem commands between Render Queues.

Show file Open project: WolfgangSt/axiom Class Usage Examples

Protected Properties

Property	Type	Description
clearBuffers	FrameBufferType
clearColor	Axiom.Core.ColorEx
clearDepth	float
clearStencil	int
customType	string
firstRenderQueue	RenderQueueGroupID
identifier	uint
inputs	InputTexture[]
lastRenderQueue	RenderQueueGroupID
material	Material
materialSchemeName	string
parent	CompositionTargetPass
quadBottom	float
quadCornerModified	bool
quadFarCorners	bool
quadFarCornersViewSpace	bool
quadLeft	float
quadRight	float
quadTop	float
stencilCheck	bool
stencilDepthFailOp	StencilOperation
stencilFailOp	StencilOperation
stencilFunc	CompareFunction
stencilMask	int
stencilPassOp	StencilOperation
stencilRefValue	int
stencilTwoSidedOperation	bool
type	CompositorPassType

Public Methods

Method	Description
ClearAllInputs ( ) : void	Clear all inputs. Note applies when CompositorPassType is RenderQuad
CompositionPass ( CompositionTargetPass parent ) : System
GetInput ( int id ) : InputTexture	Get the value of an input. Note applies when CompositorPassType is RenderQuad
GetQuadCorners ( float &left, float &top, float &right, float &bottom ) : bool	Get quad normalised positions [-1;1]x[-1;1]
SetInput ( int id ) : void
SetInput ( int id, string name ) : void
SetInput ( int id, string name, int mrtIndex ) : void	Set an input local texture. An empty string clears the input. Note applies when CompositorPassType is RenderQuad
SetQuadCorners ( float left, float top, float right, float bottom ) : void	Set quad normalised positions [-1;1]x[-1;1]
SetQuadFarCorners ( bool farCorners, bool farCornersViewSpace ) : void	Sets the use of camera frustum far corners provided in the quad's normals

Method Details

ClearAllInputs() public method

Clear all inputs.

Note applies when CompositorPassType is RenderQuad

public ClearAllInputs ( ) : void
return	void

CompositionPass() public method

public CompositionPass ( CompositionTargetPass parent ) : System
parent	CompositionTargetPass
return	System

GetInput() public method

Get the value of an input.

Note applies when CompositorPassType is RenderQuad

public GetInput ( int id ) : InputTexture
id	int	Input to get. Must be in 0..Config.MaxTextureLayers-1.
return	InputTexture

GetQuadCorners() public method

Get quad normalised positions [-1;1]x[-1;1]

public GetQuadCorners ( float &left, float &top, float &right, float &bottom ) : bool
left	float
top	float
right	float
bottom	float
return	bool

SetInput() public method

public SetInput ( int id ) : void
id	int
return	void

SetInput() public method

public SetInput ( int id, string name ) : void
id	int
name	string
return	void

SetInput() public method

Set an input local texture. An empty string clears the input.

Note applies when CompositorPassType is RenderQuad

public SetInput ( int id, string name, int mrtIndex ) : void
id	int	Input to set. Must be in 0..Config.MaxTextureLayers-1
name	string	Which texture to bind to this input. An empty string clears the input.
mrtIndex	int
return	void

SetQuadCorners() public method

Set quad normalised positions [-1;1]x[-1;1]

public SetQuadCorners ( float left, float top, float right, float bottom ) : void
left	float
top	float
right	float
bottom	float
return	void

SetQuadFarCorners() public method

Sets the use of camera frustum far corners provided in the quad's normals

public SetQuadFarCorners ( bool farCorners, bool farCornersViewSpace ) : void
farCorners	bool
farCornersViewSpace	bool
return	void

Property Details

clearBuffers protected property

Clear buffers (in case of CompositorPassType.Clear)

protected FrameBufferType clearBuffers
return	FrameBufferType

clearColor protected property

Clear colour (in case of CompositorPassType.Clear)

protected ColorEx,Axiom.Core clearColor
return	Axiom.Core.ColorEx

clearDepth protected property

Clear depth (in case of CompositorPassType.Clear)

protected float clearDepth
return	float

clearStencil protected property

Clear stencil value (in case of CompositorPassType.Clear)

protected int clearStencil
return	int

customType protected property

protected string customType
return	string

firstRenderQueue protected property

first render queue to render this pass (in case of CompositorPassType.RenderScene)

protected RenderQueueGroupID firstRenderQueue
return	RenderQueueGroupID

identifier protected property

Identifier for this pass

protected uint identifier
return	uint

inputs protected property

Inputs (for material used for rendering the quad) An empty string signifies that no input is used

protected InputTexture[] inputs
return	InputTexture[]

lastRenderQueue protected property

last render queue to render this pass (in case of CompositorPassType.RenderScene)

protected RenderQueueGroupID lastRenderQueue
return	RenderQueueGroupID

material protected property

Material used for rendering

protected Material,Axiom.Graphics material
return	Material

materialSchemeName protected property

Material scheme name

protected string materialSchemeName
return	string

parent protected property

Parent technique

protected CompositionTargetPass,Axiom.Graphics parent
return	CompositionTargetPass

quadBottom protected property

quad positions in normalised coordinates [-1;1]x[-1;1] (in case of RENDERQUAD)

protected float quadBottom
return	float

quadCornerModified protected property

true if quad should not cover whole screen

protected bool quadCornerModified
return	bool

quadFarCorners protected property

protected bool quadFarCorners
return	bool

quadFarCornersViewSpace protected property

protected bool quadFarCornersViewSpace
return	bool

quadLeft protected property

quad positions in normalised coordinates [-1;1]x[-1;1] (in case of RENDERQUAD)

protected float quadLeft
return	float

quadRight protected property

quad positions in normalised coordinates [-1;1]x[-1;1] (in case of RENDERQUAD)

protected float quadRight
return	float

quadTop protected property

quad positions in normalised coordinates [-1;1]x[-1;1] (in case of RENDERQUAD)

protected float quadTop
return	float

stencilCheck protected property

Stencil operation parameters

protected bool stencilCheck
return	bool

stencilDepthFailOp protected property

protected StencilOperation stencilDepthFailOp
return	StencilOperation

stencilFailOp protected property

protected StencilOperation stencilFailOp
return	StencilOperation

stencilFunc protected property

protected CompareFunction stencilFunc
return	CompareFunction

stencilMask protected property

protected int stencilMask
return	int

stencilPassOp protected property

protected StencilOperation stencilPassOp
return	StencilOperation

stencilRefValue protected property

protected int stencilRefValue
return	int

stencilTwoSidedOperation protected property

protected bool stencilTwoSidedOperation
return	bool

type protected property

Type of composition pass

protected CompositorPassType type
return	CompositorPassType