Enum ImageInner

#[repr(u8)]
pub enum ImageInner {
    None = 0,
    EmbeddedImage {
        cache_key: ImageCacheKey,
        buffer: SharedImageBuffer,
    },
    Svg(VRc<OpaqueImageVTable, ParsedSVG>),
    StaticTextures(&'static StaticTextures),
    BackendStorage(VRc<OpaqueImageVTable>),
    BorrowedOpenGLTexture(BorrowedOpenGLTexture),
    NineSlice(VRc<OpaqueImageVTable, NineSliceImage>),
}

A resource is a reference to binary data, for example images. They can be accessible on the file system or embedded in the resulting binary. Or they might be URLs to a web server and a downloaded is necessary before they can be used. cbindgen:prefix-with-name

Variants

None = 0

A resource that does not represent any data.

EmbeddedImage

Fields

cache_key: ImageCacheKey

buffer: SharedImageBuffer

Svg(VRc<OpaqueImageVTable, ParsedSVG>)

StaticTextures(&'static StaticTextures)

BackendStorage(VRc<OpaqueImageVTable>)

BorrowedOpenGLTexture(BorrowedOpenGLTexture)

NineSlice(VRc<OpaqueImageVTable, NineSliceImage>)

Implementations

impl ImageInner

pub fn render_to_buffer( &self, _target_size_for_scalable_source: Option<Size2D<u32, PhysicalPx>>, ) -> Option<SharedImageBuffer>

Return or render the image into a buffer

target_size_for_scalable_source is the size to use if the image is scalable. (when unspecified, will default to the intrinsic size of the image)

Returns None if the image can’t be rendered in a buffer or if the image is empty

pub fn is_svg(&self) -> bool

Returns true if the image is an SVG (either backed by resvg or HTML image wrapper).

pub fn size(&self) -> IntSize

Return the image size

Trait Implementations

impl Clone for ImageInner

fn clone(&self) -> ImageInner

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ImageInner

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

Formats the value using the given formatter.

impl Default for ImageInner

fn default() -> ImageInner

Returns the “default value” for a type.

impl<'a> From<&'a Image> for &'a ImageInner

fn from(other: &'a Image) -> Self

Converts to this type from the input type.

impl From<ImageInner> for Image

fn from(value: ImageInner) -> Self

Converts to this type from the input type.

impl PartialEq for ImageInner

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.