Struct VisualGeometry 

pub struct VisualGeometry {
    pub blitter: Blitter,
    pub pixels: Size,
    pub rendered_pixels: Size,
    pub rendered_cells: Size,
    pub pixels_per_cell: Size,
    pub region_position: Position,
    pub region_size: Size,
    pub max_bitmap_pixels: Option<Size>,
}

The geometry of a Visual.

Inner values are calculated at the time of the call. A font change, for example, could make all the fields invalid, except for pixels.

Fields

blitter: Blitter

The selected blitter.

pixels: Size

True internal size in pixels, following any resizing.

rendered_pixels: Size

Rendered size in pixels, as handed to the blitter, following any scaling.

rendered_cells: Size

Rendered size in cells, following any padding.

There’s padding whenever rendered_pixels is not evenly divided by scale.

pixels_per_cell: Size

A Cells size, in pixels.

region_position: Position

The origin of the region to be rendered (top-left corner).

region_size: Size

The size of the region to be rendered.

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 VisualGeometry

methods

pub const fn blitter(&self) -> Blitter

The selected blitter.

pub const fn pixels(&self) -> Size

The true internal size in pixels, following any resizing.

pub fn cells(&self) -> Size

The true internal size in cells, following any resizing.

pub fn blits(&self) -> Size

The true internal size in cells, following any resizing.

pub const fn rendered_pixels(&self) -> Size

The rendered size in pixels, following any scaling.

pub const fn rendered_cells(&self) -> Size

The rendered size in cells, following any padding.

There’s padding whenever rendered_pixels is not evenly divided by blits_per_cell.

pub fn rendered_blits(&self) -> Size

The rendered size in blits, following any padding.

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 VisualGeometry

fn clone(&self) -> VisualGeometry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VisualGeometry

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

Formats the value using the given formatter.

impl Default for VisualGeometry

fn default() -> VisualGeometry

Returns the “default value” for a type.

impl From<NcVisualGeometry> for VisualGeometry

fn from(nc: NcVisualGeometry) -> VisualGeometry

Converts to this type from the input type.

impl PartialEq for VisualGeometry

fn eq(&self, other: &VisualGeometry) -> 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 VisualGeometry

impl Eq for VisualGeometry

impl StructuralPartialEq for VisualGeometry