Struct Image 

pub struct Image {
    pub format: ImageFormat,
    pub bytes: Vec<u8>,
    pub id: u64,
}

Encoded image data and the format it is encoded in.

Use Image::from_bytes to create one. GPUI decodes it for display through Image::to_image_data or the asset APIs.

Fields

format: ImageFormat

The format the bytes are encoded in, such as PNG.

bytes: Vec<u8>

The encoded image bytes.

id: u64

A key for the image in GPUI’s asset cache. Image::from_bytes sets it to a hash of bytes.

Implementations

impl Image

pub fn empty() -> Self

Returns a PNG image with no bytes. It can’t be decoded.

pub fn from_bytes(format: ImageFormat, bytes: Vec<u8>) -> Self

Creates an image from format and encoded bytes.

The Image::id is a hash of bytes alone, so two images with the same bytes but different formats share an id.

pub fn id(&self) -> u64

Returns the image’s cache key. Image::from_bytes sets it from a hash of the bytes.

pub fn use_render_image( self: Arc<Self>, window: &mut Window, cx: &mut App, ) -> Option<Arc<RenderImage>>

Returns the decoded image, starting the load if it isn’t cached yet.

Returns None while the image is loading, or if it can’t be decoded. Call it from a render method, so the window redraws when the load finishes.

pub fn get_render_image( self: Arc<Self>, window: &mut Window, cx: &mut App, ) -> Option<Arc<RenderImage>>

Returns the decoded image if it’s already cached. Doesn’t start a load.

pub fn remove_asset(self: Arc<Self>, cx: &mut App)

Removes the decoded image from GPUI’s asset cache.

pub fn is_asset_cached(self: &Arc<Self>, cx: &App) -> bool

Check whether this image is present in GPUI’s asset cache (loading or loaded), without fetching it.

pub fn to_image_data( &self, svg_renderer: SvgRenderer, ) -> Result<Arc<RenderImage>>

Decodes the image into a RenderImage that you can paint.

SVG images are rendered at scale 1.0.

Errors

Returns an error if the bytes can’t be decoded. For a GIF, frames that fail to decode are skipped and logged, and an error is returned only when every frame fails.

pub fn format(&self) -> ImageFormat

Returns the image’s format.

pub fn bytes(&self) -> &[u8]

Returns the encoded image bytes.

Trait Implementations

impl Clone for Image

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Image

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

Formats the value using the given formatter.

impl Eq for Image

impl From<Image> for ClipboardEntry

fn from(value: Image) -> Self

Converts to this type from the input type.

impl From<Image> for ClipboardItem

fn from(value: Image) -> Self

Converts to this type from the input type.

impl Hash for Image

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Image

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Image