Struct ImageSampler 

pub struct ImageSampler {
    pub x_extend: Extend,
    pub y_extend: Extend,
    pub quality: ImageQuality,
    pub alpha: f32,
}

Parameters which specify how to sample an image during rendering.

When a renderer is drawing an image, they will (in most cases) not directly copy the bytes from the source image to their render target; instead, they will sample from the image. This involves determining from which part of the source image to read, and how to handle cases where the source image’s pixels are not aligned with the render target exactly, in any combination of scale, position or rotation. They might also perform an alpha multiplication, as done here. This struct contains the parameters used by sampling.

Fields

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 ImageSampler

pub fn new() -> Self

Creates a new ImageSampler with default values

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 ImageSampler

fn clone(&self) -> ImageSampler

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ImageSampler

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

Formats the value using the given formatter.

impl Default for ImageSampler

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for ImageSampler

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

impl StructuralPartialEq for ImageSampler