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]`

Reimplemented from ptc::BaseConsole.

### virtual bool ptc::Console::option (const char option[])`[virtual]`

Reimplemented from ptc::BaseSurface.

### virtual const Mode * ptc::Console::modes ()`[virtual]`

Reimplemented from ptc::BaseConsole.

### virtual void ptc::Console::open (const char title[], int pages = 0)`[virtual]`

Reimplemented from ptc::BaseConsole.

### virtual void ptc::Console::open (const char title[], const Format & format, int pages = 0)`[virtual]`

Reimplemented from ptc::BaseConsole.

### virtual void ptc::Console::open (const char title[], int width, int height, const Format & format, int pages = 0)`[virtual]`

Reimplemented from ptc::BaseConsole.

### virtual void ptc::Console::open (const char title[], const Mode & mode, int pages = 0)`[virtual]`

Reimplemented from ptc::BaseConsole.

### virtual void ptc::Console::close ()`[virtual]`

Reimplemented from ptc::BaseConsole.

### virtual void ptc::Console::flush ()`[virtual]`

Reimplemented from ptc::BaseConsole.

### virtual void ptc::Console::finish ()`[virtual]`

Reimplemented from ptc::BaseConsole.

### virtual void ptc::Console::update ()`[virtual]`

Reimplemented from ptc::BaseConsole.

### virtual void ptc::Console::update (const Area & area)`[virtual]`

Reimplemented from ptc::BaseConsole.

### virtual bool ptc::Console::key ()`[virtual]`

Reimplemented from ptc::BaseConsole.

### virtual Key ptc::Console::read ()`[virtual]`

Reimplemented from ptc::BaseConsole.

### virtual void ptc::Console::copy (BaseSurface & surface)`[virtual]`

Reimplemented from ptc::BaseSurface.

### virtual void ptc::Console::copy (BaseSurface & surface, const Area & source, const Area & destination)`[virtual]`

Reimplemented from ptc::BaseSurface.

### virtual void * ptc::Console::lock ()`[virtual]`

Reimplemented from ptc::BaseSurface.

### virtual void ptc::Console::unlock ()`[virtual]`

Reimplemented from ptc::BaseSurface.

### virtual void ptc::Console::load (const void * pixels, int width, int height, int pitch, const Format & format, const Palette & palette)`[virtual]`

Reimplemented from ptc::BaseSurface.

### 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]`

Reimplemented from ptc::BaseSurface.

### virtual void ptc::Console::save (void * pixels, int width, int height, int pitch, const Format & format, const Palette & palette)`[virtual]`

Reimplemented from ptc::BaseSurface.

### 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]`

Reimplemented from ptc::BaseSurface.

### virtual void ptc::Console::clear ()`[virtual]`

Reimplemented from ptc::BaseSurface.

### virtual void ptc::Console::clear (const Color & color)`[virtual]`

Reimplemented from ptc::BaseSurface.

### virtual void ptc::Console::clear (const Color & color, const Area & area)`[virtual]`

Reimplemented from ptc::BaseSurface.

### virtual void ptc::Console::palette (const Palette & palette)`[virtual]`

Reimplemented from ptc::BaseSurface.

### virtual const Palette & ptc::Console::palette () const`[virtual]`

Reimplemented from ptc::BaseSurface.

### virtual void ptc::Console::clip (const Area & area)`[virtual]`

Reimplemented from ptc::BaseSurface.

### virtual int ptc::Console::width () const`[virtual]`

Reimplemented from ptc::BaseSurface.

### virtual int ptc::Console::height () const`[virtual]`

Reimplemented from ptc::BaseSurface.

### virtual int ptc::Console::pages () const`[virtual]`

Reimplemented from ptc::BaseConsole.

### virtual int ptc::Console::pitch () const`[virtual]`

Reimplemented from ptc::BaseSurface.

### virtual const Area & ptc::Console::area () const`[virtual]`

Reimplemented from ptc::BaseSurface.

### virtual const Area & ptc::Console::clip () const`[virtual]`

Reimplemented from ptc::BaseSurface.

### virtual const Format & ptc::Console::format () const`[virtual]`

Reimplemented from ptc::BaseSurface.

### virtual const char * ptc::Console::name () const`[virtual]`

Reimplemented from ptc::BaseConsole.

### virtual const char * ptc::Console::title () const`[virtual]`

Reimplemented from ptc::BaseConsole.

### virtual const char * ptc::Console::information () const`[virtual]`

Reimplemented from ptc::BaseConsole.

The documentation for this class was generated from the following file:

- ptc.h