AgateLib: ERY.AgateLib.AgateSetup Class Reference

List of all members.


Public Member Functions
	AgateSetup ()
	Constructs a Setup object.
	AgateSetup (string title)
	Constructs a Setup object.
	AgateSetup (string[] args)
	Constructs a Setup object.
	AgateSetup (string title, string[] args)
	Constructs a Setup object.
void	Initialize (bool display, bool audio, bool input)
	Initializes the specified components. This sets the values of UseDisplay, UseAudio, and UseInput to the values passed in.
void	InitializeAll ()
	Initializes the Display, Audio and Input controllers.
void	InitializeDisplay ()
	Initializes the display. Automatically selects the driver to use, or asks the user which driver to use if appropriate.
void	InitializeDisplay (DisplayTypeID type)
	Initializes the display to the specified subsystem.
void	InitializeAudio ()
	Initializes the Audio subsystem. Automatically picks which driver to use.
void	InitializeAudio (AudioTypeID type)
	Initializes the Audio subsystem, to the specified driver.
void	InitializeInput ()
	Initializes the Input subsystem. Automatically picks which driver to use.
void	InitializeInput (InputTypeID inputTypeID)
	Initializes the Input subsystem, to the specified driver.
void	Dispose ()
	Disposes of the SetupDisplay object and all initialized sub-systems.
Properties
bool	Cancel `[get]`
	Returns true if the user hit cancel in any dialog box that showed up asking the user what driver to use, or if initialization failed.
bool	AskUser `[get, set]`
	Gets or sets a bool value which indicates whether or not the user should be asked which driver(s) to use when Agate is initialized.
bool	UseDisplay `[get, set]`
	Gets or sets a bool value which indicates whether or not the display should be initialized.
bool	UseAudio `[get, set]`
	Gets or sets a bool value which indicates whether or not the audio system should be initialized.
bool	UseInput `[get, set]`
	Gets or sets a bool value which indicates whether or not the input system should be initialized.

Detailed Description

If the program arguments are supplied, you can allow the user to choose which drivers are used, if the --choose option is specified.

This example shows a typical development pattern for the use of an AgateSetup object.

        using System;
        using System.Collections.Generic;
        using ERY.AgateLib;
        
        public static void Main(string[] args)
        {
            using(AgateSetup setup = new AgateSetup("My Application Name", args))
            {
                setup.InitializeAll();
                if (setup.Cancel)
                    return;
        
TODO: write game here
            }
        }

Constructor & Destructor Documentation

ERY.AgateLib.AgateSetup.AgateSetup ( )

Constructs a Setup object.

ERY.AgateLib.AgateSetup.AgateSetup ( string title )

Constructs a Setup object.

Parameters:

title

ERY.AgateLib.AgateSetup.AgateSetup ( string[] args )

Constructs a Setup object.

Parameters:

args

Command line arguments to the program.

ERY.AgateLib.AgateSetup.AgateSetup	(	string	title,
		string[]	args
	)

Constructs a Setup object.

Parameters:

	title
	args	Command line arguments to the program.

Member Function Documentation

void ERY.AgateLib.AgateSetup.Initialize	(	bool	display,
		bool	audio,
		bool	input
	)

Initializes the specified components. This sets the values of UseDisplay, UseAudio, and UseInput to the values passed in.

Parameters:

	display
	audio
	input

void ERY.AgateLib.AgateSetup.InitializeAll ( )

Initializes the Display, Audio and Input controllers.

void ERY.AgateLib.AgateSetup.InitializeDisplay ( )

Initializes the display. Automatically selects the driver to use, or asks the user which driver to use if appropriate.

void ERY.AgateLib.AgateSetup.InitializeDisplay ( DisplayTypeID type )

Initializes the display to the specified subsystem.

Parameters:

type

void ERY.AgateLib.AgateSetup.InitializeAudio ( )

Initializes the Audio subsystem. Automatically picks which driver to use.

void ERY.AgateLib.AgateSetup.InitializeAudio ( AudioTypeID type )

Initializes the Audio subsystem, to the specified driver.

Parameters:

type

void ERY.AgateLib.AgateSetup.InitializeInput ( )

Initializes the Input subsystem. Automatically picks which driver to use.

void ERY.AgateLib.AgateSetup.InitializeInput ( InputTypeID inputTypeID )

Initializes the Input subsystem, to the specified driver.

Parameters:

inputTypeID

void ERY.AgateLib.AgateSetup.Dispose ( )

Disposes of the SetupDisplay object and all initialized sub-systems.

Property Documentation

bool ERY.AgateLib.AgateSetup.Cancel [get]

Returns true if the user hit cancel in any dialog box that showed up asking the user what driver to use, or if initialization failed.

bool ERY.AgateLib.AgateSetup.AskUser [get, set]

Gets or sets a bool value which indicates whether or not the user should be asked which driver(s) to use when Agate is initialized.

This setting can be useful for debugging, especially when comparing OpenGL vs. DirectX behavior and performance. It is recommended to have AskUser turned off for release builds, however.

bool ERY.AgateLib.AgateSetup.UseDisplay [get, set]

Gets or sets a bool value which indicates whether or not the display should be initialized.

bool ERY.AgateLib.AgateSetup.UseAudio [get, set]

Gets or sets a bool value which indicates whether or not the audio system should be initialized.

bool ERY.AgateLib.AgateSetup.UseInput [get, set]

Gets or sets a bool value which indicates whether or not the input system should be initialized.

ERY.AgateLib.AgateSetup Class Reference

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation