Bare Metal Programming Tool Kit
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | List of all members
bmptk::graphics::frame_console Class Reference

frame that is an ostream subclass (so you can << to it) More...

#include <graphics.h>

Inheritance diagram for bmptk::graphics::frame_console:

Public Member Functions

 frame_console (frame &f, format fo=format())
 create a frame_console
 

Detailed Description

frame that is an ostream subclass (so you can << to it)

A frame_console is a subclass of std::ostream, so you can use it with all the << operations that are supported by for instance std::cout.

Definition at line 2033 of file graphics.h.

Constructor & Destructor Documentation

bmptk::graphics::frame_console::frame_console ( frame f,
format  fo = format() 
)
inline

create a frame_console

Create a frame_console. Specify the underlying frame and optionally the character format to be used. The alignment specified in the format is ignored.

The following characters have a special meaning:

  • '\n' : puts the write cursor at the start of the next line.
  • '\r' : puts the write cursor at the start of the current line (without clearing the current line!).
  • '\v' : clears the frame and puts the cursor at the top-left position.

Note that a frame_console does NOT scroll.

Definition at line 2053 of file graphics.h.


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