Struct ggez::graphics::DrawParam

pub struct DrawParam {
    pub src: Rect,
    pub color: Color,
    pub transform: Transform,
    pub z: ZIndex,
}

A struct containing all the necessary info for drawing with parameters.

This struct implements the Default trait, so to set only some parameter you can just do:

let my_dest = glam::vec2(13.0, 37.0);
canvas.draw(&image, DrawParam::default().dest(my_dest));

As a shortcut, it also implements From for Into<Point2<f32>>.

Fields

src: Rect

A portion of the drawable to clip, as a fraction of the whole image. Defaults to the whole image ([0.0, 0.0] to [1.0, 1.0]) if omitted.

color: Color

Default: white.

transform: Transform

Where to put the object.

z: ZIndex

The Z coordinate of the draw.

Implementations

impl DrawParam

pub fn new() -> Self

Create a new DrawParam with default values.

pub fn src(self, src: Rect) -> Self

Set the source rect.

pub fn dest<P>(self, dest: P) -> Selfwhere P: Into<Point2<f32>>,

Set the dest point.

Panics

Panics if Transform is of the Matrix variant.

pub fn dest_rect(self, rect: Rect) -> Self

Set the dest and scale together.

Panics

Panics if Transform is of the Matrix variant.

pub fn color(self, color: impl Into<Color>) -> Self

Set the color. This will be blended with whatever color the drawn object already is.

pub fn rotation(self, rot: f32) -> Self

Set the rotation.

Panics

Panics if Transform is of the Matrix variant.

pub fn scale<V>(self, scale_: V) -> Selfwhere V: Into<Vector2<f32>>,

Set the scaling factors.

Panics

Panics if Transform is of the Matrix variant.

pub fn offset<P>(self, offset_: P) -> Selfwhere P: Into<Point2<f32>>,

Set the transformation offset.

Panics

Panics if Transform is of the Matrix variant.

pub fn transform<M>(self, transform: M) -> Selfwhere M: Into<ColumnMatrix4<f32>>,

Set the transformation matrix.

pub fn z(self, z: ZIndex) -> Self

Set the Z coordinate.

Trait Implementations

impl Clone for DrawParam

fn clone(&self) -> DrawParam

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DrawParam

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

Formats the value using the given formatter.

impl Default for DrawParam

fn default() -> Self

Returns the “default value” for a type.

impl<P> From<P> for DrawParamwhere P: Into<Point2<f32>>,

Create a DrawParam from a location, like this:

let my_dest = glam::vec2(13.0, 37.0);
canvas.draw(&image, my_dest);

fn from(location: P) -> Self

Converts to this type from the input type.

impl PartialEq<DrawParam> for DrawParam

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for DrawParam

impl StructuralPartialEq for DrawParam