class ShaderParameter in Tinman.AddOns.Rendering

Abstract base class for IShaderParameter implementations.

abstract class

ShaderParameter

implements

IShaderParameter

Public / Attributes

Count

Returns the number of array elements.

public property	Count { get }
type	int32
value	[>=1]	The number of elements.
implements	IShaderParameter.Count

Name

The name of this shader parameter.

public property	Name { get }
type	string
value	[not-null]	The parameter name.
implements	IShaderParameter.Name

Type

The type of this shader parameter.

public property	Type { get }
type	ShaderParameterType
value		The parameter type.
implements	IShaderParameter.Type

Public / Methods

SetMatrix2

Sets the value of this shader effect parameter.

public abstract method	SetMatrix2 (Mat2F value, bool transpose = false, int32 index = 0)
params	value		The parameter value.
	transpose		Use transpose of value? Defaults to false.
	index	[0..Count-1]	Array element index. Defaults to 0.
implements	IShaderParameter.SetMatrix2

See also:

ShaderParameterType.Matrix2

SetMatrix3

Sets the value of this shader effect parameter.

public abstract method	SetMatrix3 (Mat3F value, bool transpose = false, int32 index = 0)
params	value		The parameter value.
	transpose		Use transpose of value? Defaults to false.
	index	[0..Count-1]	Array element index. Defaults to 0.
implements	IShaderParameter.SetMatrix3

See also:

ShaderParameterType.Matrix3

SetMatrix4

Sets the value of this shader effect parameter.

public abstract method	SetMatrix4 (Mat4F value, bool transpose = false, int32 index = 0)
params	value		The parameter value.
	transpose		Use transpose of value? Defaults to false.
	index	[0..Count-1]	Array element index. Defaults to 0.
implements	IShaderParameter.SetMatrix4

See also:

ShaderParameterType.Matrix4

SetScalar

Sets the value of this shader effect parameter.

public abstract method	SetScalar (float32 value, int32 index = 0)
params	value		The parameter value.
	index	[0..Count-1]	Array element index. Defaults to 0.
implements	IShaderParameter.SetScalar

See also:

ShaderParameterType.Float

SetTexture

Sets the texture of this shader effect parameter.

public abstract method	SetTexture (ITexture2D texture, int32 index = 0)
params	texture		The parameter texture.
	index	[0..Count-1]	Array element index. Defaults to 0.
implements	IShaderParameter.SetTexture

See also:

ShaderParameterType.Texture

---

Sets the texture of this shader effect parameter.

public abstract method	SetTexture (ITextureCube texture, int32 index = 0)
params	texture		The parameter texture.
	index	[0..Count-1]	Array element index. Defaults to 0.
implements	IShaderParameter.SetTexture

See also:

ShaderParameterType.TextureCube

SetTextureNull

Sets the texture of this shader effect parameter to null.

public abstract method	SetTextureNull (int32 index = 0)
params	index	[0..Count-1]	Array element index. Defaults to 0.
implements	IShaderParameter.SetTextureNull

See also:

ShaderParameterType.Texture

SetVector2

Sets the value of this shader effect parameter.

public abstract method	SetVector2 (Vec2F value, int32 index = 0)
params	value		The parameter value.
	index	[0..Count-1]	Array element index. Defaults to 0.
implements	IShaderParameter.SetVector2

See also:

ShaderParameterType.Vector2

SetVector3

Sets the value of this shader effect parameter.

public abstract method	SetVector3 (Vec3F value, int32 index = 0)
params	value		The parameter value.
	index	[0..Count-1]	Array element index. Defaults to 0.
implements	IShaderParameter.SetVector3

See also:

ShaderParameterType.Vector3

SetVector4

Sets the value of this shader effect parameter.

public abstract method	SetVector4 (Vec4F value, int32 index = 0)
params	value		The parameter value.
	index	[0..Count-1]	Array element index. Defaults to 0.
implements	IShaderParameter.SetVector4

See also:

ShaderParameterType.Vector4

Protected / Attributes

count

Element count of this parameter.

protected field	count
type	int32

Remarks:

This field must be initialized by subclasses in their constructor.

type

Element type of this parameter.

protected field	type
type	ShaderParameterType

Remarks:

This field must be initialized by subclasses in their constructor.

Protected / Constructors

ShaderParameter

Creates a new instance of ShaderParameter.

protected constructor	ShaderParameter (string name)
params	name	[not-empty]	The parameter name.

Protected / Methods

AssertType

protected method	AssertType (string source, ShaderParameterType type)
params	source
	type