Struct crossterm_winapi::ScreenBufferInfo

pub struct ScreenBufferInfo(pub CONSOLE_SCREEN_BUFFER_INFO);

This type is a wrapper for CONSOLE_SCREEN_BUFFER_INFO and has some methods to extract information from it.

Wraps the underlying type: CONSOLE_SCREEN_BUFFER_INFO link: [https://docs.microsoft.com/en-us/windows/console/console-screen-buffer-info-str]

Methods

impl ScreenBufferInfo

pub fn new() -> ScreenBufferInfo

pub fn buffer_size(&self) -> Size

This will return the buffer size.

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

pub fn terminal_size(&self) -> Size

This will return the terminal size.

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

pub fn terminal_window(&self) -> WindowPositions

This will return the terminal window properties.

Will take srWindow and convert it into the WindowPositions type.

pub fn attributes(&self) -> u16

This will return the terminal window properties.

Will take wAttributes from the current screen buffer.

pub fn cursor_pos(&self) -> Coord

This will return the current cursor position.

Will take dwCursorPosition from the current screen buffer.

Trait Implementations

impl From<CONSOLE_SCREEN_BUFFER_INFO> for ScreenBufferInfo

fn from(csbi: CONSOLE_SCREEN_BUFFER_INFO) -> Self

Performs the conversion.