ERY.AgateLib.Drivers.Registrar Class Reference

Static class with which drivers register themselves so that the library can instantiate them. More...

List of all members.

Static Public Member Functions

static void Initialize ()
 Searches through FileManager.AssemblyPath for all *.dll files. These files are loaded and searched for classes which derive from DisplayImpl, AudioImpl, etc.
static void RegisterDisplayDriver (DriverInfo< DisplayTypeID > info)
 Registers a display driver as being available.
static void RegisterAudioDriver (DriverInfo< AudioTypeID > info)
 Registers an audio driver as being available.
static void RegisterInputDriver (DriverInfo< InputTypeID > info)
 Registers an input driver as being available.
static bool UserSelectDrivers (bool chooseDisplay, bool chooseAudio, bool chooseInput, out DisplayTypeID selectedDisplay, out AudioTypeID selectedAudio, out InputTypeID selectedInput)
 Asks the user to select which drivers to use.

Properties

static DriverInfoList< DisplayImpl,
DisplayTypeID
DisplayDriverInfo [get]
 Returns a collection with all the DriverInfo<DisplayTypeID> structures for registered display drivers.
static DriverInfoList< AudioImpl,
AudioTypeID
AudioDriverInfo [get]
 Returns a collection with all the DriverInfo<AudioTypeID> structures for registered display drivers.
static DriverInfoList< InputImpl,
InputTypeID
InputDriverInfo [get]
 Returns a collection with all the DriverInfo<InputTypeID> structures for registered display drivers.
static DisplayTypeID CreatedDisplayTypeID [get]
 Returns the identifier for the DisplayImpl which was actually created.
static AudioTypeID CreatedAudioTypeID [get]
 Returns the identifier for the AudioImpl which was actually created.
static InputTypeID CreatedInputTypeID [get]
 Returns the identifier for the InputImpl which was actually created.


Detailed Description

Static class with which drivers register themselves so that the library can instantiate them.


Member Function Documentation

static void ERY.AgateLib.Drivers.Registrar.Initialize (  )  [static]

Searches through FileManager.AssemblyPath for all *.dll files. These files are loaded and searched for classes which derive from DisplayImpl, AudioImpl, etc.

static void ERY.AgateLib.Drivers.Registrar.RegisterDisplayDriver ( DriverInfo< DisplayTypeID info  )  [static]

Registers a display driver as being available.

Parameters:
info Structure which contains enough information to instantiate the display driver's own DisplayImpl derived class.

static void ERY.AgateLib.Drivers.Registrar.RegisterAudioDriver ( DriverInfo< AudioTypeID info  )  [static]

Registers an audio driver as being available.

Parameters:
info Structure which contains enough information to instantiate the audio driver's own AudioImpl derived class.

static void ERY.AgateLib.Drivers.Registrar.RegisterInputDriver ( DriverInfo< InputTypeID info  )  [static]

Registers an input driver as being available.

Parameters:
info Structure which contains enough information to instantiate the input driver's own InputImpl derived class.

static bool ERY.AgateLib.Drivers.Registrar.UserSelectDrivers ( bool  chooseDisplay,
bool  chooseAudio,
bool  chooseInput,
out DisplayTypeID  selectedDisplay,
out AudioTypeID  selectedAudio,
out InputTypeID  selectedInput 
) [static]

Asks the user to select which drivers to use.

Parameters:
chooseDisplay 
chooseAudio 
chooseInput 
selectedDisplay 
selectedAudio 
selectedInput 
Returns:


Property Documentation

DriverInfoList<DisplayImpl, DisplayTypeID> ERY.AgateLib.Drivers.Registrar.DisplayDriverInfo [static, get]

Returns a collection with all the DriverInfo<DisplayTypeID> structures for registered display drivers.

Returns:

DriverInfoList<AudioImpl, AudioTypeID> ERY.AgateLib.Drivers.Registrar.AudioDriverInfo [static, get]

Returns a collection with all the DriverInfo<AudioTypeID> structures for registered display drivers.

Returns:

DriverInfoList<InputImpl, InputTypeID> ERY.AgateLib.Drivers.Registrar.InputDriverInfo [static, get]

Returns a collection with all the DriverInfo<InputTypeID> structures for registered display drivers.

Returns:

DisplayTypeID ERY.AgateLib.Drivers.Registrar.CreatedDisplayTypeID [static, get]

Returns the identifier for the DisplayImpl which was actually created.

AudioTypeID ERY.AgateLib.Drivers.Registrar.CreatedAudioTypeID [static, get]

Returns the identifier for the AudioImpl which was actually created.

InputTypeID ERY.AgateLib.Drivers.Registrar.CreatedInputTypeID [static, get]

Returns the identifier for the InputImpl which was actually created.


The documentation for this class was generated from the following file:
AgateLib
Awesome Game and Tool Engine Library
SourceForge.net Logo