BasicParameters Class Reference

Class representing basic program parameters. More...

List of all members.

Public Member Functions
	BasicParameters ()
	Creates a parameter.
void	Enable (BasicEnableMode mode, bool status)
	Enables or disables the specified shader feature.
bool	IsEnabled (BasicEnableMode mode)
	Obtains whether or not the specified shader feature is enabled.
void	SetProjectionMatrix (ref Matrix4 projection)
	Sets the projection matrix.
void	SetViewMatrix (ref Matrix4 view)
	Sets a view matrix.
void	SetWorldCount (int count)
	Sets the number of world matrices.
void	SetWorldMatrix (int index, ref Matrix4 world)
	Sets a world matrix.
void	SetLightCount (int count)
	Sets the number of lights.
void	SetLightDirection (int index, ref Vector3 direction)
	Sets the light direction vector.
void	SetLightDiffuse (int index, ref Vector3 diffuse)
	Sets the light diffuse color.
void	SetLightSpecular (int index, ref Vector3 specular)
	Sets the light specular color.
void	SetLightAmbient (ref Vector3 ambient)
	Sets the light ambient color.
void	SetFogRange (float start, float end)
	Sets the fog range.
void	SetFogColor (ref Vector3 color)
	Sets the fog color.
void	SetMaterialDiffuse (ref Vector3 diffuse)
	Sets the material diffuse color.
void	SetMaterialSpecular (ref Vector3 specular)
	Sets the material specular color.
void	SetMaterialAmbient (ref Vector3 ambient)
	Sets the material ambient color.
void	SetMaterialEmission (ref Vector3 emission)
	Sets the material emission color.
void	SetMaterialOpacity (float opacity)
	Sets the material opacity.
void	SetMaterialShininess (float shininess)
	Sets the material luminance.
void	SetPositionOffset (float transX, float transY, float transZ, float scale)
	Set offset of vertex position coordinates.
void	SetTexCoordOffset (int index, float transU, float transV, float scaleU, float scaleV)
	Set offset of vertex texture coordinates.
void	SetVertexWeightCount (int count)
	Sets the number of vertex weights.

---

Detailed Description

Class representing basic program parameters.

---

Member Function Documentation

void Enable	(	BasicEnableMode	mode,
		bool	status
	)

Enables or disables the specified shader feature.

Parameters:

mode	Shader feature to enable or disable
status	Specify true to enable

bool IsEnabled

(

BasicEnableMode

mode

)

Obtains whether or not the specified shader feature is enabled.

Parameters:

mode	Shader feature to enable or disable

void SetFogColor

(

ref Vector3

color

)

Sets the fog color.

Parameters:

color

Color

void SetFogRange	(	float	start,
		float	end
	)

Sets the fog range.

Parameters:

start	Start distance
end	End distance

void SetLightAmbient

(

ref Vector3

ambient

)

Sets the light ambient color.

Parameters:

ambient

Ambient color

void SetLightCount

(

int

count

)

Sets the number of lights.

Parameters:

count

Number of lights (0 - 3)

void SetLightDiffuse	(	int	index,
		ref Vector3	diffuse
	)

Sets the light diffuse color.

Parameters:

index	Light number (0 - 2)
diffuse	Diffuse color

void SetLightDirection	(	int	index,
		ref Vector3	direction
	)

Sets the light direction vector.

Parameters:

index	Light number (0 - 2)
direction	Direction vector

void SetLightSpecular	(	int	index,
		ref Vector3	specular
	)

Sets the light specular color.

Parameters:

index	Light number (0 - 2)
specular	Specular color

void SetMaterialAmbient

(

ref Vector3

ambient

)

Sets the material ambient color.

Parameters:

ambient

Ambient color

void SetMaterialDiffuse

(

ref Vector3

diffuse

)

Sets the material diffuse color.

Parameters:

diffuse

Diffuse color

void SetMaterialEmission

(

ref Vector3

emission

)

Sets the material emission color.

Parameters:

emission

Emission color

void SetMaterialOpacity

(

float

opacity

)

Sets the material opacity.

Parameters:

opacity

Opacity

void SetMaterialShininess

(

float

shininess

)

Sets the material luminance.

Parameters:

shininess

Luminance

void SetMaterialSpecular

(

ref Vector3

specular

)

Sets the material specular color.

Parameters:

specular

Specular color

void SetPositionOffset	(	float	transX,
		float	transY,
		float	transZ,
		float	scale
	)

Set offset of vertex position coordinates.

Parameters:

transX	Translation of X
transY	Translation of Y
transZ	Translation of Z
scale	Scaling

void SetProjectionMatrix

(

ref Matrix4

projection

)

Sets the projection matrix.

Parameters:

projection

Projection matrix

void SetTexCoordOffset	(	int	index,
		float	transU,
		float	transV,
		float	scaleU,
		float	scaleV
	)

Set offset of vertex texture coordinates.

Parameters:

index	Number of the texture coordinate (always 0)
transU	Translation of U
transV	Translation of V
scaleU	U scaling
scaleV	V scaling

void SetVertexWeightCount

(

int

count

)

Sets the number of vertex weights.

Parameters:

count

Number of vertex weights (0 - 4)

void SetViewMatrix

(

ref Matrix4

view

)

Sets a view matrix.

Parameters:

view	View matrix

void SetWorldCount

(

int

count

)

Sets the number of world matrices.

Parameters:

count

Number of world matrices (1 - 16)

void SetWorldMatrix	(	int	index,
		ref Matrix4	world
	)

Sets a world matrix.

Parameters:

index	World matrix number (0 - 15)
world	World matrix