Struct RenderTargetBitmap 

pub struct RenderTargetBitmap { /* private fields */ }

A bitmap that holds the rendering of a visual.

Implementations

impl RenderTargetBitmap

pub fn new(pixel_size: PixelSize) -> RenderTargetBitmap

Creates a bitmap of the given size, in pixels, at 96 DPI.

pub fn with_dpi(pixel_size: PixelSize, dpi: Vector) -> RenderTargetBitmap

Creates a bitmap of the given size, in pixels, and DPI.

pub fn platform_impl(&self) -> &RefCounted<dyn IRenderTargetBitmapImpl>

The platform-specific bitmap implementation.

pub fn render(&self, visual: &Ref<Visual>)

Renders a visual to the bitmap.

pub fn create_drawing_context(&self) -> DrawingContext<'static>

Creates a drawing context that draws into the bitmap, after clearing the bitmap. Disposing (or dropping) the context finishes the drawing.

pub fn create_drawing_context_with_clear( &self, clear: bool, ) -> DrawingContext<'static>

Creates a drawing context that draws into the bitmap, clearing the bitmap first when clear is set.

pub fn create_platform_drawing_context( &self, clear: bool, ) -> Box<dyn IDrawingContextImpl>

Creates the platform drawing context that draws into the bitmap, clearing the bitmap first when clear is set.

pub fn dispose(&self)

Releases the bitmap’s references to the platform 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<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 Deref for RenderTargetBitmap

type Target = Bitmap

The resulting type after dereferencing.

fn deref(&self) -> &Bitmap

Dereferences the value.

impl IBitmap for RenderTargetBitmap

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 RenderTargetBitmap

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 RenderTargetBitmap

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.