C#Code
C#Code
Public Member Functions | Static Public Attributes | Protected Attributes | Properties
Libraries.Shaders.Shader Class Reference

List of all members.

Public Member Functions

 Shader ()
 Shader (string ID, Effect effect)
void Update (int timePassed)
ShaderProperties GetProperties ()
BaseShaderProperty GetProperty (StringType ID)
bool AddProperty (BaseShaderProperty property)
Effect GetEffect ()
void SetEffect (Effect effect)
 Shader ()
 Shader (string ID, Effect effect)
void Update (int timePassed)
ShaderProperties GetProperties ()
bool AddProperty (BaseShaderProperty property)
Effect GetEffect ()
void SetEffect (Effect effect)

Static Public Attributes

static StringType s_invalidShaderType = new StringType("NONE")

Protected Attributes

Libraries.StringType m_ID
 ID of the shader.
Effect m_effect
 Effect to use.
ShaderProperties m_properties
 Shader properties.

Properties

StringType ID [get, set]

Detailed Description

Store a shader and properties that go with it.


Constructor & Destructor Documentation

Libraries.Shaders.Shader.Shader ( )

Default constructor.

Libraries.Shaders.Shader.Shader ( string  ID,
Effect  effect 
)

Constructor.

ID - ID to use for the shader. -1 means not set.
effect - Effect to store.
Libraries.Shaders.Shader.Shader ( )

Default constructor.

Libraries.Shaders.Shader.Shader ( string  ID,
Effect  effect 
)

Constructor.

ID - ID to use for the shader. -1 means not set.
effect - Effect to store.

Member Function Documentation

bool Libraries.Shaders.Shader.AddProperty ( BaseShaderProperty  property)

Add the given property the the shader properties.

property - Value is the property to add.

Return:
Value is true if the property was able to be added to the shader, false if not.
bool Libraries.Shaders.Shader.AddProperty ( BaseShaderProperty  property)

Add the given property the the shader properties.

property - Value is the property to add.

Return:
Value is true if the property was able to be added to the shader, false if not.
Effect Libraries.Shaders.Shader.GetEffect ( )

Returns the shader effect.

Effect Libraries.Shaders.Shader.GetEffect ( )

Returns the shader effect.

ShaderProperties Libraries.Shaders.Shader.GetProperties ( )

Returns the shader properties.

ShaderProperties Libraries.Shaders.Shader.GetProperties ( )

Returns the shader properties.

BaseShaderProperty Libraries.Shaders.Shader.GetProperty ( StringType  ID)

Returns the shader property with the given ID, if possible.

ID - ID of the shader property to retrive.

Return:
Value is the shader found with the matching ID, null if no match was found.
void Libraries.Shaders.Shader.SetEffect ( Effect  effect)

Set the shader effect to the given effect.

void Libraries.Shaders.Shader.SetEffect ( Effect  effect)

Set the shader effect to the given effect.

void Libraries.Shaders.Shader.Update ( int  timePassed)

Update all stored properties.

timePassed - How long has passed since the previous update.
void Libraries.Shaders.Shader.Update ( int  timePassed)

Update all stored properties.

timePassed - How long has passed since the previous update.

Member Data Documentation

Effect to use.

ID of the shader.

Shader properties.


Property Documentation

StringType Libraries::Shaders.Shader::ID [get, set]

Getter/Setter for the object ID. -1 means not set.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Enumerations Properties