Main Page   Modules   File List   File Members  

LuaATI.cpp File Reference


Detailed Description

Scar wrappers for displaying ATI templates from Lua.

System: Scar

>


Functions

void ATI_LoadTemplates (const char *filename)
 Description : Load one or more ATITemplates from a particular script Contents of table SCAR_ATITemplates will be loaded as ATI templates.

void ATI_CreateParameters (sdword size)
 Description : Create a parameter list to be filled out and passed to ATI_DisplayXD Inputs : size - the size of the parameter list.

void ATI_AddFloat (udword index, float param)
 Description : Add a float parameter Inputs : index - index of the parameter param - the parameter.

void ATI_AddColour (udword index, vector4 param)
 Description : Add a colour parameter Inputs : index - index of the parameter param - the parameter.

void ATI_AddString (udword index, const char *param)
 Description : Add a string parameter Inputs : index - index of the parameter param - the string parameter.

void ATI_AddWString (udword index, const wchar_t *param)
 Description : Add a wide string parameter Inputs : index - index of the parameter param - wide string parameter.

void ATI_AddPosition (udword index, vector3 param)
 Description : Add a 3D position parameter Inputs : index - index of the parameter param - the parameter.

void ATI_AddScale (udword index, vector3 param)
 Description : Add a 3D scale parameter Inputs : index - index of the parameter param - the parameter.

void ATI_AddGraphic2D (udword index, const char *param)
 Description : Add a 2D graphic parameter Inputs : index - index of the parameter param - name of a graphic loaded in ATI_LoadTemplates.

void ATI_AddGraphic3D (udword index, const char *param)
 Description : Add a 3D graphic parameter Inputs : index - index of the parameter param - name of a graphic loaded in ATI_LoadTemplates.

void ATI_Display2D (const char *templateName, vector4 rect, udword visibility)
 Description : Display an ATI template using the current parameters Inputs : templateName - name of the template loaded with ATI_LoadTemplates rect - 4 floats that define the ATI rectangle: x, y, w, h visibility - visibility flags.

void ATI_Display3D (const char *templateName, vector3 position, vector3 scale, real32 screenSize, udword visibility)
 Not Implemented.

void ATI_Clear (void)
 Description : Clears ati render frame.


Function Documentation

void ATI_AddColour udword    index,
vector4    param
 

Description : Add a colour parameter Inputs : index - index of the parameter param - the parameter.

4 floats; RGBA

void ATI_AddPosition udword    index,
vector3    param
 

Description : Add a 3D position parameter Inputs : index - index of the parameter param - the parameter.

3 floats; XYZ

void ATI_AddScale udword    index,
vector3    param
 

Description : Add a 3D scale parameter Inputs : index - index of the parameter param - the parameter.

3 floats; sx,sy,sz

void ATI_AddString udword    index,
const char *    param
 

Description : Add a string parameter Inputs : index - index of the parameter param - the string parameter.

Can be a quoted localization ID or a raw string

void ATI_AddWString udword    index,
const wchar_t *    param
 

Description : Add a wide string parameter Inputs : index - index of the parameter param - wide string parameter.

No localization will be done.

void ATI_LoadTemplates const char *    filename
 

Description : Load one or more ATITemplates from a particular script Contents of table SCAR_ATITemplates will be loaded as ATI templates.

Contents of table SCAR_UIGraphic2D will be loaded as UIGraphic2Ds Contents of table SCAR_UIGraphic3D will be loaded as UIGraphic3Ds Also loads UIGraphics if specified Inputs : filename - file to load templates from


Generated on Fri Oct 31 04:05:39 2003 for Scar by doxygen1.3-rc3