Struct gemgui::graphics::bitmap::Bitmap

pub struct Bitmap { /* private fields */ }

Byte owning bitmap

Implementations

impl Bitmap

pub fn new(width: u32, height: u32) -> Bitmap

Allocate a new bitmap

The bitmap bytes are transparent

Arguments

• width - bitmap width
• height - bitmap height

Return

Bitmap

pub fn from_bytes(width: u32, height: u32, bytes: Vec<Pixel>) -> Bitmap

New bitmap from bytes

Arguments

width - bitmap width

height - bitmap height

bytes - it is assumed that width * height equals to bytes.len()

Return

Bitmap

pub fn from_image_file(filename: &str) -> Result<Bitmap>

New bitmap from file

Arguments

filename - a path to image file, various formats are supported

Return

Bitmap

pub fn from_image_bytes(bytes: &[u8]) -> Result<Bitmap>

New bitmap from a file

Arguments

bytes - a image file bytes, various formats are supported

Return

Bitmap

pub fn from(bitmap: &dyn BitmapData) -> Bitmap

Clone a bitmap from another

Arguments

bitmap - a bitmap data copied

Return

Bitmap

pub fn clip(rect: &Rect<u32>, bitmap: &dyn BitmapData) -> Result<Bitmap>

Clone a portion of bitmap to another

Returned bitmap is can be smaller than a given rect is if clip is outsize of bitmap.

Arguments

rect - portion extents

bitmap - Bitmap copied

Return

Bitmap

pub fn rect(width: u32, height: u32, pixel: Pixel) -> Bitmap

Create a solid color bitmap

Arguments

width - bitmap width

height - bitmap height

pixel- color applied

Return

Bitmap

pub fn put(&mut self, x: u32, y: u32, pixel: Pixel)

Set a pixel color

x and y coordinates are assumed to be inside of bitmap

Arguments

x - x coordinate

y - y coordinate

pixel- color applied

pub fn merge(&mut self, x_pos: i32, y_pos: i32, bitmap: &dyn BitmapData)

Merge another bitmap on this bitmap

Pixels are either replaced or meld upon the pixel alpha channel.

x_pos, y_pos or source bitmap extents does not have to be inside of this bitmap.

Arguments

x_pos - x coordinate

y_pos - y coordinate

bitmap- source bitmap

pub fn save<FileName>(&self, filename: FileName) -> Result<()>where FileName: AsRef<Path>,

Save bitmap to a file

Arguments

path - file save, the format is deducted from the file extension (e.g. .jpg or png)

• various format are supported.

Trait Implementations

impl BitmapData for Bitmap

fn iter(&self) -> Iter<'_, Pixel>

Iterate over pixels

fn width(&self) -> u32

Bitmap width

fn height(&self) -> u32

Bitmap height

fn get(&self, x: u32, y: u32) -> Pixel

Get a single pixel

fn slice(&self, x: u32, width: u32, y: u32) -> &[Pixel]

get a many pixels

impl Clone for Bitmap

fn clone(&self) -> Bitmap

Returns a copy of the value.

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

Performs copy-assignment from source.