Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members
ptc::Console Class Reference
The display frame buffer.
More...
Class diagram for ptc::Console:
List of all members.Public Members
- Console ()
- ~Console ()
- virtual void configure (const char file[])
- virtual bool option (const char option[])
- virtual const Mode* modes ()
- virtual void open (const char title[],int pages = 0)
- virtual void open (const char title[],const Format &format,int pages = 0)
- virtual void open (const char title[],int width,int height,const Format &format,int pages = 0)
- virtual void open (const char title[],const Mode &mode,int pages = 0)
- virtual void close ()
- virtual void flush ()
- virtual void finish ()
- virtual void update ()
- virtual void update (const Area &area)
- virtual bool key ()
- virtual Key read ()
- virtual void copy (BaseSurface &surface)
- virtual void copy (BaseSurface &surface,const Area &source,const Area &destination)
- virtual void* lock ()
- virtual void unlock ()
- virtual void load (const void *pixels,int width,int height,int pitch,const Format &format,const Palette &palette)
- virtual void load (const void *pixels,int width,int height,int pitch,const Format &format,const Palette &palette,const Area &source,const Area &destination)
- virtual void save (void *pixels,int width,int height,int pitch,const Format &format,const Palette &palette)
- virtual void save (void *pixels,int width,int height,int pitch,const Format &format,const Palette &palette,const Area &source,const Area &destination)
- virtual void clear ()
- virtual void clear (const Color &color)
- virtual void clear (const Color &color,const Area &area)
- virtual void palette (const Palette &palette)
- virtual const Palette& palette () const
- virtual void clip (const Area &area)
- virtual int width () const
- virtual int height () const
- virtual int pages () const
- virtual int pitch () const
- virtual const Area& area () const
- virtual const Area& clip () const
- virtual const Format& format () const
- virtual const char* name () const
- virtual const char* title () const
- virtual const char* information () const
Detailed Description
The display frame buffer.
The console represents the display frame buffer and provides routines to open and close display modes, access the frame buffer like a surface, and some basic keyboard input routines.
The PTC Console can be thought of as the graphical equivalent of a POSIX text console.
Member Function Documentation
ptc::Console::Console ()
ptc::Console::~Console ()
virtual void ptc::Console::configure (const char file[]) [virtual]
virtual bool ptc::Console::option (const char option[]) [virtual]
virtual const Mode * ptc::Console::modes () [virtual]
virtual void ptc::Console::open (const char title[], int pages = 0) [virtual]
virtual void ptc::Console::open (const char title[], const Format & format, int pages = 0) [virtual]
virtual void ptc::Console::open (const char title[], int width, int height, const Format & format, int pages = 0) [virtual]
virtual void ptc::Console::open (const char title[], const Mode & mode, int pages = 0) [virtual]
virtual void ptc::Console::close () [virtual]
virtual void ptc::Console::flush () [virtual]
virtual void ptc::Console::finish () [virtual]
virtual void ptc::Console::update () [virtual]
virtual void ptc::Console::update (const Area & area) [virtual]
virtual bool ptc::Console::key () [virtual]
virtual Key ptc::Console::read () [virtual]
virtual void ptc::Console::copy (BaseSurface & surface) [virtual]
virtual void ptc::Console::copy (BaseSurface & surface, const Area & source, const Area & destination) [virtual]
virtual void * ptc::Console::lock () [virtual]
virtual void ptc::Console::unlock () [virtual]
virtual void ptc::Console::load (const void * pixels, int width, int height, int pitch, const Format & format, const Palette & palette) [virtual]
virtual void ptc::Console::load (const void * pixels, int width, int height, int pitch, const Format & format, const Palette & palette, const Area & source, const Area & destination) [virtual]
virtual void ptc::Console::save (void * pixels, int width, int height, int pitch, const Format & format, const Palette & palette) [virtual]
virtual void ptc::Console::save (void * pixels, int width, int height, int pitch, const Format & format, const Palette & palette, const Area & source, const Area & destination) [virtual]
virtual void ptc::Console::clear () [virtual]
virtual void ptc::Console::clear (const Color & color) [virtual]
virtual void ptc::Console::clear (const Color & color, const Area & area) [virtual]
virtual void ptc::Console::palette (const Palette & palette) [virtual]
virtual const Palette & ptc::Console::palette () const [virtual]
virtual void ptc::Console::clip (const Area & area) [virtual]
virtual int ptc::Console::width () const [virtual]
virtual int ptc::Console::height () const [virtual]
virtual int ptc::Console::pages () const [virtual]
virtual int ptc::Console::pitch () const [virtual]
virtual const Area & ptc::Console::area () const [virtual]
virtual const Area & ptc::Console::clip () const [virtual]
virtual const Format & ptc::Console::format () const [virtual]
virtual const char * ptc::Console::name () const [virtual]
virtual const char * ptc::Console::title () const [virtual]
virtual const char * ptc::Console::information () const [virtual]
The documentation for this class was generated from the following file: