Struct ImageRef 

#[repr(C)]
pub struct ImageRef {
    pub data: *const DecodedImage,
    pub copies: *const AtomicUsize,
    pub id: u64,
    pub run_destructor: bool,
}

Fields

data: *const DecodedImage

Shared pointer to an opaque implementation of the decoded image

copies: *const AtomicUsize

How many copies does this image have (if 0, the font data will be deleted on drop)

id: u64

Process-unique, monotonically-assigned identity of the decoded image (see ImageRefHash). Shared by shallow clones (they are the same image), fresh for ImageRef::deep_copy and every new_* (a different image). Unlike the old data-pointer identity this is drawn from a never-reused counter, so freeing an image and reusing its heap address can never make a new image collide with a stale key — the prerequisite for image GC (see resources.rs image_ref_get_hash).

run_destructor: bool

Implementations

impl ImageRef

pub const fn get_hash(&self) -> ImageRefHash

impl ImageRef

pub fn into_inner(self) -> Option<DecodedImage>

If *copies = 1, returns the internal image data

pub const fn get_data(&self) -> &DecodedImage

pub fn get_image_callback(&self) -> Option<&CoreImageCallback>

pub fn get_image_callback_mut(&mut self) -> Option<&mut CoreImageCallback>

pub fn deep_copy(&self) -> Self

In difference to the default shallow copy, creates a new image ref

pub const fn is_null_image(&self) -> bool

pub const fn is_gl_texture(&self) -> bool

pub const fn is_raw_image(&self) -> bool

pub const fn is_callback(&self) -> bool

pub fn get_rawimage(&self) -> Option<RawImage>

pub fn get_bytes(&self) -> Option<&[u8]>

Get raw bytes from the image as a slice Returns None if this is not a Raw image or if it’s an External image

pub fn get_bytes_ptr(&self) -> *const u8

Get a pointer to the raw bytes for debugging/profiling purposes Returns a unique pointer for this ImageRef’s data

pub const fn get_size(&self) -> LogicalSize

NOTE: returns (0, 0) for a Callback

pub fn null_image( width: usize, height: usize, format: RawImageFormat, tag: Vec<u8>, ) -> Self

pub fn callback<C: Into<CoreRenderImageCallback>>( callback: C, data: RefAny, ) -> Self

pub fn new_rawimage(image_data: RawImage) -> Option<Self>

pub fn new_gltexture(texture: Texture) -> Self

Trait Implementations

impl Clone for ImageRef

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 ImageRef

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

Formats the value using the given formatter.

impl Drop for ImageRef

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Eq for ImageRef

impl Hash for ImageRef

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

where H: Hasher,

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 Ord for ImageRef

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ImageRef

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ImageRef

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Send for ImageRef

impl Sync for ImageRef