Type Definition libnotcurses_sys::NcVisualOptions

pub type NcVisualOptions = ncvisual_options;

Options struct for NcVisual.

It is recommended to construct it via NcVisualOptionsBuilder by calling NcVisualOptions::builder().

Usage

If a plane is not provided, one will be created, having the exact size necessary to display the visual (this might be smaller or larger than the rendering area). if NcVisualOptions::CHILDPLANE is provided, this will be interpreted as the parent.

A subregion of the visual can be rendered using beg_y, beg_x, len_y, and len_x.

Fields

• n: an optional mutable pointer to an NcPlane.

• scaling: how the source will be stretched/scaled relative to the NcPlane (NOSCALE, SCALE, STRETCH, NONE_HIRES, SCALE_HIRES).

• y: if an NcPlane is provided in n then this specifies where the NcVisual will be on that plane.

  Otherwise it specifies where the created NcPlane will be placed relative to the standard plane’s origin.

  If VERALIGNED is set, this will be interpreted as an NcAlign value.

• x: if an NcPlane is provided in n then this specifies where the NcVisual will be on that plane.

  Otherwise it specifies where the created NcPlane will be placed relative to the standard plane’s origin.

  If HORALIGNED is set, this will be interpreted as an NcAlign value.

• begy: origin of rendered section in the y axis.

• begx: origin of rendered section in the x axis.

• leny: length of rendered section in the y axis.

• lenx: length of rendered section in the x axis.

• blitter: NcBlitter glyph set to use for blitting.

• flags: bitmask of options: ADDALPHA, BLEND, CHILDPLANE, NODEGRADE, VERALIGNED, HORALIGNED, NOINTERPOLATE.

• transcolor: treats this color as transparent when the ADDALPHA flag is active.

• pxoffy: pixel offset within the cell in the y axis.

  If NcBlitter::Pixel is used the bitmap will be drawn offset from the upper-left cell’s origin by these amounts, otherwise this will be ignored.

  It is an error if either number exceeds the cell-pixel geometry in any dimension (see NcPixelGeometry.cell_y, NcVisualGeometry.cdim_yx).

• pxoffx: pixel offset within the cell in the x axis.

  If NcBlitter::Pixel is used, the bitmap will be drawn offset from the upper-left cell’s origin by these amounts, otherwise this will be ignored.

  It is an error if either number exceeds the cell-pixel geometry in any dimension (see NcPixelGeometry.cell_x, NcVisualGeometry.cdim_yx).

Implementations

impl NcVisualOptions

pub const ADDALPHA: u32

Treats as transparent the color specified in the transcolor field.

pub const BLEND: u32

Uses NcAlpha::Blend with the NcVisual.

pub const CHILDPLANE: u32

allows you to indicate that the n field of ncvisual_options refers not to the plane onto which you’d like to blit, but the parent of a new plane.

A plane will be created using the other parameters in the ncvisual_options, as a child of this parent. This means things like, say, vertically centering a sprixel relative to the standard plane can be done in one step.

pub const NODEGRADE: u32

Fails rather than gracefully degrade. See NcBlitter.

pub const VERALIGNED: u32

Y is an alignment, not absolute.

pub const HORALIGNED: u32

X is an alignment, not absolute.

pub const NOINTERPOLATE: u32

Uses non-interpolative scaling.

impl<'ncplane> NcVisualOptions

Constructors

pub fn builder() -> NcVisualOptionsBuilder<'ncplane>

Returns a builder object for NcVisualOptions.

pub fn new(
    plane: Option<&mut NcPlane>,
    scale: NcScale,
    y: NcOffset,
    x: NcOffset,
    section_yx_lenyx: Option<(NcDim, NcDim, NcDim, NcDim)>,
    cell_offset_yx: Option<(NcDim, NcDim)>,
    blitter: NcBlitter,
    flags: u32,
    transcolor: NcRgba
) -> Self

New NcVisualOptions.

Arguments

• plane - an optional mutable pointer to an NcPlane.

• scale - how the source will be stretched/scaled relative to the NcPlane (NOSCALE, SCALE, STRETCH, NONE_HIRES, SCALE_HIRES).

• y - if an NcPlane is provided in plane then this specifies where the NcVisual will be on that plane in the y axis.

  Otherwise it specifies where the created NcPlane will be placed in the y axis, relative to the standard plane’s origin.

  If VERALIGNED is set, this will be interpreted as an NcAlign value.

• x - if an NcPlane is provided in plane then this specifies where the NcVisual will be on that plane, in the x axis.

  Otherwise it specifies where the created NcPlane will be placed, in the y axis, relative to the standard plane’s origin.

  If HORALIGNED is set, this will be interpreted as an NcAlign value.

• section_yx_lenyx - The size of the rendered section.

  None renders the entire visual, otherwise the provided tuple (y, x, len_y, len_x) sets [yx] as the origin of the section and len_[yx] as the its length on each respective dimension.

• cell_offset_yx - Pixel offsets within the cell.

  If NcBlitter::Pixel is used the bitmap will be drawn offset from the upper-left cell’s origin by these amounts, otherwise this will be ignored.

  It is an error if either number exceeds the cell-pixel geometry in any dimension (see NcVisualGeometry.cdim_yx).

• blitter - NcBlitter glyph set to use for blitting.

• flags - bitmask of options: (ADDALPHA, BLEND, CHILDPLANE, NODEGRADE, VERALIGNED, HORALIGNED, NOINTERPOLATE).

• transcolor - treats this color as transparent when the ADDALPHA flag is active

Notes

If the NcVisualOptions::CHILDPLANE flag is used then the plane is interpreted as the parent NcPlane of the new plane created for this NcVisual.