Enum ImageSource 

#[non_exhaustive]
pub enum ImageSource {
    Read(PathBuf),
    Download(Uri, Option<Txt>),
    Static(ImageHash, &'static [u8], ImageDataFormat),
    Data(ImageHash, Arc<Vec<u8>>, ImageDataFormat),
    Render(Arc<Box<dyn Fn(&ImageRenderArgs) -> Box<dyn ImageRenderWindowRoot> + Sync + Send>>, Option<ImageRenderArgs>),
    Image(Var<Img>),
}

The different sources of an image resource.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Read(PathBuf)

A path to an image file in the file system.

Image equality is defined by the path, a copy of the image in another path is a different image.

Download(Uri, Option<Txt>)

A uri to an image resource downloaded using HTTP GET with an optional HTTP ACCEPT string.

If the ACCEPT line is not given, all image formats supported by the view-process backend are accepted.

Image equality is defined by the URI and ACCEPT string.

Static(ImageHash, &'static [u8], ImageDataFormat)

Static bytes for an encoded or decoded image.

Image equality is defined by the hash, it is usually the hash of the bytes but it does not need to be.

Data(ImageHash, Arc<Vec<u8>>, ImageDataFormat)

Shared reference to bytes for an encoded or decoded image.

Image equality is defined by the hash, it is usually the hash of the bytes but it does not need to be.

Inside IMAGES the reference to the bytes is held only until the image finishes decoding.

Render(Arc<Box<dyn Fn(&ImageRenderArgs) -> Box<dyn ImageRenderWindowRoot> + Sync + Send>>, Option<ImageRenderArgs>)

A boxed closure that instantiates a WindowRoot that draws the image.

Use the render or render_node functions to construct this variant.

The closure is set by the image widget user, the args is set by the image widget.

Image(Var<Img>)

Already resolved (loaded or loading) image.

The image is passed-through, not cached.

Implementations

impl ImageSource

pub fn from_data(data: Arc<Vec<u8>>, format: ImageDataFormat) -> ImageSource

New source from data.

pub fn from_static(data: &'static [u8], format: ImageDataFormat) -> ImageSource

New source from static data.

pub fn hash128( &self, downscale: Option<ImageDownscale>, mask: Option<ImageMaskMode>, ) -> Option<ImageHash>

Returns the image hash, unless the source is Img.

pub fn hash128_data( data_hash: ImageHash, downscale: Option<ImageDownscale>, mask: Option<ImageMaskMode>, ) -> ImageHash

Compute hash for a borrowed Static or Data image.

pub fn hash128_read( path: &Path, downscale: Option<ImageDownscale>, mask: Option<ImageMaskMode>, ) -> ImageHash

Compute hash for a borrowed Read path.

pub fn hash128_download( uri: &Uri, accept: &Option<Txt>, downscale: Option<ImageDownscale>, mask: Option<ImageMaskMode>, ) -> ImageHash

Compute hash for a borrowed Download URI and HTTP-ACCEPT.

pub fn hash128_render( rfn: &Arc<Box<dyn Fn(&ImageRenderArgs) -> Box<dyn ImageRenderWindowRoot> + Sync + Send>>, args: &Option<ImageRenderArgs>, downscale: Option<ImageDownscale>, mask: Option<ImageMaskMode>, ) -> ImageHash

Compute hash for a borrowed Render source.

Pointer equality is used to identify the node closure.

impl ImageSource

pub fn flood( size: impl Into<Size2D<Px, Px>>, color: impl Into<Rgba>, density: Option<Size2D<PxDensity, PxDensity>>, ) -> ImageSource

New image data from solid color.

pub fn linear_vertical( size: impl Into<Size2D<Px, Px>>, stops: impl Into<GradientStops>, density: Option<Size2D<PxDensity, PxDensity>>, mask: Option<ImageMaskMode>, ) -> ImageSource

New image data from vertical linear gradient.

pub fn linear_horizontal( size: impl Into<Size2D<Px, Px>>, stops: impl Into<GradientStops>, density: Option<Size2D<PxDensity, PxDensity>>, mask: Option<ImageMaskMode>, ) -> ImageSource

New image data from horizontal linear gradient.

impl ImageSource

pub fn render<F, R>(new_img: F) -> ImageSource

where F: Fn(&ImageRenderArgs) -> R + Send + Sync + 'static, R: ImageRenderWindowRoot,

New image from a function that generates a headless window.

The function is called every time the image source is resolved and it is not found in the cache.

Examples

    |args| Window! {
        size = (500, 400);
        parent = args.parent;
        background_color = colors::GREEN;
        child = Text!("Rendered!");
    }
)

pub fn render_node( render_mode: RenderMode, render: impl Fn(&ImageRenderArgs) -> UiNode + Send + Sync + 'static, ) -> ImageSource

New image from a function that generates a new UiNode.

The function is called every time the image source is resolved and it is not found in the cache.

Note that the generated UiNode is not a child of the widget that renders the image, it is the root widget of a headless surface, not a part of the context where it is rendered. See IMAGES.render for more information.

Examples

ImageSource::render_node(RenderMode::Software, |_args| {
    Container! {
        size = (500, 400);
        background_color = colors::GREEN;
        child = Text!("Rendered!");
    }
})

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<(), Error>

Formats the value using the given formatter.

impl From<&'static [u8]> for ImageSource

fn from(data: &'static [u8]) -> ImageSource

From encoded data of Unknown format.

impl<const N: usize> From<&'static [u8; N]> for ImageSource

fn from(data: &'static [u8; N]) -> ImageSource

From encoded data of Unknown format.

impl From<&Path> for ImageSource

fn from(path: &Path) -> ImageSource

Converts to this type from the input type.

impl From<&str> for ImageSource

fn from(s: &str) -> ImageSource

Converts http:// and https:// to Download, file:// to Read the path component, and the rest to Read the string as a path.

impl<F> From<(&'static [u8], F)> for ImageSource

where F: Into<ImageDataFormat>,

fn from(_: (&'static [u8], F)) -> ImageSource

From encoded data of known format.

impl<F, const N: usize> From<(&'static [u8; N], F)> for ImageSource

where F: Into<ImageDataFormat>,

fn from(_: (&'static [u8; N], F)) -> ImageSource

From encoded data of known format.

impl<F> From<(Arc<Vec<u8>>, F)> for ImageSource

where F: Into<ImageDataFormat>,

fn from(_: (Arc<Vec<u8>>, F)) -> ImageSource

From encoded data of known format.

impl From<(Uri, &'static str)> for ImageSource

fn from(_: (Uri, &'static str)) -> ImageSource

From (URI, HTTP-ACCEPT).

impl<F> From<(Vec<u8>, F)> for ImageSource

where F: Into<ImageDataFormat>,

fn from(_: (Vec<u8>, F)) -> ImageSource

From encoded data of known format.

impl From<Arc<Vec<u8>>> for ImageSource

fn from(data: Arc<Vec<u8>>) -> ImageSource

From encoded data of Unknown format.

impl From<ImageSource> for WindowIcon

fn from(source: ImageSource) -> WindowIcon

Converts to this type from the input type.

impl From<PathBuf> for ImageSource

fn from(path: PathBuf) -> ImageSource

Converts to this type from the input type.

impl From<String> for ImageSource

fn from(s: String) -> ImageSource

Same as conversion from &str.

impl From<Txt> for ImageSource

fn from(s: Txt) -> ImageSource

Same as conversion from &str.

impl From<Uri> for ImageSource

fn from(uri: Uri) -> ImageSource

Converts to this type from the input type.

impl From<Var<Img>> for ImageSource

fn from(image: Var<Img>) -> ImageSource

Converts to this type from the input type.

impl From<Vec<u8>> for ImageSource

fn from(data: Vec<u8>) -> ImageSource

From encoded data of Unknown format.

impl IntoVar<ImageSource> for &'static [u8]

fn into_var(self) -> Var<ImageSource>

From encoded data of Unknown format.

impl<const N: usize> IntoVar<ImageSource> for &'static [u8; N]

fn into_var(self) -> Var<ImageSource>

From encoded data of Unknown format.

impl IntoVar<ImageSource> for &Path

fn into_var(self) -> Var<ImageSource>

impl IntoVar<ImageSource> for &str

fn into_var(self) -> Var<ImageSource>

Converts http:// and https:// to Download, file:// to Read the path component, and the rest to Read the string as a path.

impl<F> IntoVar<ImageSource> for (&'static [u8], F)

where F: Into<ImageDataFormat>,

fn into_var(self) -> Var<ImageSource>

From encoded data of known format.

impl<F, const N: usize> IntoVar<ImageSource> for (&'static [u8; N], F)

where F: Into<ImageDataFormat>,

fn into_var(self) -> Var<ImageSource>

From encoded data of known format.

impl<F> IntoVar<ImageSource> for (Arc<Vec<u8>>, F)

where F: Into<ImageDataFormat>,

fn into_var(self) -> Var<ImageSource>

From encoded data of known format.

impl IntoVar<ImageSource> for (Uri, &'static str)

fn into_var(self) -> Var<ImageSource>

From (URI, HTTP-ACCEPT).

impl<F> IntoVar<ImageSource> for (Vec<u8>, F)

where F: Into<ImageDataFormat>,

fn into_var(self) -> Var<ImageSource>

From encoded data of known format.

impl IntoVar<ImageSource> for Arc<Vec<u8>>

fn into_var(self) -> Var<ImageSource>

From encoded data of Unknown format.

impl IntoVar<ImageSource> for PathBuf

fn into_var(self) -> Var<ImageSource>

impl IntoVar<ImageSource> for String

fn into_var(self) -> Var<ImageSource>

Same as conversion from &str.

impl IntoVar<ImageSource> for Txt

fn into_var(self) -> Var<ImageSource>

Same as conversion from &str.

impl IntoVar<ImageSource> for Uri

fn into_var(self) -> Var<ImageSource>

impl IntoVar<ImageSource> for Var<Img>

fn into_var(self) -> Var<ImageSource>

impl IntoVar<ImageSource> for Vec<u8>

fn into_var(self) -> Var<ImageSource>

From encoded data of Unknown format.

impl IntoVar<WindowIcon> for ImageSource

fn into_var(self) -> Var<WindowIcon>

impl PartialEq for ImageSource

fn eq(&self, other: &ImageSource) -> 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.

impl IntoValue<ImageSource> for &'static [u8]

impl<const N: usize> IntoValue<ImageSource> for &'static [u8; N]

impl IntoValue<ImageSource> for &Path

impl IntoValue<ImageSource> for &str

impl<F> IntoValue<ImageSource> for (&'static [u8], F)

where F: Into<ImageDataFormat>,

impl<F, const N: usize> IntoValue<ImageSource> for (&'static [u8; N], F)

where F: Into<ImageDataFormat>,

impl<F> IntoValue<ImageSource> for (Arc<Vec<u8>>, F)

where F: Into<ImageDataFormat>,

impl IntoValue<ImageSource> for (Uri, &'static str)

impl<F> IntoValue<ImageSource> for (Vec<u8>, F)

where F: Into<ImageDataFormat>,

impl IntoValue<ImageSource> for Arc<Vec<u8>>

impl IntoValue<ImageSource> for PathBuf

impl IntoValue<ImageSource> for String

impl IntoValue<ImageSource> for Txt

impl IntoValue<ImageSource> for Uri

impl IntoValue<ImageSource> for Var<Img>

impl IntoValue<ImageSource> for Vec<u8>

impl IntoValue<WindowIcon> for ImageSource