Struct basalt::image_cache::ImageCache

pub struct ImageCache { /* private fields */ }

System for storing images used within the UI.

Implementations

impl ImageCache

pub fn load_raw_image<D: Any + Send + Sync>( &self, cache_key: ImageCacheKey, lifetime: ImageCacheLifetime, format: ImageFormat, width: u32, height: u32, associated_data: D, data: ImageData ) -> Result<ImageInfo, String>

Load an image from raw data. This is not an encoded format like PNG (See load_from_bytes).

pub fn load_from_bytes<B: AsRef<[u8]>, D: Any + Send + Sync>( &self, cache_key: ImageCacheKey, lifetime: ImageCacheLifetime, associated_data: D, bytes: B ) -> Result<ImageInfo, String>

Load an image from bytes that are encoded format such as PNG.

pub fn load_from_url<U: AsRef<str>, D: Any + Send + Sync>( &self, lifetime: ImageCacheLifetime, associated_data: D, url: U ) -> Result<ImageInfo, String>

Download and load the image from the provided URL.

pub fn load_from_path<P: AsRef<Path>, D: Any + Send + Sync>( &self, lifetime: ImageCacheLifetime, associated_data: D, path: P ) -> Result<ImageInfo, String>

Open and load image from the provided path.

pub fn obtain_image_infos<K: IntoIterator<Item = ImageCacheKey>>( &self, cache_keys: K ) -> Vec<Option<ImageInfo>>

Retrieve image information for multiple images.

pub fn obtain_image_info(&self, cache_key: ImageCacheKey) -> Option<ImageInfo>

Retrieve image information on a single image.

Note: Where applicable you should use the plural form of this method.

pub fn remove_image(&self, cache_key: ImageCacheKey)

Removes an image from cache. This is useful when an image is added with an Indefinite ImageCacheLifetime.

Note: If an image is in use this will change the lifetime of the image to ImageCacheLifetime::Immeditate. Allowing it to be removed after it is no longer used.