Struct WriteableBitmapRef 

pub struct WriteableBitmapRef(pub Rc<WriteableBitmap>);

A writeable bitmap held by a property.

Tuple Fields

0: Rc<WriteableBitmap>

Implementations

impl WriteableBitmapRef

pub fn new(bitmap: WriteableBitmap) -> Self

The handle of bitmap.

pub fn get(&self) -> &Rc<WriteableBitmap>

The shared bitmap.

pub fn as_image(&self) -> Rc<dyn IImage>

The bitmap as an image (the source of an image control).

Methods from Deref<Target = WriteableBitmap>

pub fn format(&self) -> Option<PixelFormat>

The pixel format of the bitmap.

pub fn lock(&self) -> Rc<dyn ILockedFramebuffer>

Locks the pixel data of the bitmap and returns a framebuffer that can be used to read and write the pixels. The changes are committed when the framebuffer is disposed.

pub fn copy_pixels( &self, source_rect: PixelRect, buffer: &mut [u8], stride: i32, )

Copies the pixels of source_rect into buffer, whose rows are stride bytes apart. An empty source_rect selects the whole bitmap.

Methods from Deref<Target = Bitmap>

pub fn create_scaled_bitmap( &self, destination_size: PixelSize, interpolation_mode: BitmapInterpolationMode, ) -> Bitmap

Creates a bitmap scaled to the specified size from the current bitmap.

pub fn dispose(&self)

Releases the bitmap’s reference to the platform bitmap.

pub fn dpi(&self) -> Vector

The dots per inch (DPI) of the image.

pub fn size(&self) -> Size

The size of the image, in device independent pixels.

pub fn pixel_size(&self) -> PixelSize

The size of the bitmap, in device pixels.

pub fn platform_impl(&self) -> &RefCounted<dyn IBitmapImpl + Sync + Send>

The platform-specific bitmap implementation.

pub fn save_to_file( &self, file_name: &str, options: &BitmapEncoderOptions, ) -> Result<(), Error>

Saves the bitmap to a file.

pub fn save( &self, stream: &mut dyn Write, options: &BitmapEncoderOptions, ) -> Result<(), Error>

Saves the bitmap to a stream.

pub fn format(&self) -> Option<PixelFormat>

The pixel format of the bitmap, if its pixels can be read.

pub fn alpha_format(&self) -> Option<AlphaFormat>

The alpha format of the bitmap, if its pixels can be read.

pub fn copy_pixels( &self, source_rect: PixelRect, buffer: &mut [u8], stride: i32, )

Copies the pixels of source_rect into buffer, whose rows are stride bytes apart. An empty source_rect selects the whole bitmap.

Panics when the pixels of the bitmap cannot be read, when the bitmap was converted from another pixel format on creation, or when the rectangle, stride or buffer are out of range.

pub fn copy_pixels_to_framebuffer(&self, buffer: &dyn ILockedFramebuffer)

Copies the pixels of the bitmap into a locked framebuffer, converting them to its pixel and alpha formats.

Panics when the pixels of the bitmap cannot be read.

Trait Implementations

impl Clone for WriteableBitmapRef

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 WriteableBitmapRef

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

Formats the value using the given formatter.

impl Deref for WriteableBitmapRef

type Target = WriteableBitmap

The resulting type after dereferencing.

fn deref(&self) -> &WriteableBitmap

Dereferences the value.

impl From<Rc<WriteableBitmap>> for WriteableBitmapRef

fn from(value: Rc<WriteableBitmap>) -> Self

Converts to this type from the input type.

impl PartialEq for WriteableBitmapRef

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.