Struct ResidentImage 

pub struct ResidentImage {
    pub id: ImageId,
    pub region: AtlasRegion,
    pub natural: [u32; 2],
    pub padding: u32,
    pub may_have_transparency: bool,
}

A resident image: the handle a paint names it by, and where its texels are.

Fields

id: ImageId

The handle an ImageSource::OpaqueId carries.

region: AtlasRegion

The atlas rectangle holding the image’s own pixels, padding excluded.

Equal to natural unless the source was minified to fit the atlas, in which case it is the smaller rectangle actually uploaded.

natural: [u32; 2]

The source’s own declared extent, before any minification.

Carried because it is the extent a paint transform was composed against — compile::paint::encode_image_command derives its natural-to-dest mapping from the ImageData’s declared size, which it reads before this residency is consulted. A consumer that ends up sampling a minified rectangle has to fold minify_scale into that transform, and this is the half of the ratio the atlas rectangle does not carry.

padding: u32

Transparent padding pixels around region in the atlas.

may_have_transparency: bool

Whether the image’s premultiplied pixels include any non-opaque texel.

Implementations

impl ResidentImage

pub fn source(&self) -> ImageSource

This image as the paint-side source a vello_common encoding carries.

pub fn minify_scale(&self) -> Option<(f32, f32)>

The per-axis factor mapping a natural-space texel coordinate onto the resident rectangle, or None when the source was stored at full size.

None rather than Some((1.0, 1.0)) so a caller can skip the rescale entirely on the overwhelmingly common path, and so “was this image minified?” is one question rather than a float comparison.

Trait Implementations

impl Clone for ResidentImage

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ResidentImage

impl Debug for ResidentImage

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

Formats the value using the given formatter.

impl Eq for ResidentImage

impl PartialEq for ResidentImage

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ResidentImage