Materials

Functions
int	SO3DynamicCubeMapCreate (mmachine m)
	main include
int	SO3DynamicCubeMapSetTargetMaterial (mmachine m)
	SO3DynamicCubeMapSetTargetMaterial : Set the material on wich the rendered texture will be setted. The cube map is automatically setted to enable when a valid material is passed.
int	SO3DynamicCubeMapGetEnable (mmachine m)
	SO3DynamicCubeMapGetEnable : Get the enable state for the dynamic cube map.
int	SO3DynamicCubeMapSetEnable (mmachine m)
	SO3DynamicCubeMapSetEnable : Set the Enable state for dynamic cube map.
int	SO3DynamicCubeMapGetAutoUpdate (mmachine m)
	SO3DynamicCubeMapGetAutoUpdate : Get the auto update state (is the cube map update each frame?) for the dynamic cube map.
int	SO3DynamicCubeMapSetAutoUpdate (mmachine m)
	SO3DynamicCubeMapSetAutoUpdate : Set the AutoUpdate state (refresh every frame) for dynamic cube map.
int	SO3DynamicCubeMapGetTextureSize (mmachine m)
	SO3DynamicCubeMapGetTextureSize : Get the size of the dynamic cube map texture.
int	SO3DynamicCubeMapSetTextureSize (mmachine m)
	SO3DynamicCubeMapSetTextureSize : Set the size of the dynamic cube map texture.
int	SO3DynamicCubeMapUpdate (mmachine m)
	SO3DynamicCubeMapUpdate : manually update a dynamic cube map (in case autoUpdate is set to false);.
int	SO3DynamicReflectionMapCreate (mmachine m)
	main include
int	SO3DynamicReflectionMapSetTargetMaterial (mmachine m)
	SO3DynamicReflectionMapSetTargetMaterial : Set the material on wich the rendered texture will be setted. The plane reflection map is automatically setted to enable when a valid material is passed.
int	SO3DynamicReflectionMapGetEnable (mmachine m)
	SO3DynamicReflectionMapGetEnable : Get the enable state for the dynamic reflection map.
int	SO3DynamicReflectionMapSetEnable (mmachine m)
	SO3DynamicReflectionMapSetEnable : Set the Enable state for dynamic reflection map.
int	SO3DynamicReflectionMapGetRevertClipPlane (mmachine m)
	SO3DynamicReflectionMapGetRevertClipPlane : Get the revert clip plane state (is the camera clip plane up or down?) for the dynamic reflection map.
int	SO3DynamicReflectionMapSetRevertClipPlane (mmachine m)
	SO3DynamicReflectionMapSetRevertClipPlane : Set the revert clip plane state for dynamic reflection map.
int	SO3DynamicReflectionMapGetTextureSize (mmachine m)
	SO3DynamicReflectionMapGetTextureSize : Get the size of the dynamic reflection map texture.
int	SO3DynamicReflectionMapSetTextureSize (mmachine m)
	SO3DynamicReflectionMapSetTextureSize : Set the size of the dynamic reflection map texture.
int	SO3FlashControlCreateOnMaterial (mmachine m)
	SO3FlashControlCreateOnMaterial : Set a texture flash on a material.
int	SO3MaterialCreate (mmachine m)
	main include
int	SO3MaterialDestroy (mmachine m)
	SO3MaterialDestroy : Destroy a material.
int	SO3MaterialGetName (mmachine m)
	SO3MaterialGetName : Return the material name.
int	SO3MaterialSetAmbient (mmachine m)
	SO3MaterialSetAmbient : defines ambient color of a material.
int	SO3MaterialSetAmbientByTechAndPass (mmachine m)
	SO3MaterialSetAmbientByTechAndPass : defines ambient color by technique and pass of a material.
int	SO3MaterialSetDiffuse (mmachine m)
	SO3MaterialSetDiffuse : defines diffuse color of a material.
int	SO3MaterialSetDiffuseByTechAndPass (mmachine m)
	SO3MaterialSetDiffuseByTechAndPass : defines diffuse color by technique and pass of a material.
int	SO3MaterialGetReceiveShadows (mmachine m)
	SO3MaterialGetReceiveShadows : Get the receive shadow state for material.
int	SO3MaterialSetSelfIllumination (mmachine m)
	SO3MaterialSetSelfIllumination : defines self illuminaton color of a material.
int	SO3MaterialSetSelfIlluminationByTechAndPass (mmachine m)
	SO3MaterialSetSelfIlluminationByTechAndPass : defines self illumination color by technique and pass of a material.
int	SO3MaterialSetSpecular (mmachine m)
	SO3MaterialSetSpecular : defines specular color of a material.
int	SO3MaterialSetSpecularByTechAndPass (mmachine m)
	SO3MaterialSetSpecularByTechAndPass : defines specular color by technique and pass of a material.
int	SO3MaterialSetShininess (mmachine m)
	SO3MaterialSetShininess : defines shininess value of a material.
int	SO3MaterialSetShininessByTechAndPass (mmachine m)
	SO3MaterialSetShininessByTechAndPass : defines shininess value by technique and pass of a material.
int	SO3MaterialGetDiffuseByTechAndPass (mmachine m)
	SO3MaterialGetDiffuseByTechAndPass : Get the diffuse color by Technique and Pass.
int	SO3MaterialGetAmbientByTechAndPass (mmachine m)
	SO3MaterialGetAmbientByTechAndPass : Get the ambient color by Technique and Pass.
int	SO3MaterialGetSpecularByTechAndPass (mmachine m)
	SO3MaterialGetSpecularByTechAndPass : Get the specular color by Technique and Pass.
int	SO3MaterialGetShininessByTechAndPass (mmachine m)
	SO3MaterialGetShininessByTechAndPass : Get the Shininess value by Technique and Pass.
int	SO3MaterialGetSelfIlluminationByTechAndPass (mmachine m)
	SO3MaterialGetSelfIlluminationByTechAndPass : Get the self illumination color by Technique and Pass.
int	SO3MaterialIsLighting (mmachine m)
	SO3MaterialIsLighting : defines light state for a material.
int	SO3MaterialNumberOfTechniques (mmachine m)
	SO3MaterialNumberOfTechniques : Get the number of techniques.
int	SO3MaterialNumberOfPassesByTechnique (mmachine m)
	SO3MaterialNumberOfPassesByTechnique : Get the number of passes by technique.
int	SO3MaterialNumberOfTexturesByTechniqueAndPass (mmachine m)
	SO3MaterialNumberOfTexturesByTechniqueAndPass : Get the number of textures by technique and pass.
int	SO3MaterialTechniqueGetNameByIndex (mmachine m)
	SO3MaterialTechniqueGetNameByIndex : return the name of a technique.
int	SO3MaterialTechniqueGetIndexByName (mmachine m)
	SO3MaterialTechniqueGetIndexByName : return the index of a technique by name.
int	SO3MaterialPassGetNameByIndex (mmachine m)
	SO3MaterialPassGetNameByIndex : return the name of a pass.
int	SO3MaterialPassGetIndexByName (mmachine m)
	SO3MaterialPassGetIndexByName : return the index of a pass by name.
int	SO3MaterialTextureUnitGetNameByIndex (mmachine m)
	SO3MaterialTextureUnitGetNameByIndex : return the name of a texture unit.
int	SO3MaterialTextureUnitGetIndexByName (mmachine m)
	SO3MaterialTextureUnitGetIndexByName : return the index of a Texture unit by name.
int	SO3MaterialSetReceiveShadows (mmachine m)
	SO3MaterialSetReceiveShadows : defines receive shadow state for a given material.
int	SO3MaterialSetTexture (mmachine m)
	SO3MaterialSetTexture : Set a texture on a material.
int	SO3MaterialGetTexture (mmachine m)
	SO3MaterialGetTexture : Get a texture from a material.
int	SO3TextureCreate (mmachine m)
	SO3TextureCreate : Create a texture unit.
int	SO3TextureDestroy (mmachine m)
	SO3TextureDestroy : Destroy a texture unit.
int	SO3TextureGetName (mmachine m)
	SO3TextureGetName : Return the name of a texture.
int	SO3TextureManagerGetMemoryUsage (mmachine m)
	SO3TextureManagerGetMemoryUsage : Return the memory usage of all textures in the scene.
int	SO3TextureBlit (mmachine m)
	SO3TextureBlit : Blit a ObjBitmap on a texture.
int	SO3TextureBlitAlpha (mmachine m)
	SO3TextureBlitAlpha : Blit a AlphaBitmap on a texture.
int	SO3MaterialSetTextureUScroll (mmachine m)
	SO3MaterialSetTextureUScroll : Sets the translation offset of the texture, ie scrolls the texture, for the U value.
int	SO3MaterialGetTextureUScroll (mmachine m)
	SO3MaterialGetTextureUScroll : Gets the translation offset of the texture, ie scrolls the texture, for the U value.
int	SO3MaterialSetTextureVScroll (mmachine m)
	SO3MaterialSetTextureVScroll : Sets the translation offset of the texture, ie scrolls the texture, for the V value.
int	SO3MaterialGetTextureVScroll (mmachine m)
	SO3MaterialGetTextureVScroll : Gets the translation offset of the texture, ie scrolls the texture, for the V value.
int	SO3MaterialSetTextureUScale (mmachine m)
	SO3MaterialSetTextureUScale : Sets the scale value of the texture, for the U value.
int	SO3MaterialGetTextureUScale (mmachine m)
	SO3MaterialGetTextureUScale : Gets the scale of the texture, for the U value.
int	SO3MaterialSetTextureVScale (mmachine m)
	SO3MaterialSetTextureVScale : Sets the scale of the texture, for the V value.
int	SO3MaterialGetTextureVScale (mmachine m)
	SO3MaterialGetTextureVScale : Gets the scale of the texture, for the V value.
int	SO3MaterialSetTextureRotate (mmachine m)
	SO3MaterialSetTextureRotate : Rotate the texture.
int	SO3MaterialGetTextureRotate (mmachine m)
	SO3MaterialGetTextureRotate : Gets the rotation of the texture.
int	SO3MaterialSetTextureRotateAnimation (mmachine m)
	SO3MaterialSetTextureRotateAnimation : Set a rotate animation on the texture.
int	SO3MaterialSetTextureScrollAnimation (mmachine m)
	SO3MaterialSetTextureScrollAnimation : Set a scroll animation on the texture.

---

Detailed Description

Scol functions definition

---

Function Documentation

int SO3DynamicCubeMapCreate

(

mmachine

m

)

main include

SO3DynamicCubeMapCreate : Create a new dynamic cube map Prototype: fun [SO3_SCENE S] SO3_OBJECT

Parameters:

	SO3_SCENE	: current scene
	S	: given name for the new dynamic cube map

Returns:

SO3_OBJECT : Created object if success , NIL otherwise

Definition at line 54 of file SCOLDynamicCubeMap.cpp.

int SO3DynamicCubeMapGetAutoUpdate

(

mmachine

m

)

SO3DynamicCubeMapGetAutoUpdate : Get the auto update state (is the cube map update each frame?) for the dynamic cube map.

Prototype: fun [SO3_OBJECT] I

Parameters:

SO3_OBJECT

: current node

Returns:

I : Auto update state if success , NIL otherwise

Definition at line 270 of file SCOLDynamicCubeMap.cpp.

int SO3DynamicCubeMapGetEnable

(

mmachine

m

)

SO3DynamicCubeMapGetEnable : Get the enable state for the dynamic cube map.

Prototype: fun [SO3_OBJECT] I

Parameters:

SO3_OBJECT

: current node

Returns:

I : Enable state if success , NIL otherwise

Definition at line 189 of file SCOLDynamicCubeMap.cpp.

int SO3DynamicCubeMapGetTextureSize

(

mmachine

m

)

SO3DynamicCubeMapGetTextureSize : Get the size of the dynamic cube map texture.

Prototype: fun [SO3_OBJECT] I

Parameters:

SO3_OBJECT

: current node

Returns:

I : Enable state if success , NIL otherwise

Definition at line 352 of file SCOLDynamicCubeMap.cpp.

int SO3DynamicCubeMapSetAutoUpdate

(

mmachine

m

)

SO3DynamicCubeMapSetAutoUpdate : Set the AutoUpdate state (refresh every frame) for dynamic cube map.

Prototype: fun [SO3_OBJECT I] I

Parameters:

	SO3_OBJECT	: current node
	I	: bool for enable state

Returns:

I : 1 if success , NIL otherwise

Definition at line 310 of file SCOLDynamicCubeMap.cpp.

int SO3DynamicCubeMapSetEnable

(

mmachine

m

)

SO3DynamicCubeMapSetEnable : Set the Enable state for dynamic cube map.

Prototype: fun [SO3_OBJECT I] I

Parameters:

	SO3_OBJECT	: current node
	I	: bool for enable state

Returns:

I : 1 if success , NIL otherwise

Definition at line 229 of file SCOLDynamicCubeMap.cpp.

int SO3DynamicCubeMapSetTargetMaterial

(

mmachine

m

)

SO3DynamicCubeMapSetTargetMaterial : Set the material on wich the rendered texture will be setted. The cube map is automatically setted to enable when a valid material is passed.

Prototype: fun [SO3_OBJECT SO3_MATERIAL I I I] SO3_OBJECT

Parameters:

	SO3_OBJECT,:
	SO3_MATERIAL	:
	I	: Technique of the material where to render the cubeMap.
	I	: Pass of the material where to render the cubeMap.
	I	: Texture unit of the material where to render the cubeMap.

Returns:

SO3_OBJECT : Created material if success , NIL otherwise

Definition at line 126 of file SCOLDynamicCubeMap.cpp.

int SO3DynamicCubeMapSetTextureSize

(

mmachine

m

)

SO3DynamicCubeMapSetTextureSize : Set the size of the dynamic cube map texture.

Prototype: fun [SO3_OBJECT I] I

Parameters:

	SO3_OBJECT	: current node
	I	: bool for enable state

Returns:

I : 1 if success , NIL otherwise

Definition at line 392 of file SCOLDynamicCubeMap.cpp.

int SO3DynamicCubeMapUpdate

(

mmachine

m

)

SO3DynamicCubeMapUpdate : manually update a dynamic cube map (in case autoUpdate is set to false);.

Prototype: fun [SO3_OBJECT] I

Parameters:

SO3_OBJECT

: current node

Returns:

I : 1 if success , NIL otherwise

Definition at line 437 of file SCOLDynamicCubeMap.cpp.

int SO3DynamicReflectionMapCreate

(

mmachine

m

)

main include

SO3DynamicReflectionMapCreate : Create a new dynamic plane reflection map Prototype: fun [SO3_SCENE SO3_VIEWPORT S] SO3_OBJECT

Parameters:

	SO3_SCENE	: current scene
	SO3_VIEWPORT	: viewport for reflection calculation
	S	: given name for the new dynamic plane reflection map

Returns:

SO3_OBJECT : Created object if success , NIL otherwise

Definition at line 55 of file SCOLDynamicReflectionMap.cpp.

int SO3DynamicReflectionMapGetEnable

(

mmachine

m

)

SO3DynamicReflectionMapGetEnable : Get the enable state for the dynamic reflection map.

Prototype: fun [SO3_OBJECT] I

Parameters:

SO3_OBJECT

: current node

Returns:

I : Enable state if success , NIL otherwise

Definition at line 199 of file SCOLDynamicReflectionMap.cpp.

int SO3DynamicReflectionMapGetRevertClipPlane

(

mmachine

m

)

SO3DynamicReflectionMapGetRevertClipPlane : Get the revert clip plane state (is the camera clip plane up or down?) for the dynamic reflection map.

Prototype: fun [SO3_OBJECT] I

Parameters:

SO3_OBJECT

: current node

Returns:

I : revert clip plane state if success , NIL otherwise

Definition at line 280 of file SCOLDynamicReflectionMap.cpp.

int SO3DynamicReflectionMapGetTextureSize

(

mmachine

m

)

SO3DynamicReflectionMapGetTextureSize : Get the size of the dynamic reflection map texture.

Prototype: fun [SO3_OBJECT] I

Parameters:

SO3_OBJECT

: current node

Returns:

I : Enable state if success , NIL otherwise

Definition at line 362 of file SCOLDynamicReflectionMap.cpp.

int SO3DynamicReflectionMapSetEnable

(

mmachine

m

)

SO3DynamicReflectionMapSetEnable : Set the Enable state for dynamic reflection map.

Prototype: fun [SO3_OBJECT I] I

Parameters:

	SO3_OBJECT	: current node
	I	: bool for enable state

Returns:

I : 1 if success , NIL otherwise

Definition at line 239 of file SCOLDynamicReflectionMap.cpp.

int SO3DynamicReflectionMapSetRevertClipPlane

(

mmachine

m

)

SO3DynamicReflectionMapSetRevertClipPlane : Set the revert clip plane state for dynamic reflection map.

Prototype: fun [SO3_OBJECT I] I

Parameters:

	SO3_OBJECT	: current node
	I	: bool, 1 to revert the clip plane -Y

Returns:

I : 1 if success , NIL otherwise

Definition at line 320 of file SCOLDynamicReflectionMap.cpp.

int SO3DynamicReflectionMapSetTargetMaterial

(

mmachine

m

)

SO3DynamicReflectionMapSetTargetMaterial : Set the material on wich the rendered texture will be setted. The plane reflection map is automatically setted to enable when a valid material is passed.

Prototype: fun [SO3_OBJECT SO3_MATERIAL I I I] SO3_OBJECT

Parameters:

	SO3_OBJECT,:
	SO3_MATERIAL	:
	I	: Technique of the material where to render the reflection map.
	I	: Pass of the material where to render the reflection map.
	I	: Texture unit of the material where to render the reflection map.

Returns:

SO3_OBJECT : Created material if success , NIL otherwise

Definition at line 136 of file SCOLDynamicReflectionMap.cpp.

int SO3DynamicReflectionMapSetTextureSize

(

mmachine

m

)

SO3DynamicReflectionMapSetTextureSize : Set the size of the dynamic reflection map texture.

Prototype: fun [SO3_OBJECT I] I

Parameters:

	SO3_OBJECT	: current node
	I	: bool for enable state

Returns:

I : 1 if success , NIL otherwise

Definition at line 402 of file SCOLDynamicReflectionMap.cpp.

int SO3FlashControlCreateOnMaterial

(

mmachine

m

)

SO3FlashControlCreateOnMaterial : Set a texture flash on a material.

Prototype: fun [SO3_SCENE SO3_MATERIAL S I I I I I] SO3_WIDGET

Parameters:

	SO3_SCENE	: current scene
	SO3_MATERIAL	: current material
	S	: new Name
	I	: width
	I	: height
	I	: given technique
	I	: given pass
	I	: index of the texture

Returns:

SO3_FLASH_CONTROL : The flash control if success , NIL otherwise

Definition at line 257 of file SCOLFlashControl.cpp.

int SO3MaterialCreate

(

mmachine

m

)

main include

SO3MaterialCreate : Create a new material Prototype: fun [SO3_SCENE S S] SO3_MATERIAL

Parameters:

	SO3_SCENE	: current scene
	S	: given name for the new material
	S	: group name

Returns:

SO3_MATERIAL : Created material if success, NIL otherwise

Definition at line 61 of file SCOLMaterial.cpp.

int SO3MaterialDestroy

(

mmachine

m

)

SO3MaterialDestroy : Destroy a material.

Prototype: fun [SO3_MATERIAL] I

Parameters:

SO3_MATERIAL

: current material

Returns:

I : 1 if success, NIL otherwise

Definition at line 116 of file SCOLMaterial.cpp.

int SO3MaterialGetAmbientByTechAndPass

(

mmachine

m

)

SO3MaterialGetAmbientByTechAndPass : Get the ambient color by Technique and Pass.

Prototype: fun [SO3_MATERIAL I I] I

Parameters:

	SO3_MATERIAL	: current material
	I	: index of technique
	I	: index for pass

Returns:

I : Ambient color (rgba) if success, NIL otherwise

Definition at line 778 of file SCOLMaterial.cpp.

int SO3MaterialGetDiffuseByTechAndPass

(

mmachine

m

)

SO3MaterialGetDiffuseByTechAndPass : Get the diffuse color by Technique and Pass.

Prototype: fun [SO3_MATERIAL I I] I

Parameters:

	SO3_MATERIAL	: current material
	I	: index of technique
	I	: index for pass

Returns:

I : Diffuse color (rgba) if success, NIL otherwise

Definition at line 726 of file SCOLMaterial.cpp.

int SO3MaterialGetName

(

mmachine

m

)

SO3MaterialGetName : Return the material name.

Prototype: fun [SO3_MATERIAL] S

Parameters:

SO3_MATERIAL

: current material

Returns:

S : Material name if success, NIL otherwise

Definition at line 155 of file SCOLMaterial.cpp.

int SO3MaterialGetReceiveShadows

(

mmachine

m

)

SO3MaterialGetReceiveShadows : Get the receive shadow state for material.

Prototype: fun [SO3_MATERIAL] I

Parameters:

SO3_MATERIAL

: current material

Returns:

I : for receive shadows state (1 enable, 0 disable) if success, NIL otherwise

Definition at line 390 of file SCOLMaterial.cpp.

int SO3MaterialGetSelfIlluminationByTechAndPass

(

mmachine

m

)

SO3MaterialGetSelfIlluminationByTechAndPass : Get the self illumination color by Technique and Pass.

Prototype: fun [SO3_MATERIAL I I] F

Parameters:

	SO3_MATERIAL	: current material
	I	: index of technique
	I	: index for pass

Returns:

I : self illumination color(rgba) if success, NIL otherwise

Definition at line 933 of file SCOLMaterial.cpp.

int SO3MaterialGetShininessByTechAndPass

(

mmachine

m

)

SO3MaterialGetShininessByTechAndPass : Get the Shininess value by Technique and Pass.

Prototype: fun [SO3_MATERIAL I I] F

Parameters:

	SO3_MATERIAL	: current material
	I	: index of technique
	I	: index for pass

Returns:

F : Shininess value if success, NIL otherwise

Definition at line 882 of file SCOLMaterial.cpp.

int SO3MaterialGetSpecularByTechAndPass

(

mmachine

m

)

SO3MaterialGetSpecularByTechAndPass : Get the specular color by Technique and Pass.

Prototype: fun [SO3_MATERIAL I I] I

Parameters:

	SO3_MATERIAL	: current material
	I	: index of technique
	I	: index for pass

Returns:

I : Specular color (rgba) if success, NIL otherwise

Definition at line 830 of file SCOLMaterial.cpp.

int SO3MaterialGetTexture

(

mmachine

m

)

SO3MaterialGetTexture : Get a texture from a material.

Prototype: fun [SO3_MATERIAL I I I] SO3_TEXTURE

Parameters:

	SO3_MATERIAL	: current material
	I	: given technique
	I	: given pass
	I	: index of the texture

Returns:

SO3_TEXTURE : Return the texture if success , NIL otherwise

Definition at line 1599 of file SCOLMaterial.cpp.

int SO3MaterialGetTextureRotate

(

mmachine

m

)

SO3MaterialGetTextureRotate : Gets the rotation of the texture.

Prototype: fun [SO3_MATERIAL I I I] F

Parameters:

	SO3_MATERIAL	:
	I	: Technique of the material.
	I	: Pass of the material.
	I	: Texture unit of the material.

Returns:

F : rotation value, NIL if error

Definition at line 2585 of file SCOLMaterial.cpp.

int SO3MaterialGetTextureUScale

(

mmachine

m

)

SO3MaterialGetTextureUScale : Gets the scale of the texture, for the U value.

Prototype: fun [SO3_MATERIAL I I I] F

Parameters:

	SO3_MATERIAL	:
	I	: Technique of the material.
	I	: Pass of the material.
	I	: Texture unit of the material.

Returns:

F : U scale value, NIL if error

Definition at line 2357 of file SCOLMaterial.cpp.

int SO3MaterialGetTextureUScroll

(

mmachine

m

)

SO3MaterialGetTextureUScroll : Gets the translation offset of the texture, ie scrolls the texture, for the U value.

Prototype: fun [SO3_MATERIAL I I I] F

Parameters:

	SO3_MATERIAL	:
	I	: Technique of the material.
	I	: Pass of the material.
	I	: Texture unit of the material.

Returns:

F : U Scroll value, NIL if error

Definition at line 2129 of file SCOLMaterial.cpp.

int SO3MaterialGetTextureVScale

(

mmachine

m

)

SO3MaterialGetTextureVScale : Gets the scale of the texture, for the V value.

Prototype: fun [SO3_MATERIAL I I I] F

Parameters:

	SO3_MATERIAL	:
	I	: Technique of the material.
	I	: Pass of the material.
	I	: Texture unit of the material.

Returns:

F : V scale value, NIL if error

Definition at line 2471 of file SCOLMaterial.cpp.

int SO3MaterialGetTextureVScroll

(

mmachine

m

)

SO3MaterialGetTextureVScroll : Gets the translation offset of the texture, ie scrolls the texture, for the V value.

Prototype: fun [SO3_MATERIAL I I I] F

Parameters:

	SO3_MATERIAL	:
	I	: Technique of the material.
	I	: Pass of the material.
	I	: Texture unit of the material.

Returns:

F : V Scroll value, NIL if error

Definition at line 2243 of file SCOLMaterial.cpp.

int SO3MaterialIsLighting

(

mmachine

m

)

SO3MaterialIsLighting : defines light state for a material.

Prototype: fun [SO3_MATERIAL I] I

Parameters:

	SO3_MATERIAL	: current material
	I	: Light state (1 enable, 0 disable)

Returns:

I : 1 if success, NIL otherwise

Definition at line 984 of file SCOLMaterial.cpp.

int SO3MaterialNumberOfPassesByTechnique

(

mmachine

m

)

SO3MaterialNumberOfPassesByTechnique : Get the number of passes by technique.

Prototype: fun [SO3_MATERIAL I] I

Parameters:

	SO3_MATERIAL	: current material
	I	: techniques index

Returns:

I : Number of pass if success, NIL otherwise

Definition at line 1063 of file SCOLMaterial.cpp.

int SO3MaterialNumberOfTechniques

(

mmachine

m

)

SO3MaterialNumberOfTechniques : Get the number of techniques.

Prototype: fun [SO3_MATERIAL] I

Parameters:

SO3_MATERIAL

: current material

Returns:

I : Number of techniques if success, NIL otherwise

Definition at line 1025 of file SCOLMaterial.cpp.

int SO3MaterialNumberOfTexturesByTechniqueAndPass

(

mmachine

m

)

SO3MaterialNumberOfTexturesByTechniqueAndPass : Get the number of textures by technique and pass.

Prototype: fun [SO3_MATERIAL I I] I

Parameters:

	SO3_MATERIAL	: current material
	I	: techniques index
	I	: pass index

Returns:

I : Number of textures if success, NIL otherwise

Definition at line 1113 of file SCOLMaterial.cpp.

int SO3MaterialPassGetIndexByName

(

mmachine

m

)

SO3MaterialPassGetIndexByName : return the index of a pass by name.

Prototype: fun [SO3_MATERIAL I S] I

Parameters:

	SO3_MATERIAL	: current material
	I	: technique index
	S	: pass name

Returns:

I : Pass index if success, NIL otherwise

Definition at line 1312 of file SCOLMaterial.cpp.

int SO3MaterialPassGetNameByIndex

(

mmachine

m

)

SO3MaterialPassGetNameByIndex : return the name of a pass.

Prototype: fun [SO3_MATERIAL I I] S

Parameters:

	SO3_MATERIAL	: current material
	I	: technique index
	I	: pass index

Returns:

S : pass name if success, NIL otherwise

Definition at line 1260 of file SCOLMaterial.cpp.

int SO3MaterialSetAmbient

(

mmachine

m

)

SO3MaterialSetAmbient : defines ambient color of a material.

Prototype: fun [SO3_MATERIAL I] I

Parameters:

	SO3_MATERIAL	: current material
	I	: given color (rgba)

Returns:

I : 1 if success, NIL otherwise

Definition at line 186 of file SCOLMaterial.cpp.

int SO3MaterialSetAmbientByTechAndPass

(

mmachine

m

)

SO3MaterialSetAmbientByTechAndPass : defines ambient color by technique and pass of a material.

Prototype: fun [SO3_MATERIAL I I I] I

Parameters:

	SO3_MATERIAL	: current material
	I	: index of technique
	I	: index for pass
	I	: given color (rgba)

Returns:

I : 1 if success, NIL otherwise

Definition at line 231 of file SCOLMaterial.cpp.

int SO3MaterialSetDiffuse

(

mmachine

m

)

SO3MaterialSetDiffuse : defines diffuse color of a material.

Prototype: fun [SO3_MATERIAL I] I

Parameters:

	SO3_MATERIAL	: current material
	I	: given color (rgba)

Returns:

I : 1 if success, NIL otherwise

Definition at line 288 of file SCOLMaterial.cpp.

int SO3MaterialSetDiffuseByTechAndPass

(

mmachine

m

)

SO3MaterialSetDiffuseByTechAndPass : defines diffuse color by technique and pass of a material.

Prototype: fun [SO3_MATERIAL I I I] I

Parameters:

	SO3_MATERIAL	: current material
	I	: index of technique
	I	: index for pass
	I	: given color (rgba)

Returns:

I : 1 if success, NIL otherwise

Definition at line 334 of file SCOLMaterial.cpp.

int SO3MaterialSetReceiveShadows

(

mmachine

m

)

SO3MaterialSetReceiveShadows : defines receive shadow state for a given material.

Prototype: fun [SO3_MATERIAL I] I

Parameters:

	SO3_MATERIAL	: current material
	I	: receive shadow state (1 enable, 0 disable)

Returns:

I : 1 if success, NIL otherwise

Definition at line 1489 of file SCOLMaterial.cpp.

int SO3MaterialSetSelfIllumination

(

mmachine

m

)

SO3MaterialSetSelfIllumination : defines self illuminaton color of a material.

Prototype: fun [SO3_MATERIAL I] I

Parameters:

	SO3_MATERIAL	: current material
	I	: given color (rgba)

Returns:

I : 1 if success, NIL otherwise

Definition at line 429 of file SCOLMaterial.cpp.

int SO3MaterialSetSelfIlluminationByTechAndPass

(

mmachine

m

)

SO3MaterialSetSelfIlluminationByTechAndPass : defines self illumination color by technique and pass of a material.

Prototype: fun [SO3_MATERIAL I I I] I

Parameters:

	SO3_MATERIAL	: current material
	I	: index of technique
	I	: index for pass
	I	: given color (rgba)

Returns:

I : 1 if success, NIL otherwise

Definition at line 475 of file SCOLMaterial.cpp.

int SO3MaterialSetShininess

(

mmachine

m

)

SO3MaterialSetShininess : defines shininess value of a material.

Prototype: fun [SO3_MATERIAL F] I

Parameters:

	SO3_MATERIAL	: current material
	F	: given value

Returns:

I : 1 if success, NIL otherwise

Definition at line 634 of file SCOLMaterial.cpp.

int SO3MaterialSetShininessByTechAndPass

(

mmachine

m

)

SO3MaterialSetShininessByTechAndPass : defines shininess value by technique and pass of a material.

Prototype: fun [SO3_MATERIAL I I I] I

Parameters:

	SO3_MATERIAL	: current material
	I	: index of technique
	I	: index for pass
	I	: shininess value

Returns:

I : 1 if success, NIL otherwise

Definition at line 674 of file SCOLMaterial.cpp.

int SO3MaterialSetSpecular

(

mmachine

m

)

SO3MaterialSetSpecular : defines specular color of a material.

Prototype: fun [SO3_MATERIAL I] I

Parameters:

	SO3_MATERIAL	: current material
	I	: given color (rgba)

Returns:

I : 1 if success, NIL otherwise

Definition at line 532 of file SCOLMaterial.cpp.

int SO3MaterialSetSpecularByTechAndPass

(

mmachine

m

)

SO3MaterialSetSpecularByTechAndPass : defines specular color by technique and pass of a material.

Prototype: fun [SO3_MATERIAL I I I] I

Parameters:

	SO3_MATERIAL	: current material
	I	: index of technique
	I	: index for pass
	I	: given color (rgba)

Returns:

I : 1 if success, NIL otherwise

Definition at line 577 of file SCOLMaterial.cpp.

int SO3MaterialSetTexture

(

mmachine

m

)

SO3MaterialSetTexture : Set a texture on a material.

Prototype: fun [SO3_MATERIAL SO3_TEXTURE I I I] I

Parameters:

	SO3_MATERIAL	: current material
	SO3_MATERIAL	: current texture
	I	: given technique
	I	: given pass
	I	: index of the texture

Returns:

I : 1 if success , NIL otherwise

Definition at line 1535 of file SCOLMaterial.cpp.

int SO3MaterialSetTextureRotate

(

mmachine

m

)

SO3MaterialSetTextureRotate : Rotate the texture.

Prototype: fun [SO3_MATERIAL I I I F] I

Parameters:

	SO3_MATERIAL	:
	I	: Technique of the material.
	I	: Pass of the material.
	I	: Texture unit of the material.
	F	: Rotation angle, in radians.

Returns:

I : 1 if success , NIL otherwise

Definition at line 2527 of file SCOLMaterial.cpp.

int SO3MaterialSetTextureRotateAnimation

(

mmachine

m

)

SO3MaterialSetTextureRotateAnimation : Set a rotate animation on the texture.

Prototype: fun [SO3_MATERIAL I I I F] I

Parameters:

	SO3_MATERIAL	:
	I	: Technique of the material.
	I	: Pass of the material.
	I	: Texture unit of the material.
	F	: The number of complete anticlockwise revolutions per second.

Returns:

I : 1 if success , NIL otherwise

Definition at line 2641 of file SCOLMaterial.cpp.

int SO3MaterialSetTextureScrollAnimation

(

mmachine

m

)

SO3MaterialSetTextureScrollAnimation : Set a scroll animation on the texture.

Prototype: fun [SO3_MATERIAL I I I F F] I

Parameters:

	SO3_MATERIAL	:
	I	: Technique of the material.
	I	: Pass of the material.
	I	: Texture unit of the material.
	F	: The number of horizontal loops per second (+v=moving right, -v = moving left)
	F	: The number of vertical loops per second (+v=moving up, -v= moving down)

Returns:

I : 1 if success , NIL otherwise

Definition at line 2700 of file SCOLMaterial.cpp.

int SO3MaterialSetTextureUScale

(

mmachine

m

)

SO3MaterialSetTextureUScale : Sets the scale value of the texture, for the U value.

Prototype: fun [SO3_MATERIAL I I I F] I

Parameters:

	SO3_MATERIAL	:
	I	: Technique of the material.
	I	: Pass of the material.
	I	: Texture unit of the material.
	F	: U scale value.

Returns:

I : 1 if success , NIL otherwise

Definition at line 2299 of file SCOLMaterial.cpp.

int SO3MaterialSetTextureUScroll

(

mmachine

m

)

SO3MaterialSetTextureUScroll : Sets the translation offset of the texture, ie scrolls the texture, for the U value.

Prototype: fun [SO3_MATERIAL I I I F] I

Parameters:

	SO3_MATERIAL	:
	I	: Technique of the material.
	I	: Pass of the material.
	I	: Texture unit of the material.
	F	: U Scroll value.

Returns:

I : 1 if success , NIL otherwise

Definition at line 2071 of file SCOLMaterial.cpp.

int SO3MaterialSetTextureVScale

(

mmachine

m

)

SO3MaterialSetTextureVScale : Sets the scale of the texture, for the V value.

Prototype: fun [SO3_MATERIAL I I I F] I

Parameters:

	SO3_MATERIAL	:
	I	: Technique of the material.
	I	: Pass of the material.
	I	: Texture unit of the material.
	F	: V scale value.

Returns:

I : 1 if success , NIL otherwise

Definition at line 2413 of file SCOLMaterial.cpp.

int SO3MaterialSetTextureVScroll

(

mmachine

m

)

SO3MaterialSetTextureVScroll : Sets the translation offset of the texture, ie scrolls the texture, for the V value.

Prototype: fun [SO3_MATERIAL I I I F] I

Parameters:

	SO3_MATERIAL	:
	I	: Technique of the material.
	I	: Pass of the material.
	I	: Texture unit of the material.
	F	: V Scroll value.

Returns:

I : 1 if success , NIL otherwise

Definition at line 2185 of file SCOLMaterial.cpp.

int SO3MaterialTechniqueGetIndexByName

(

mmachine

m

)

SO3MaterialTechniqueGetIndexByName : return the index of a technique by name.

Prototype: fun [SO3_MATERIAL S] I

Parameters:

	SO3_MATERIAL	: current material
	S	: Technique's name

Returns:

I : Technique index if success, NIL otherwise

Definition at line 1213 of file SCOLMaterial.cpp.

int SO3MaterialTechniqueGetNameByIndex

(

mmachine

m

)

SO3MaterialTechniqueGetNameByIndex : return the name of a technique.

Prototype: fun [SO3_MATERIAL I] S

Parameters:

	SO3_MATERIAL	: current material
	I	: techniques index

Returns:

S : Technique's name if success, NIL otherwise

Definition at line 1164 of file SCOLMaterial.cpp.

int SO3MaterialTextureUnitGetIndexByName

(

mmachine

m

)

SO3MaterialTextureUnitGetIndexByName : return the index of a Texture unit by name.

Prototype: fun [SO3_MATERIAL I I S] I

Parameters:

	SO3_MATERIAL	: current material
	I	: technique index
	I	: pass index
	S	: Texture unit name

Returns:

I : Texture unit index if success, NIL otherwise

Definition at line 1428 of file SCOLMaterial.cpp.

int SO3MaterialTextureUnitGetNameByIndex

(

mmachine

m

)

SO3MaterialTextureUnitGetNameByIndex : return the name of a texture unit.

Prototype: fun [SO3_MATERIAL I I I] S

Parameters:

	SO3_MATERIAL	: current material
	I	: technique index
	I	: pass index
	I	: Texture unit index

Returns:

S : Texture unit name if success, NIL otherwise

Definition at line 1373 of file SCOLMaterial.cpp.

int SO3TextureBlit

(

mmachine

m

)

SO3TextureBlit : Blit a ObjBitmap on a texture.

Prototype: fun [SO3_TEXTURE ObjBitmap] I

Parameters:

	SO3_TEXTURE	: current texture
	ObjBitmap	: ObjBitmap to blit

Returns:

I : 1 if success , NIL otherwise

Definition at line 1826 of file SCOLMaterial.cpp.

int SO3TextureBlitAlpha

(

mmachine

m

)

SO3TextureBlitAlpha : Blit a AlphaBitmap on a texture.

Prototype: fun [SO3_TEXTURE AlphaBitmap] I

Parameters:

	SO3_TEXTURE	: current texture
	AlphaBitmap	: AlphaBitmap to blit

Returns:

I : 1 if success , NIL otherwise

Definition at line 1940 of file SCOLMaterial.cpp.

int SO3TextureCreate

(

mmachine

m

)

SO3TextureCreate : Create a texture unit.

Prototype: fun [SO3_SCENE S P S I I] SO3_TEXTURE

Parameters:

	SO3_SCENE	: current scene
	S	: name of the new texture
	P	: file of the texture
	S	: the resource group of the texture
	I	: width of the image in pixels
	I	: height of the image in pixels

Returns:

SO3_TEXTURE : The created texture if success , NIL otherwise

Definition at line 1675 of file SCOLMaterial.cpp.

int SO3TextureDestroy

(

mmachine

m

)

SO3TextureDestroy : Destroy a texture unit.

Prototype: fun [SO3_TEXTURE] I

Parameters:

SO3_TEXTURE

: current texture

Returns:

I : 1 if success , NIL otherwise

Definition at line 1734 of file SCOLMaterial.cpp.

int SO3TextureGetName

(

mmachine

m

)

SO3TextureGetName : Return the name of a texture.

Prototype: fun [SO3_TEXTURE] S

Parameters:

SO3_TEXTURE

: current texture

Returns:

S : Texture's name if success , NIL otherwise

Definition at line 1759 of file SCOLMaterial.cpp.

int SO3TextureManagerGetMemoryUsage

(

mmachine

m

)

SO3TextureManagerGetMemoryUsage : Return the memory usage of all textures in the scene.

Prototype: fun [SO3_SCENE] S

Parameters:

SO3_SCENE

: current scene

Returns:

I : memory usage if success , NIL otherwise

Definition at line 1791 of file SCOLMaterial.cpp.