Struct Image

pub struct Image {
    pub data: Blob<u8>,
    pub format: ImageFormat,
    pub width: u32,
    pub height: u32,
    pub x_extend: Extend,
    pub y_extend: Extend,
    pub quality: ImageQuality,
    pub alpha: f32,
}

Owned shareable image resource.

Fields

data: Blob<u8>

Blob containing the image data.

format: ImageFormat

Pixel format of the image.

width: u32

Width of the image.

height: u32

Height of the image.

x_extend: Extend

Extend mode in the horizontal direction.

y_extend: Extend

Extend mode in the vertical direction.

quality: ImageQuality

Hint for desired rendering quality.

alpha: f32

An additional alpha multiplier to use with the image.

Implementations

impl Image

pub fn new(data: Blob<u8>, format: ImageFormat, width: u32, height: u32) -> Self

Creates a new image with the given data, format and dimensions.

pub fn with_extend(self, mode: Extend) -> Self

Builder method for setting the image extend mode in both directions.

pub fn with_x_extend(self, mode: Extend) -> Self

Builder method for setting the image extend mode in the horizontal direction.

pub fn with_y_extend(self, mode: Extend) -> Self

Builder method for setting the image extend mode in the vertical direction.

pub fn with_quality(self, quality: ImageQuality) -> Self

Builder method for setting a hint for the desired image quality when rendering.

pub fn with_alpha(self, alpha: f32) -> Self

Returns the image with the alpha multiplier set to alpha.

pub fn multiply_alpha(self, alpha: f32) -> Self

Returns the image with the alpha multiplier multiplied again by alpha. The behaviour of this transformation is undefined if alpha is negative.

Trait Implementations

impl Clone for Image

fn clone(&self) -> Image

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<'a> From<&'a Image> for BrushRef<'a>

fn from(image: &'a Image) -> Self

Converts to this type from the input type.

impl From<Image> for Brush

fn from(value: Image) -> Self

Converts to this type from the input type.

impl PartialEq for Image

fn eq(&self, other: &Image) -> 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 StructuralPartialEq for Image