C# Class Axiom.Graphics.CompositionTechnique

Base composition technique, can be subclassed in plugins.

Inheritance: DisposableObject

Datei anzeigen Open project: WolfgangSt/axiom Class Usage Examples

Protected Properties

Property	Type	Description
compositorLogicName	string
outputTarget	CompositionTargetPass
parent	Compositor
schemeName	string
targetPasses	List
textureDefinitions	List

Public Methods

Method	Description
CompositionTechnique ( Compositor parent ) : System	Create's a new Composition technique
CreateTargetPass ( ) : CompositionTargetPass	Create's a new target pass.
CreateTextureDefinition ( string name ) : TextureDefinition	Create a new local texture definition, and return a pointer to it.
GetTargetPass ( int index ) : CompositionTargetPass	Get's a target passs by index.
GetTextureDefinition ( int index ) : TextureDefinition	Get's a local texture definition by index.
GetTextureDefinition ( string name ) : TextureDefinition	Get's a local texture definition by name.
IsSupported ( bool allowTextureDegradation ) : bool	Determine if this technique is supported on the current rendering device. A technique is supported if all materials referenced have a supported technique, and the intermediate texture formats requested are supported Material support is a cast-iron requirement, but if no texture formats are directly supported we can let the rendersystem create the closest match for the least demanding technique
RemoveAllTargetPasses ( ) : void	Remove's all target passes from this technique.
RemoveAllTextureDefinitions ( ) : void	Remove's all texture definitions.
RemoveTargetPass ( int index ) : void	Remove's and destroys a target pass.
RemoveTextureDefinition ( int index ) : void	Remove and destroy a local texture definition.

Method Details

CompositionTechnique() public method

Create's a new Composition technique

public CompositionTechnique ( Compositor parent ) : System
parent	Compositor	parent of this technique
return	System

CreateTargetPass() public method

Create's a new target pass.

public CreateTargetPass ( ) : CompositionTargetPass
return	CompositionTargetPass

CreateTextureDefinition() public method

Create a new local texture definition, and return a pointer to it.

public CreateTextureDefinition ( string name ) : TextureDefinition
name	string	name of the local texture
return	TextureDefinition

GetTargetPass() public method

Get's a target passs by index.

public GetTargetPass ( int index ) : CompositionTargetPass
index	int	index of the target pass
return	CompositionTargetPass

GetTextureDefinition() public method

Get's a local texture definition by index.

public GetTextureDefinition ( int index ) : TextureDefinition
index	int	index of the texture definition
return	TextureDefinition

GetTextureDefinition() public method

Get's a local texture definition by name.

public GetTextureDefinition ( string name ) : TextureDefinition
name	string	name of the texture definition
return	TextureDefinition

IsSupported() public method

Determine if this technique is supported on the current rendering device.

A technique is supported if all materials referenced have a supported technique, and the intermediate texture formats requested are supported Material support is a cast-iron requirement, but if no texture formats are directly supported we can let the rendersystem create the closest match for the least demanding technique

public IsSupported ( bool allowTextureDegradation ) : bool
allowTextureDegradation	bool	True to accept a reduction in texture depth
return	bool

RemoveAllTargetPasses() public method

Remove's all target passes from this technique.

public RemoveAllTargetPasses ( ) : void
return	void

RemoveAllTextureDefinitions() public method

Remove's all texture definitions.

public RemoveAllTextureDefinitions ( ) : void
return	void

RemoveTargetPass() public method

Remove's and destroys a target pass.

public RemoveTargetPass ( int index ) : void
index	int	index of the target pass to remove to.
return	void

RemoveTextureDefinition() public method

Remove and destroy a local texture definition.

public RemoveTextureDefinition ( int index ) : void
index	int
return	void

Property Details

compositorLogicName protected_oe property

Optional compositor logic name

protected string compositorLogicName
return	string

outputTarget protected_oe property

Output target pass (can be only one)

protected CompositionTargetPass,Axiom.Graphics outputTarget
return	CompositionTargetPass

parent protected_oe property

Parent compositor.

protected Compositor,Axiom.Graphics parent
return	Compositor

schemeName protected_oe property

Optional scheme name

protected string schemeName
return	string

targetPasses protected_oe property

Intermediate target passes

protected List targetPasses
return	List

textureDefinitions protected_oe property

local texture definitions.

protected List textureDefinitions
return	List