Struct libnotcurses_sys::c_api::ncvgeom

#[repr(C)]
pub struct ncvgeom {

    pub pixy: c_uint,
    pub pixx: c_uint,
    pub cdimy: c_uint,
    pub cdimx: c_uint,
    pub rpixy: c_uint,
    pub rpixx: c_uint,
    pub rcelly: c_uint,
    pub rcellx: c_uint,
    pub scaley: c_uint,
    pub scalex: c_uint,
    pub begy: c_uint,
    pub begx: c_uint,
    pub leny: c_uint,
    pub lenx: c_uint,
    pub maxpixely: c_uint,
    pub maxpixelx: c_uint,
    pub blitter: ncblitter_e,
}

describes all geometries of an ncvisual: those which are inherent, and those dependent upon a given rendering regime. pixy and pixx are the true internal pixel geometry, taken directly from the load (and updated by ncvisual_resize()). cdimy/cdimx are the cell-pixel geometry at the time of this call (it can change with a font change, in which case all values other than pixy/pixx are invalidated). rpixy/rpixx are the pixel geometry as handed to the blitter, following any scaling. scaley/scalex are the number of input pixels drawn to a single cell; when using NCBLIT_PIXEL, they are equivalent to cdimy/cdimx. rcelly/rcellx are the cell geometry as written by the blitter, following any padding (there is padding whenever rpix{y, x} is not evenly divided by scale{y, x}, and also sometimes for Sixel). maxpixely/maxpixelx are defined only when NCBLIT_PIXEL is used, and specify the largest bitmap that the terminal is willing to accept. blitter is the blitter which will be used, a function of the requested blitter and the blitters actually supported by this environment. if no ncvisual was supplied, only cdimy/cdimx are filled in.

Fields

pixy: c_uint

true pixel geometry of ncvisual data

pixx: c_uint

true pixel geometry of ncvisual data

cdimy: c_uint

terminal cell geometry when this was calculated

cdimx: c_uint

terminal cell geometry when this was calculated

rpixy: c_uint

rendered pixel geometry (per visual_options)

rpixx: c_uint

rendered pixel geometry (per visual_options)

rcelly: c_uint

rendered cell geometry (per visual_options)

rcellx: c_uint

rendered cell geometry (per visual_options)

scaley: c_uint

pixels per filled cell (scale == c for bitmaps)

scalex: c_uint

pixels per filled cell (scale == c for bitmaps)

begy: c_uint

upper-left corner of used region

begx: c_uint

upper-left corner of used region

leny: c_uint

geometry of used region

lenx: c_uint

geometry of used region

maxpixely: c_uint

only defined for NCBLIT_PIXEL

maxpixelx: c_uint

only defined for NCBLIT_PIXEL

blitter: ncblitter_e

blitter that will be used

Implementations

impl ncvgeom

Constructors

pub fn new() -> Self

Returns a new NcVGeom with zeroed fields.

Trait Implementations

impl Clone for ncvgeom

fn clone(&self) -> ncvgeom

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ncvgeom

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

Formats the value using the given formatter.

impl Default for ncvgeom

fn default() -> Self

Returns the “default value” for a type.

impl From<ncvgeom> for NcVisualGeometry

fn from(vg: NcVGeom) -> Self

Since we don’t know the origin of the NcVGeom struct, when some fields are 0, we can’t really know whether that’s a valid value or not. That should be determined manually by other means.

Specifically len_yx, beg_yx & maxpixel_yx wont be None even if the corresponding NcVGeom fields are 0. But they would be None if the NcVisualGeometry had been created by the

See: https://github.com/dankamongmen/notcurses/pull/2320#issuecomment-962170075

impl Hash for ncvgeom

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for ncvgeom

fn cmp(&self, other: &ncvgeom) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<ncvgeom> for ncvgeom

fn eq(&self, other: &ncvgeom) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ncvgeom) -> bool

This method tests for !=.

impl PartialOrd<ncvgeom> for ncvgeom

fn partial_cmp(&self, other: &ncvgeom) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for ncvgeom

impl Eq for ncvgeom

impl StructuralEq for ncvgeom

impl StructuralPartialEq for ncvgeom