Struct libnotcurses_sys::examples::Canvas

pub struct Canvas {
    pub h: u32,
    pub w: u32,
    pub buf: Vec<u8>,
}

A rectangular array of pixels that can be individually colored.

Fields

h: u32

The height.

w: u32

The width.

buf: Vec<u8>

A bytes buffer.

Implementations

impl Canvas

pub fn new(h: u32, w: u32) -> Self

New white Canvas.

pub fn new_colored(h: u32, w: u32, color: NcRgb) -> Self

New custom colored Canvas.

pub fn size_cartesian(&self) -> (f32, f32, f32, f32)

Returns the canvas size in cartesian coordinates.

Returns

Cartesian coordinates, goes from the bottom-left to the top-right corner.

(beg_y, end_y, beg_x, end_x)

    ↓ beg_x (-)   0.  (+) end_x ↓
                  ↓
    ·---------------------------· ← end_y (+)
    |                           |
    |                           |
    |                           |
    |             +             | ← 0.
    |                           |
    |                           |
    |                           |
    ·---------------------------· ← beg_y (-)

pub const fn size_screen(&self) -> (u32, u32, u32, u32)

Returns the canvas size in screen coordinates.

Returns

Screen coordinates, goes from the top-left to the bottom-right corner.

(beg_y, end_y, beg_x, end_x)

    ↓ beg_x (0)          end_x ↓
    +---------------------------· ← beg_y (0)
    |                           |
    |                           |
    |                           |
    |                           |
    |                           |
    |                           |
    |                           |
    ·---------------------------· ← end_y

pub fn set_pixel(&mut self, y: f32, x: f32, color: NcRgb)

Assigns a color to a pixel, using cartesian coordinates.

pub fn set_pixel2(&mut self, y: u32, x: u32, color: NcRgb)

Assigns a color to a pixel, using screen coordinates.

pub fn s2c(&self, y: u32, x: u32) -> (f32, f32)

Performs conversion from screen coordinates to cartesian coordiantes.

In screen coordinates the origin (0,0) is at the top left:

• y increases towards the bottom.
• x increases towards the right.

pub fn s2c_y(&self, y: u32) -> f32

pub fn s2c_x(&self, x: u32) -> f32

pub fn c2s(&self, y: f32, x: f32) -> (u32, u32)

Performs conversion from cartesian coordinates to screen coordiantes.

In cartesian coordiantes the origin (0,0) is at the center:

• y increases towards the top and decreases towards the bottom.
• x increases towards the right and decreases towards the left.

Trait Implementations

impl Debug for Canvas

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

Formats the value using the given formatter.