GFXCardProfilerAPI

This class is the interface between TorqueScript and GFXCardProfiler.

Public Static Functions

String

getBestDepthFormat()

Returns the card name.

String

getCard()

Returns the card name.

String

getRenderer()

Returns the renderer name. For example D3D11 or OpenGL.

String

GetVendor()

Returns the card vendor name.

String

getVersion()

Returns the driver version string.

int

getVideoMemoryMB()

Returns the amount of video memory in megabytes.

int

queryProfile(string name, int defaultValue)

Used to query the value of a specific card capability.

void

setCapability(string name, int value)

Used to set the value for a specific card capability.

Detailed Description

This class is the interface between TorqueScript and GFXCardProfiler.

You will not actually declare GFXCardProfilerAPI in TorqueScript. It exists solely to give access to the GFXCardProfiler's querying functions, such as GFXCardProfiler::getRenderer.

// Example of accessing GFXCardProfiler function from script
// Notice you are not using the API version
%videoMem = GFXCardProfiler::getVideoMemoryMB();

see:

GFXCardProfiler for more information

Public Static Functions

getBestDepthFormat()

Returns the card name.

getCard()

Returns the card name.

getRenderer()

Returns the renderer name. For example D3D11 or OpenGL.

GetVendor()

Returns the card vendor name.

getVersion()

Returns the driver version string.

getVideoMemoryMB()

Returns the amount of video memory in megabytes.

queryProfile(string name, int defaultValue)

Used to query the value of a specific card capability.

Parameters:

name	The name of the capability being queried.
defaultValue	The value to return if the capability is not defined.

setCapability(string name, int value)

Used to set the value for a specific card capability.

Parameters:

name	The name of the capability being set.
value	The value to set for that capability.