Type Alias NcOptions

Source

pub type NcOptions = notcurses_options;

Expand description

Options struct for Nc.

§Fields

termtype: The name of the terminfo database entry describing this terminal.
loglevel: stderr output NcLogLevel.
margin_t: Desirable top margin.
margin_r: Desirable right margin.
margin_b: Desirable bottom margin.
margin_l: Desirable left margin.
flags: NcFlag flags.

Aliased Type§

#[repr(C)]pub struct NcOptions {
    pub termtype: *const i8,
    pub loglevel: i32,
    pub margin_t: u32,
    pub margin_r: u32,
    pub margin_b: u32,
    pub margin_l: u32,
    pub flags: u64,
}

Fields§

§termtype: *const i8

The name of the terminfo database entry describing this terminal. If NULL, the environment variable TERM is used. Failure to open the terminal definition will result in failure to initialize notcurses.

§loglevel: i32

Progressively higher log levels result in more logging to stderr. By default, nothing is printed to stderr once fullscreen service begins.

§margin_t: u32

Desirable margins. If all are 0 (default), we will render to the entirety of the screen. If the screen is too small, we do what we can–this is strictly best-effort. Absolute coordinates are relative to the rendering area ((0, 0) is always the origin of the rendering area).

§margin_r: u32

Desirable margins. If all are 0 (default), we will render to the entirety of the screen. If the screen is too small, we do what we can–this is strictly best-effort. Absolute coordinates are relative to the rendering area ((0, 0) is always the origin of the rendering area).

§margin_b: u32

Desirable margins. If all are 0 (default), we will render to the entirety of the screen. If the screen is too small, we do what we can–this is strictly best-effort. Absolute coordinates are relative to the rendering area ((0, 0) is always the origin of the rendering area).

§margin_l: u32

Desirable margins. If all are 0 (default), we will render to the entirety of the screen. If the screen is too small, we do what we can–this is strictly best-effort. Absolute coordinates are relative to the rendering area ((0, 0) is always the origin of the rendering area).

§flags: u64

General flags; see NCOPTION_*. This is expressed as a bitfield so that future options can be added without reshaping the struct. Undefined bits must be set to 0.