Struct LoadedImageSurface 

pub struct LoadedImageSurface { /* private fields */ }

A composition surface whose content is an image (WinUI Microsoft.UI.Xaml.Media.LoadedImageSurface), here backed by a Bitmap.

The surface holds a reference to the platform bitmap; the server-side surface holds another one until it is disposed.

Deviation (winui-composition.md): WinUI loads the image asynchronously from a URI or a stream and raises LoadCompleted; here a surface is made from a bitmap, or loaded from a stream at once, and the outcome is load_status. There is no LoadCompleted event and no decode size.

Implementations

impl LoadedImageSurface

pub fn from_bitmap( compositor: &Rc<Compositor>, bitmap: &Bitmap, ) -> Rc<LoadedImageSurface>

A surface that shows bitmap. The surface takes another reference to the platform bitmap: disposing bitmap afterwards does not affect it.

pub fn start_load_from_stream( compositor: &Rc<Compositor>, stream: &mut dyn Read, ) -> Rc<LoadedImageSurface>

StartLoadFromStream: a surface with the image decoded from stream. The image is decoded at once; a stream that cannot be read or decoded gives an empty surface whose load_status says why.

pub fn compositor(&self) -> &Rc<Compositor>

pub fn object(&self) -> &CompositionObject

The embedded CompositionObject.

pub fn server(&self) -> ServerObjectId

The id of the server-side surface.

pub fn load_status(&self) -> LoadedImageSourceLoadStatus

The outcome of the load.

pub fn bitmap(&self) -> Option<&Bitmap>

The bitmap the surface shows, None when the image did not load or the surface is disposed.

pub fn natural_size(&self) -> Size

The size of the image in device independent pixels (NaturalSize): what a surface brush lays out. Empty when the image did not load.

pub fn decoded_size(&self) -> Size

The size of the decoded image in device independent pixels (DecodedSize): the natural size, as the image is decoded at its full size.

pub fn decoded_physical_size(&self) -> Size

The size of the decoded image in pixels (DecodedPhysicalSize).

pub fn is_disposed(&self) -> bool

pub fn dispose(&self)

Releases the surface: its server side releases the bitmap with the next batch.

Trait Implementations

impl ICompositionObject for LoadedImageSurface

fn server(&self) -> ServerObjectId

The id of the server-side counterpart of the object.

fn as_any(&self) -> &dyn Any

fn into_any_rc(self: Rc<Self>) -> Rc<dyn Any>

impl ICompositionSurface for LoadedImageSurface