GFXInit

consoledoc.h

Functions for tracking GFX adapters and initializing them into devices.

More...

Public Static Functions

void

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

int

Return the number of graphics adapters available.

String
getAdapterMode(int index, int modeIndex)

Gets the details of the specified adapter mode.

int

Gets the number of modes available on the specified adapter.

String
getAdapterName(int index)

Returns the name of the graphics adapter.

String

Returns the name of the graphics adapter's output display device.

float

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

getAdapterType(int index)

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

int

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.

Public Static Functions

createNullDevice()

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

getAdapterCount()

Return the number of graphics adapters available.

getAdapterMode(int index, int modeIndex)

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.

return:

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

getAdapterModeCount(int index)

Gets the number of modes available on the specified adapter.

Parameters:

index

Index of the adapter to get modes from.

return:

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

getAdapterName(int index)

Returns the name of the graphics adapter.

Parameters:

index

The index of the adapter.

getAdapterOutputName(int index)

Returns the name of the graphics adapter's output display device.

Parameters:

index

The index of the adapter.

getAdapterShaderModel(int index)

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

Parameters:

index

The index of the adapter.

getAdapterType(int index)

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

Parameters:

index

The index of the adapter.

getDefaultAdapterIndex()

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