Struct Bitmap 

pub struct Bitmap { /* private fields */ }

Holds a bitmap image.

The types deriving from it (WriteableBitmap, RenderTargetBitmap) dereference to Bitmap; the members they override are reached through the deriving type or through IBitmap/IImage handles.

Implementations

impl Bitmap

pub fn decode_to_width( stream: &mut dyn Read, width: i32, interpolation_mode: BitmapInterpolationMode, ) -> Result<Bitmap>

Loads a bitmap from a stream, decoded to the specified width maintaining aspect ratio.

interpolation_mode is used should a resize be necessary; upstream defaults it to high quality.

pub fn decode_to_height( stream: &mut dyn Read, height: i32, interpolation_mode: BitmapInterpolationMode, ) -> Result<Bitmap>

Loads a bitmap from a stream, decoded to the specified height maintaining aspect ratio.

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 from_file(file_name: &str) -> Result<Bitmap>

Loads a bitmap from a file.

pub fn from_stream(stream: &mut dyn Read) -> Result<Bitmap>

Loads a bitmap from a stream.

pub fn from_ref(platform_impl: &RefCounted<SharedBitmapImpl>) -> Bitmap

Creates a bitmap sharing a platform bitmap: takes another reference to it.

pub fn from_impl(platform_impl: Arc<SharedBitmapImpl>) -> Bitmap

Creates a bitmap owning a platform bitmap.

pub fn from_pixels( format: PixelFormat, alpha_format: AlphaFormat, data: &[u8], size: PixelSize, dpi: Vector, stride: i32, ) -> Bitmap

Creates a bitmap from pixel data: stride * size.height bytes of format/alpha_format pixels.

A format the backend cannot hold is converted to RGBA8888.

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<SharedBitmapImpl>

The platform-specific bitmap implementation.

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

Saves the bitmap to a file.

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

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 IBitmap for Bitmap

fn dpi(&self) -> Vector

The dots per inch (DPI) of the image.

fn pixel_size(&self) -> PixelSize

The size of the bitmap, in device pixels.

fn platform_impl(&self) -> &RefCounted<SharedBitmapImpl>

The platform-specific bitmap implementation.

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

Saves the bitmap to a stream.

fn dispose(&self)

Releases the bitmap.

impl IImage for Bitmap

fn size(&self) -> Size

The size of the image, in device independent pixels.

fn draw( &self, context: &mut DrawingContext<'_>, source_rect: Rect, dest_rect: Rect, )

Draws the image to a drawing context: the part of the image inside source_rect is drawn into dest_rect.

fn as_any(&self) -> &dyn Any

The implementing value, for downcasts to concrete image types. For image classes use as_object.

fn as_bitmap(&self) -> Option<&dyn IBitmap>

The image viewed as a bitmap, when it is one.

fn as_object(&self) -> Option<&FerroObject>

The object behind the image when it is an image class.

fn as_affects_render(&self) -> Option<&dyn IAffectsRender>

The image viewed as IAffectsRender, when it can change.

impl IImageBrushSource for Bitmap

fn bitmap(&self) -> Option<&RefCounted<SharedBitmapImpl>>

The counted reference to the platform bitmap, while it is alive.

fn get_bitmap(&self) -> Option<Arc<SharedBitmapImpl>>

The platform bitmap, while it is alive.

impl MarkupTyped for Bitmap

const MARKUP: &'static MarkupType

The markup metadata of the type.

impl PartialEq for Bitmap

Bitmaps compare by identity (reference equality), so that their handles can be held in untyped values.

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

Equality operator ==.

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

Inequality operator !=.