EQUINOX-3D

[1 introduction] [2 overview] [3 reference] [4 GUI]

Index

 E3dMaterial_Print
 E3dMaterial_AppendTexture
 E3dMaterial_InsertTexture
 E3dMaterial_AddTexture
 E3dMaterial_RemoveTexture
 E3dMaterial_UpdateClone
 E3dMaterial_SetShader
 E3dMaterial_ConvertShader
 E3dMaterial_GetDiffuseColorRGB

E3dMaterial_Print

Print out the attributes of a Material

Syntax
void E3dMaterial_Print(E3dMaterial* PMaterial, const int PIndent)

Argument
PMaterial The Material to dump out PIndent Indent each line by this many spaces
Description
Prints the attributes of the given Material to the standard output.

Return value
None.

E3dMaterial_AppendTexture

Append a Texture to a Material

Syntax
void E3dMaterial_AppendTexture(E3dMaterial* PMaterial, E3d2DTexture* PTexture)

Arguments
PMaterial Pointer to the Material PTexture Pointer to the Texture
Description
Appends the given Texture to the given Material's dynamically allocated Textures array.

Return value
None.

E3dMaterial_InsertTexture

Append a Texture to a Material

Syntax
void E3dMaterial_InsertTexture(E3dMaterial* PMaterial, E3d2DTexture* PTexture, const EIndex PWhere)

Arguments
PMaterial Pointer to the Material PTexture Pointer to the Texture PWhere Position in the array
Description
Insert the given Texture to the given Material's Textures array, before the index LWhere.

Return value
None.

E3dMaterial_AddTexture

Add a Texture to a Material

Syntax
E3d2DTexture* E3dMaterial_AddTexture(E3dMaterial* PMaterial)

Arguments
PMaterial Pointer to the Material
Description
Creates a new Texture and adds it to the given Material.

Return value
Pointer to the new Texture, or NULL in case of an error

E3dMaterial_RemoveTexture

Remove a Texture from a Material

Syntax
void E3dMaterial_RemoveTexture(E3dMaterial* PMaterial, E3d2DTexture* PTexture)

Arguments
PMaterial Pointer to the Material PTexture Pointer to the Texture
Description
Removes the given Texture from the given Material's dynamically allocated Textures array.

Return value
None.

E3dMaterial_UpdateClone

Update a Material's clone when the original changes

Syntax
EChangeFlags E3dMaterial_UpdateClone(const E3dMaterial* PSrcMaterial, E3dRenderer* PRenderer, E3dMaterial* PDstMaterial)

Arguments
PSrcMaterial The original Material PDstMaterial The clone PRenderer Renderer for specifying sampling parameters
Description
Checks if PDstMaterial->ChangeCount < PSrcMaterial->ChangeCount and if so, applies changes in PSrcMaterial to PDstMaterial. If PRenderer is not NULL, anisotropic texture sampline and color model (RGB vs. spectral) parameters are used from it. / Otherwise anisotropic sampline will be disabled and the color model will be RGB on PDstMaterial's Textures.

Return value
E3dChg flags to indicate what changed.

See also
E3dScene_MaterialCopy

E3dMaterial_SetShader

Set a Material's Shader

Syntax
void E3dMaterial_SetShader(E3dMaterial* PMaterial, E3dShader* PShader)

Argument
PMaterial The E3dMaterial to be initialized PShader Shader to be added to the Material
Description
Sets the Shader on PMaterial. If PMaterial already had a Shader, that Shader will be freed.

Return value
None.

See also
E3dMaterial_New, E_Delete

E3dMaterial_ConvertShader

Set a Material's Shader

Syntax
void E3dMaterial_ConvertShader(E3dMaterial* PMaterial, E3dShader* PShader)

Argument
PMaterial The E3dMaterial to be initialized PShader Shader to be added to the Material
Description
Sets the Shader on PMaterial. If PMaterial already had a Shader, this funcion will attempt to convert that Shader to the Class of the new Shader and then free the old Shader.

Return value
None.

See also
E3dMaterial_New, E_Delete

E3dMaterial_GetDiffuseColorRGB

Returns the "Diffuse" color of a Material's shader

Syntax
EBool E3dMaterial_GetDiffuseColorRGB(const E3dMaterial* PMaterial, EcRGBf32Color* PResult)

Arguments
PMaterial Pointer to the Material PResult The result will be stored here
Description
If PMaterial's Shader has a Resource called "Diffuse" that is type EResFLOAT32_3 or EResCOLOR, return it as RGB values in PResult.

Return value
TRUE if a Diffuse color was found, otherwise FALSE.