Enum ImageSource 

pub enum ImageSource {
    Pixmap(Arc<Pixmap>),
    OpaqueId {
        id: ImageId,
        may_have_transparency: bool,
    },
    ExternalTexture {
        id: TextureId,
        source_region: RectU16,
        may_have_transparency: bool,
    },
}

Bitmap source used by Image.

Variants

Pixmap(Arc<Pixmap>)

Pixmap pixels travel with the scene packet.

OpaqueId

Pixmap pixels were registered earlier; this is just a handle.

Fields

id: ImageId

The image handle.

may_have_transparency: bool

Whether the image may contain non-opaque pixels.

ExternalTexture

An externally owned texture supplied to the renderer at render time.

Fields

id: TextureId

Opaque external texture handle.

source_region: RectU16

Source region to sample from in texel coordinates.

may_have_transparency: bool

Whether the source region may contain non-opaque pixels.

Implementations

impl ImageSource

pub fn opaque_id(id: ImageId) -> Self

Create an ImageSource from a pre-registered image handle.

Conservatively assumes the image may have non-opaque pixels. Use Self::opaque_id_with_transparency_hint when you know the image is fully opaque.

pub fn opaque_id_with_transparency_hint( id: ImageId, may_have_transparency: bool, ) -> Self

Create an ImageSource from a pre-registered image handle, with an explicit hint about whether the image may have non-opaque pixels.

pub fn external_texture( texture_id: TextureId, source_region: RectU16, may_have_transparency: bool, ) -> Self

Create an image source backed by a texture supplied to the renderer at render time.

Panics

Panics if source_region is empty.

pub fn may_have_transparency(&self) -> bool

Returns whether this image source may contain non-opaque pixels.

pub fn from_peniko_image_data(image: &ImageData) -> Self

Convert a peniko::ImageData to an ImageSource.

This is a somewhat lossy conversion, as the image data data is transformed to premultiplied RGBA8.

Panics

This panics if image has a width or height greater than u16::MAX.

Trait Implementations

impl Clone for ImageSource

fn clone(&self) -> ImageSource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ImageSource

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

Formats the value using the given formatter.