Screen API

Small library for screen. Changing screen size and show and hide cursor.

Structs

struct ExclusiveMode {
    frequency: Int
    height: Int
    id: Int
    width: Int
}

Querying screen exclusive modes (fullscreen).

fn exclusive_modes() -> VecLikeView<ExclusiveMode>

Return all known exclusive fullscreen modes.

fn has_exclusive() -> Bool

Return true if exclusive fullscreen modes are supported. Similar to exclusive_modes().len() != 0

fn has_borderless() -> Bool

Return true if borderless fullscreen is supported.

fn has_windowed() -> Bool

Return true if windowed mode is supported.

fn min_windowed_extent() -> (Int, Int)

Return the smallest useful windowed extent as (width, height).

fn max_windowed_extent() -> (Int, Int)

Return the largest useful windowed extent as (width, height).

Setting a supported screen mode.

fn set_exclusive(mode_id: Int) -> Bool

Set exclusive fullscreen using a mode id from exclusive_modes(). Returns true if successful.

fn set_borderless() -> Bool

Set borderless fullscreen on the current monitor. Returns true if successful.

fn set_windowed(width: Int, height: Int) -> Bool

Set windowed mode at an explicit extent. Returns true if successful.

Refers to the operating system–controlled mouse pointer. Not to be confused with a text cursor (caret).

fn hide_cursor()

Hides the system cursor.

fn show_cursor()

Shows the system cursor.