Struct UnownedBitmapMut 

pub struct UnownedBitmapMut<'a> { /* private fields */ }

A mutable Bitmap that is not owned by the application, so can only be used as a borrowed BitmapRef.

A UnownedBitmapRef can be cloned which is a shallow clone that produces access to another mutable borrow on the unowned Bitmap.

Methods from Deref<Target = BitmapRef>

pub fn load_file(&mut self, path: &str) -> Result<(), Error>

Loads the image at path into the previously allocated BitmapRef.

pub fn data(&self) -> BitmapData

Returns the bitmap’s metadata such as its width and height.

pub fn as_bytes(&self) -> &[u8]

Gives read acccess to the pixels of the bitmap as an array of bytes.

Each byte represents 8 pixels, where each pixel is a bit. The highest bit is the leftmost pixel, and lowest bit is the rightmost. There are Bitmap::data().rowbytes many bytes in each row, regardless of the number of pixels in a row, which can introduce padding bytes between rows. For this reason, the Bitmap::as_pixels() method is recommended, and easier to use.

pub fn as_mut_bytes(&mut self) -> &mut [u8]

Gives read-write acccess to the pixels of the bitmap as an array of bytes.

Each byte represents 8 pixels, where each pixel is a bit. The highest bit is the leftmost pixel, and lowest bit is the rightmost. There are Bitmap::data().rowbytes many bytes in each row, regardless of the number of pixels in a row, which can introduce padding bytes between rows. For this reason, the Bitmap::as_pixels_mit() method is recommended, and easier to use.

pub fn as_pixels(&self) -> BitmapPixels<'_>

Gives read acccess to the individual pixels of the bitmap.

pub fn as_pixels_mut(&mut self) -> BitmapPixelsMut<'_>

Gives read-write acccess to the individual pixels of the bitmap.

pub fn clear<'a, C: Into<Color<'a>>>(&mut self, bg_color: C)

Clears the bitmap, filling with the given bg_color.

pub fn set_mask_bitmap(&mut self, mask: &BitmapRef) -> Result<(), Error>

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

The mask bitmap is copied, so no reference is held to it. Returns an Error::DimensionsDoNotMatch if the mask bitmap dimensions do not match with self.

pub fn mask_bitmap(&self) -> Option<UnownedBitmapMut<'_>>

The mask bitmap attached to this bitmap.

Returns the mask bitmap, if one has been attached with set_mask_bitmap(), or None.

Trait Implementations

impl AsMut<BitmapRef> for UnownedBitmapMut<'_>

fn as_mut(&mut self) -> &mut BitmapRef

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

impl AsRef<BitmapRef> for UnownedBitmapMut<'_>

fn as_ref(&self) -> &BitmapRef

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

impl Clone for UnownedBitmapMut<'_>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Deref for UnownedBitmapMut<'_>

type Target = BitmapRef

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for UnownedBitmapMut<'_>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.