Struct libnotcurses_sys::ffi::ncvisual_options

#[repr(C)]
pub struct ncvisual_options {
    pub n: *mut ncplane,
    pub scaling: ncscale_e,
    pub y: c_int,
    pub x: c_int,
    pub begy: c_int,
    pub begx: c_int,
    pub leny: c_int,
    pub lenx: c_int,
    pub blitter: ncblitter_e,
    pub flags: u64,
    pub transcolor: u32,
}

Fields

n: *mut ncplane

if no ncplane is provided, one will be created using the exact size necessary to render the source with perfect fidelity (this might be smaller or larger than the rendering area). if NCVISUAL_OPTION_CHILDPLANE is provided, this must be non-NULL, and will be interpreted as the parent.

scaling: ncscale_e

the scaling is ignored if no ncplane is provided (it ought be NCSCALE_NONE in this case). otherwise, the source is stretched/scaled relative to the provided ncplane.

y: c_int

if an ncplane is provided, y and x specify where the visual will be rendered on that plane. otherwise, they specify where the created ncplane will be placed relative to the standard plane’s origin. x is an ncalign_e value if NCVISUAL_OPTION_HORALIGNED is provided. y is an ncalign_e if NCVISUAL_OPTION_VERALIGNED is provided.

x: c_int

if an ncplane is provided, y and x specify where the visual will be rendered on that plane. otherwise, they specify where the created ncplane will be placed relative to the standard plane’s origin. x is an ncalign_e value if NCVISUAL_OPTION_HORALIGNED is provided. y is an ncalign_e if NCVISUAL_OPTION_VERALIGNED is provided.

begy: c_int

origin of rendered section

begx: c_int

origin of rendered section

leny: c_int

size of rendered section

lenx: c_int

size of rendered section

blitter: ncblitter_e

glyph set to use (maps input to output cells)

flags: u64

bitmask over NCVISUAL_OPTION_*

transcolor: u32

treat this color as transparent under NCVISUAL_OPTION_ADDALPHA

Implementations

impl ncvisual_options

NcVisualOptions Constructors

pub fn with_plane(
    plane: &mut NcPlane,
    scale: NcScale,
    y: NcDim,
    x: NcDim,
    begy: NcDim,
    begx: NcDim,
    leny: NcDim,
    lenx: NcDim,
    blitter: NcBlitter,
    flags: u32,
    transcolor: NcRgba
) -> Self

Specify an existing plane.

If NCVISUAL_OPTION_CHILDPLANE is used in flags then the plane is interpreted as the parent NcPlane of the new plane created for this NcVisual.

pub fn without_plane(
    y: NcDim,
    x: NcDim,
    begy: NcDim,
    begx: NcDim,
    leny: NcDim,
    lenx: NcDim,
    blitter: NcBlitter,
    flags: u32,
    transcolor: u32
) -> Self

pub fn fullsize_pixel_without_plane(
    y: NcDim,
    x: NcDim,
    leny: NcDim,
    lenx: NcDim
) -> Self

Trait Implementations

impl Clone for ncvisual_options

fn clone(&self) -> ncvisual_options

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ncvisual_options

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

Formats the value using the given formatter.

impl Default for ncvisual_options

fn default() -> Self

Returns the “default value” for a type.

impl Hash for ncvisual_options

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 ncvisual_options

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

This method returns an Ordering between self and other.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

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

Restrict a value to a certain interval.

impl PartialEq<ncvisual_options> for ncvisual_options

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

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

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

This method tests for !=.

impl PartialOrd<ncvisual_options> for ncvisual_options

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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 ncvisual_options

impl Eq for ncvisual_options

impl StructuralEq for ncvisual_options

impl StructuralPartialEq for ncvisual_options