Struct PlaneGeometry 

pub struct PlaneGeometry {
    pub blitter: Blitter,
    pub pixels: Size,
    pub pixels_per_cell: Size,
    pub max_bitmap_pixels: Option<Size>,
}

The geometry of a Plane or a terminal.

Fields

blitter: Blitter

The selected blitter.

pixels: Size

Total size, in pixels.

pixels_per_cell: Size

A Cell’s size, in pixels.

max_bitmap_pixels: Option<Size>

The largest bitmap size that the terminal is willing to accept.

Or none if bitmaps are not supported.

Implementations

impl PlaneGeometry

constructors

pub fn from_term(nc: &Notcurses, blitter: Blitter) -> Self

Returns the calculated geometry of the terminal using the desired Blitter.

pub fn from_term_first(nc: &Notcurses, blitters: &[Blitter]) -> Option<Self>

Returns the geometry for the first Blitter supported by the terminal, from the ones provided.

pub fn from_term_all(nc: &Notcurses, blitters: &[Blitter]) -> Vec<Self>

Returns the geometries of the Blitters supported by the terminal, from the ones provided.

impl PlaneGeometry

methods

pub const fn blitter(&self) -> Blitter

The current blitter.

pub const fn pixels(&self) -> Size

Total size, in pixels.

pub fn cells(&self) -> Size

Total size, in Cells.

pub fn blits(&self) -> Size

Total size, in blitter blits.

pub const fn pixels_per_cell(&self) -> Size

A Cell’s size, in pixels.

pub fn blits_per_cell(&self) -> Size

A Cells size, in blitter blits.

pub const fn max_bitmap_pixels(&self) -> Option<Size>

Returns the maximum supported bitmap size, in pixels, or none if bitmaps are not supported.

pub fn max_bitmap_cells(&self) -> Option<Size>

Returns the maximum supported bitmap size, in Cells, or none if bitmaps are not supported.

pub fn max_bitmap_blits(&self) -> Option<Size>

Returns the maximum supported bitmap size, in blits, using the current blitter, or none if bitmaps are not supported.

pub fn max_bitmap_blitter(&self, blitter: Blitter) -> Option<Size>

Returns the maximum supported bitmap size, in blits, using the provided blitter, or none if bitmaps are not supported.

Trait Implementations

impl Clone for PlaneGeometry

fn clone(&self) -> PlaneGeometry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PlaneGeometry

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

Formats the value using the given formatter.

impl Default for PlaneGeometry

fn default() -> PlaneGeometry

Returns the “default value” for a type.

impl From<(NcPixelGeometry, Blitter)> for PlaneGeometry

needs both geometry & blitter information.

fn from(geom_blitter: (NcPixelGeometry, Blitter)) -> PlaneGeometry

Converts to this type from the input type.

impl From<PlaneGeometry> for NcPixelGeometry

fn from(g: PlaneGeometry) -> NcPixelGeometry

Converts to this type from the input type.

impl PartialEq for PlaneGeometry

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for PlaneGeometry

impl Eq for PlaneGeometry

impl StructuralPartialEq for PlaneGeometry