FTXUI  0.11.1
C++ functional terminal UI.
Screen Class Reference

A rectangular grid of Pixel. More...

+ Inheritance diagram for Screen:

Data Structures

struct  Cursor
 

Public Member Functions

 Screen (int dimx, int dimy)
 
std::string & at (int x, int y)
 Access a character a given position. More...
 
PixelPixelAt (int x, int y)
 Access a Pixel at a given position. More...
 
std::string ToString ()
 
void Print ()
 
int dimx ()
 
int dimy ()
 
std::string ResetPosition (bool clear=false)
 Return a string to be printed in order to reset the cursor position to the beginning of the screen. More...
 
void Clear ()
 Clear all the pixel from the screen. More...
 
void ApplyShader ()
 
Cursor cursor () const
 
void SetCursor (Cursor cursor)
 

Static Public Member Functions

static Screen Create (Dimensions dimension)
 Create a screen with the given dimension. More...
 
static Screen Create (Dimensions width, Dimensions height)
 Create a screen with the given dimension along the x-axis and y-axis. More...
 

Data Fields

Box stencil
 

Protected Attributes

int dimx_
 
int dimy_
 
std::vector< std::vector< Pixel > > pixels_
 
Cursor cursor_
 

Detailed Description

A rectangular grid of Pixel.

Definition at line 49 of file screen.hpp.


Data Structure Documentation

◆ ftxui::Screen::Cursor

struct ftxui::Screen::Cursor

Definition at line 77 of file screen.hpp.

Data Fields
int x
int y

Constructor & Destructor Documentation

◆ Screen()

Screen ( int  dimx,
int  dimy 
)

Definition at line 348 of file screen.cpp.

Member Function Documentation

◆ Create() [1/2]

◆ Create() [2/2]

Screen Create ( Dimensions  width,
Dimensions  height 
)
static

Create a screen with the given dimension along the x-axis and y-axis.

Definition at line 338 of file screen.cpp.

◆ at()

std::string & at ( int  x,
int  y 
)

Access a character a given position.

Parameters
xThe character position along the x-axis.
yThe character position along the y-axis.

Definition at line 400 of file screen.cpp.

◆ PixelAt()

Pixel & PixelAt ( int  x,
int  y 
)

Access a Pixel at a given position.

Parameters
xThe pixel position along the x-axis.
yThe pixel position along the y-axis.

Definition at line 407 of file screen.cpp.

◆ ToString()

std::string ToString ( )

Produce a std::string that can be used to print the Screen on the terminal. Don't forget to flush stdout. Alternatively, you can use Screen::Print();

Definition at line 367 of file screen.cpp.

◆ Print()

void Print ( )

Definition at line 393 of file screen.cpp.

◆ dimx()

int dimx ( )
inline

Definition at line 65 of file screen.hpp.

◆ dimy()

int dimy ( )
inline

Definition at line 66 of file screen.hpp.

◆ ResetPosition()

std::string ResetPosition ( bool  clear = false)

Return a string to be printed in order to reset the cursor position to the beginning of the screen.

std::string reset_position;
while(true) {
auto document = render();
auto screen = Screen::Create(Dimension::Full(), Dimension::Fit(document));
Render(screen, document);
std::cout << reset_position << screen.ToString() << std::flush;
reset_position = screen.ResetPosition();
using namespace std::chrono_literals;
std::this_thread::sleep_for(0.01s);
}
static Screen Create(Dimensions dimension)
Create a screen with the given dimension.
Definition: screen.cpp:344
Dimensions Fit(Element &)
Definition: util.cpp:72
Dimensions Full()
Definition: screen.cpp:332
void Render(Screen &screen, const Element &node)
Display an element on a ftxui::Screen.
Definition: node.cpp:40
Returns
The string to print in order to reset the cursor position to the beginning.

Definition at line 430 of file screen.cpp.

◆ Clear()

void Clear ( )

Clear all the pixel from the screen.

Definition at line 447 of file screen.cpp.

◆ ApplyShader()

void ApplyShader ( )

Definition at line 455 of file screen.cpp.

◆ cursor()

Cursor cursor ( ) const
inline

Definition at line 81 of file screen.hpp.

◆ SetCursor()

void SetCursor ( Cursor  cursor)
inline

Definition at line 82 of file screen.hpp.

Field Documentation

◆ stencil

Box stencil

Definition at line 75 of file screen.hpp.

◆ dimx_

int dimx_
protected

Definition at line 85 of file screen.hpp.

◆ dimy_

int dimy_
protected

Definition at line 86 of file screen.hpp.

◆ pixels_

std::vector<std::vector<Pixel> > pixels_
protected

Definition at line 87 of file screen.hpp.

◆ cursor_

Cursor cursor_
protected

Definition at line 88 of file screen.hpp.


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