Struct Bitmap 

pub struct Bitmap { /* private fields */ }

A bitmap instance with ownership to the underlying data.

Implementations

impl Bitmap

pub fn new(size: Size<u32>, bgcolor: impl Into<ColorOrPattern>) -> Self

Allocates and returns a new width by height Bitmap filled with bgcolor.

pub fn open(path: impl AsRef<str>) -> Result<Self, Error>

Open an image as a bitmap.

pub fn clear(&self, bgcolor: impl Into<ColorOrPattern>)

Clears bitmap, filling with the given bgcolor.

pub fn set_mask(&self, mask: impl AsRef<Bitmap>) -> Result<(), Error>

Sets a mask image for the given bitmap. The set mask must be the same size as the target bitmap.

pub fn get_mask(&self) -> Ref<'_, Bitmap>

Gets a mask image for the given bitmap. If the image doesn’t have a mask, getBitmapMask returns NULL.

pub fn check_mask_collision( &self, x1: i32, y1: i32, flip1: BitmapFlip, other: impl AsRef<Bitmap>, x2: i32, y2: i32, flip2: BitmapFlip, rect: SideOffsets<i32>, ) -> bool

Returns true if any of the opaque pixels in self when positioned at x1, y1 with flip1 overlap any of the opaque pixels in other at x2, y2 with flip2 within the non-empty rect, or false if no pixels overlap or if one or both fall completely outside of rect.

pub fn get_bitmap_data(&self) -> BitmapData<'_>

Gets various info about bitmap including its width and height and raw pixel data. The data is 1 bit per pixel packed format, in MSB order; in other words, the high bit of the first byte in data is the top left pixel of the image. If the bitmap has a mask, a pointer to its data is returned in mask, else NULL is returned.

pub fn load(&self, path: impl AsRef<str>) -> Result<(), Error>

Loads the image at path into the previously allocated bitmap.

pub fn rotated(&self, rotation: f32, scale: Vec2<f32>) -> Bitmap

Returns a new, rotated and scaled LCDBitmap based on the given bitmap.

pub fn get_color_pattern(&self, pos: Vec2<i32>) -> ColorPatternData

Get color as an 8 x 8 pattern using the given bitmap. x, y indicates the top left corner of the 8 x 8 pattern.

Trait Implementations

impl AsRef<Bitmap> for Bitmap

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Bitmap

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Bitmap

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

Formats the value using the given formatter.

impl Drop for Bitmap

fn drop(&mut self)

Executes the destructor for this type.

impl PartialEq for Bitmap

fn eq(&self, other: &Self) -> 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 Eq for Bitmap

impl Send for Bitmap

impl Sync for Bitmap