Package AgateLib

The root AgateLib namespace. More...

Classes
class	AgateException
	Base exception class for exceptions which are thrown by AgateLib. More...
class	AgateCrossPlatformException
	Exception which is thrown when AgateLib detects that it is used in a way that may not be portable to different platforms, and Core.CrossPlatformDebugLevel is set to Exception. More...
class	AgateFileProvider
	Provides an interface for opening files. Objects implementing IFileProvider can be added to separate lists for images, sounds, etc. which are used to find files when Surfaces, SoundBuffers, etc. are constructed. More...
class	AgateSetup
	Class which is designed to simplify initialization and de-initialization of the library. It is recommended to have a Setup object in a using block around your game code so that calling Dispose is guaranteed. More...
class	Core
	Class which contains methods commonly used by the entire library. More...
class	Timing
	Static class which handles timing. This is often used to update object positions and animations. More...
Enumerations
enum	ErrorLevel { Comment, Warning, Fatal, Bug }
	Used by AgateLib.Core class's error reporting functions to indicate how severe an error is. More...
enum	CrossPlatformDebugLevel { None, Comment, Exception }
	Enum used to inidicate the level of cross-platform debugging that should occur. More...

---

Detailed Description

The root AgateLib namespace.

---

Enumeration Type Documentation

enum AgateLib::CrossPlatformDebugLevel

Enum used to inidicate the level of cross-platform debugging that should occur.

Enumerator:

None	Ignores any issues related to cross platform deployment.
Comment	Outputs comments using Core.ReportError with a comment level.
Exception	Throws exceptions on issues that may cause problems when operating on another platform.

enum AgateLib::ErrorLevel

Used by AgateLib.Core class's error reporting functions to indicate how severe an error is.

Enumerator:

Comment	Indicates an message is just a comment, and safe to ignore.
Warning	Indicates that the error message is not severe, and the program may continue. However, unexpected behavior may occur due to the result of this error.
Fatal	Indicates that the error condition is too severe and the program may not continue.
Bug	Indicates the error condition indicates some assumption has not held that should have. This should only be used if the condition is caused by a bug in the code.