GFXInit Class Reference
[GFX]

Functions for tracking GFX adapters and initializing them into devices. More...

List of all members.

Static Public Member Functions
static void	createNullDevice ()
	Create the NULL graphics device used for testing or headless operation.
static int	getAdapterCount ()
	Return the number of graphics adapters available.
static String	getAdapterMode (int index, int modeIndex)
	Gets the details of the specified adapter mode.
static int	getAdapterModeCount (int index)
	Gets the number of modes available on the specified adapter.
static String	getAdapterName (int index)
	Returns the name of the graphics adapter.
static float	getAdapterShaderModel (int index)
	Returns the supported shader model of the graphics adapter or -1 if the index is bad.
static GFXAdapterType	getAdapterType (int index)
	Returns the type (D3D9, D3D8, GL, Null) of a graphics adapter.
static int	getDefaultAdapterIndex ()
	Returns the index of the default graphics adapter. This is the graphics device which will be used to initialize the engine.

---

Detailed Description

Functions for tracking GFX adapters and initializing them into devices.

---

Member Function Documentation

static void GFXInit::createNullDevice

(

)

[static]

Create the NULL graphics device used for testing or headless operation.

static String GFXInit::getAdapterMode	(	int	index,
		int	modeIndex
	)			[static]

Gets the details of the specified adapter mode.

Parameters:

	index	Index of the adapter to query.
	modeIndex	Index of the mode to get data from.

Returns:

A video mode string in the format 'width height fullscreen bitDepth refreshRate aaLevel'.

See also:

GuiCanvas::getVideoMode()

static int GFXInit::getAdapterModeCount

(

int

index

)

[static]

Gets the number of modes available on the specified adapter.

Parameters:

index

Index of the adapter to get modes from.

Returns:

The number of video modes supported by the adapter or -1 if the given adapter was not found.

static String GFXInit::getAdapterName

(

int

index

)

[static]

Returns the name of the graphics adapter.

Parameters:

index

The index of the adapter.

static float GFXInit::getAdapterShaderModel

(

int

index

)

[static]

Returns the supported shader model of the graphics adapter or -1 if the index is bad.

Parameters:

index

The index of the adapter.

static GFXAdapterType GFXInit::getAdapterType

(

int

index

)

[static]

Returns the type (D3D9, D3D8, GL, Null) of a graphics adapter.

Parameters:

index

The index of the adapter.

static int GFXInit::getDefaultAdapterIndex

(

)

[static]

Returns the index of the default graphics adapter. This is the graphics device which will be used to initialize the engine.