Struct crossterm_winapi::ScreenBufferInfo

pub struct ScreenBufferInfo(pub CONSOLE_SCREEN_BUFFER_INFO);

Information about a console screen buffer.

This wraps CONSOLE_SCREEN_BUFFER_INFO.

Tuple Fields

0: CONSOLE_SCREEN_BUFFER_INFO

Implementations

impl ScreenBufferInfo

pub fn new() -> ScreenBufferInfo

Create a new console screen buffer without all zeroed properties.

pub fn buffer_size(&self) -> Size

Get the size of the screen buffer.

Will take dwSize from the current screen buffer and convert it into a Size.

pub fn terminal_size(&self) -> Size

Get the size of the terminal display window.

Will calculate the width and height from srWindow and convert it into a Size.

pub fn terminal_window(&self) -> WindowPositions

Get the position and size of the terminal display window.

Will take srWindow and convert it into the WindowPositions type.

pub fn attributes(&self) -> u16

Get the current attributes of the characters that are being written to the console.

Will take wAttributes from the current screen buffer.

pub fn cursor_pos(&self) -> Coord

Get the current column and row of the terminal cursor in the screen buffer.

Will take dwCursorPosition from the current screen buffer.

Trait Implementations

impl Clone for ScreenBufferInfo

fn clone(&self) -> ScreenBufferInfo

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ScreenBufferInfo

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<CONSOLE_SCREEN_BUFFER_INFO> for ScreenBufferInfo

fn from(csbi: CONSOLE_SCREEN_BUFFER_INFO) -> Self

Converts to this type from the input type.