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...
Pixel &	PixelAt (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.

Examples

examples/dom/gauge.cpp.

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 119 of file screen.cpp.

Member Function Documentation

Create() [1/2]

Screen Create ( Dimensions  dimension )

static

Create a screen with the given dimension.

Examples

examples/dom/border.cpp, examples/dom/color_gallery.cpp, examples/dom/color_info_palette256.cpp, examples/dom/color_truecolor_HSV.cpp, examples/dom/color_truecolor_RGB.cpp, examples/dom/dbox.cpp, examples/dom/graph.cpp, examples/dom/gridbox.cpp, examples/dom/hflow.cpp, examples/dom/html_like.cpp, examples/dom/package_manager.cpp, examples/dom/paragraph.cpp, examples/dom/separator.cpp, examples/dom/size.cpp, examples/dom/spinner.cpp, examples/dom/style_blink.cpp, examples/dom/style_bold.cpp, examples/dom/style_color.cpp, examples/dom/style_dim.cpp, examples/dom/style_gallery.cpp, examples/dom/style_inverted.cpp, examples/dom/style_underlined.cpp, examples/dom/vbox_hbox.cpp, and examples/dom/window.cpp.

Definition at line 115 of file screen.cpp.

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 109 of file screen.cpp.

at()

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

Access a character a given position.

Parameters

x	The character position along the x-axis.
y	The character position along the y-axis.

Definition at line 171 of file screen.cpp.

PixelAt()

Pixel & PixelAt	(	int	x,
		int	y
	)

Access a Pixel at a given position.

Parameters

x	The pixel position along the x-axis.
y	The pixel position along the y-axis.

Definition at line 178 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 138 of file screen.cpp.

Print()

void Print

(

)

Definition at line 164 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);
}

Returns

The string to print in order to reset the cursor position to the beginning.

Definition at line 201 of file screen.cpp.

Clear()

void Clear

(

)

Clear all the pixel from the screen.

Definition at line 218 of file screen.cpp.

ApplyShader()

void ApplyShader

(

)

Definition at line 226 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:

• include/ftxui/screen/screen.hpp
• src/ftxui/screen/screen.cpp