Struct ImageBrush 

pub struct ImageBrush<D = ImageData> {
    pub image: D,
    pub sampler: ImageSampler,
}

Describes the image content of a filled or stroked shape.

This type is generic over the storage used for the image data. By default, the generic parameter is ImageData, which is a shared image with dynamic lifetime. However, different renderers can use different types here, such as a pre-registered id.

Fields

image: D

The image to render.

sampler: ImageSampler

Parameters which specify how to sample from the image during rendering.

Implementations

impl<D> ImageBrush<D>

pub fn with_extend(self, mode: Extend) -> ImageBrush<D>

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

pub fn with_x_extend(self, mode: Extend) -> ImageBrush<D>

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

pub fn with_y_extend(self, mode: Extend) -> ImageBrush<D>

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

pub fn with_quality(self, quality: ImageQuality) -> ImageBrush<D>

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

pub fn with_alpha(self, alpha: f32) -> ImageBrush<D>

Returns the image with the alpha multiplier set to alpha.

pub fn multiply_alpha(self, alpha: f32) -> ImageBrush<D>

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

impl ImageBrush

pub fn new(image: ImageData) -> ImageBrush

Creates a new ImageBrush for the specified ImageData with default ImageSampler.

pub fn as_ref(&self) -> ImageBrush<&ImageData>

Converts an owned ImageBrush into a borrowed ImageBrushRef.

impl ImageBrush<&ImageData>

pub fn to_owned(&self) -> ImageBrush

Converts the ImageBrushRef to an owned ImageBrush.

Trait Implementations

impl<D> Clone for ImageBrush<D>

where D: Clone,

fn clone(&self) -> ImageBrush<D>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<D> Debug for ImageBrush<D>

where D: Debug,

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

Formats the value using the given formatter.

impl EncodeExt for ImageBrush<ImageSource>

fn encode_into( &self, paints: &mut Vec<EncodedPaint>, transform: Affine, tint: Option<Tint>, ) -> Option<Paint>

Encode the paint and push it into a vector of encoded paints, returning the corresponding paint in the process. This will also validate the paint.

impl<'a> From<&'a ImageBrush> for Brush<ImageBrush<&'a ImageData>, &'a Gradient>

fn from(image: &'a ImageBrush) -> Brush<ImageBrush<&'a ImageData>, &'a Gradient>

Converts to this type from the input type.

impl<'a> From<&'a ImageBrush> for ImageBrush<&'a ImageData>

fn from(value: &'a ImageBrush) -> ImageBrush<&'a ImageData>

Converts to this type from the input type.

impl<'a> From<&'a ImageData> for ImageBrush<&'a ImageData>

fn from(image: &'a ImageData) -> ImageBrush<&'a ImageData>

Converts to this type from the input type.

impl<G, D> From<ImageBrush<D>> for Brush<ImageBrush<D>, G>

fn from(value: ImageBrush<D>) -> Brush<ImageBrush<D>, G>

Converts to this type from the input type.

impl From<ImageData> for ImageBrush

fn from(image: ImageData) -> ImageBrush

Converts to this type from the input type.

impl<D> PartialEq for ImageBrush<D>

where D: PartialEq,

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

where D: Copy,

impl<D> StructuralPartialEq for ImageBrush<D>