Class diagram for ptc::BaseConsole:

This class provides the interface for accessing the display frame buffer and basic keyboard routines.
It extends the surface interface so that the display frame buffer memory may be accessed as a surface.
[virtual]Virtual destructor.
[pure virtual]Configures the console by reading option strings from the text file file.
If the configuration file does not exist or cannot be read, this function will fail silently. No exception will be thrown in this case.
todo: example configuration file plus explanation.
Reimplemented in ptc::Console.
[pure virtual]Returns a read only pointer to the list of display modes provided by the console.
This list contains only fullscreen display modes. If the console is not capable of fullscreen output then the mode list will be empty.
If the display platform does not provide a mode list then this list will be empty.
To iterate through the mode list start with the mode object at index zero and work your way through the mode list until you find a mode that is invalid. Do not make any assumptions about the size of the mode list. Any entries after the first invalid entry are undefined.
The following code shows how to iterate through the mode list:
// get the console mode list
const Mode *modes = console.modes();
// mode index
int index = 0;
// iterate through all modes
while (modes[index].valid())
{
// get mode information
int width = modes[i].width();
int height = modes[i].height();
Format format = modes[i].format();
// do something...
// next mode
index ++;
}
Reimplemented in ptc::Console.
[pure virtual]Opens the console with the default width, height and pixel format.
Reimplemented in ptc::Console.
[pure virtual]Opens the console with the default width and height, and the pixel format format.
Reimplemented in ptc::Console.
[pure virtual]Opens the console with the dimensions width by height, and the pixel format format.
Reimplemented in ptc::Console.
[pure virtual]Opens the console with the display mode mode.
If the console does not support the display mode then this function will fail by throwing a ptc::Error exception.
Reimplemented in ptc::Console.
[pure virtual]Closes the console.
If the console is not open then this function will return immediately without reporting an error.
If the console is still locked then this function will throw a ptc::Error exception.
Reimplemented in ptc::Console.
[pure virtual]
Reimplemented in ptc::Console.
[pure virtual]
Reimplemented in ptc::Console.
[pure virtual]
Reimplemented in ptc::Console.
[pure virtual]
Reimplemented in ptc::Console.
[pure virtual]
Reimplemented in ptc::Console.
[pure virtual]
Reimplemented in ptc::Console.
[pure virtual]
Reimplemented in ptc::Console.
[pure virtual]
Reimplemented in ptc::Console.
[pure virtual]
Reimplemented in ptc::Console.
[pure virtual]
Reimplemented in ptc::Console.