Struct crossterm_cursor::sys::winapi::ScreenBuffer

pub struct ScreenBuffer { /* fields omitted */ }

Methods

impl ScreenBuffer

pub fn current() -> Result<ScreenBuffer, Error>

Create an instance of ScreenBuffer where the HANDLE, used for the functions this type wraps, is the current output handle.

pub fn create() -> ScreenBuffer

Create new console screen buffer.

Wraps the underlying function call: [CreateConsoleScreenBuffer] link: [https://docs.microsoft.com/en-us/windows/console/createconsolescreenbuffer]

pub fn show(&self) -> Result<(), Error>

This will make this ScreenBuffer the active one.

Wraps the underlying function call: [SetConsoleActiveScreenBuffer] link: [https://docs.microsoft.com/en-us/windows/console/setconsoleactivescreenbuffer]

pub fn info(&self) -> Result<ScreenBufferInfo, Error>

Get the screen buffer information like terminal size, cursor position, buffer size.

Wraps the underlying function call: [GetConsoleScreenBufferInfo] link: [https://docs.microsoft.com/en-us/windows/console/getconsolescreenbufferinfo]

pub fn set_size(&self, x: i16, y: i16) -> Result<(), Error>

Set the console screen buffer size to the given size.

Wraps the underlying function call: [SetConsoleScreenBufferSize] link: [https://docs.microsoft.com/en-us/windows/console/setconsolescreenbuffersize]

pub fn get_handle(&self) -> &Handle

Get the underlining raw HANDLE used by this type to execute whit.

Trait Implementations

impl From<*mut c_void> for ScreenBuffer

fn from(handle: *mut c_void) -> ScreenBuffer

Performs the conversion.

impl From<Handle> for ScreenBuffer

fn from(handle: Handle) -> ScreenBuffer

Performs the conversion.