Struct tetra::graphics::DrawParams

pub struct DrawParams {
    pub position: Vec2,
    pub scale: Vec2,
    pub origin: Vec2,
    pub rotation: f32,
    pub color: Color,
    pub clip: Option<Rectangle>,
}

Struct representing the parameters that can be used when drawing.

You can either use this as a builder by calling DrawParams::new and then chaining methods, or construct it manually - whichever you find more pleasant to write.

Fields

position: Vec2

The position that the graphic should be drawn at. Defaults to [0.0, 0.0].

scale: Vec2

The scale that the graphic should be drawn at. Defaults to [1.0, 1.0].

This can be set to a negative value to flip the graphic around the origin.

origin: Vec2

The origin of the graphic. Defaults to [0.0, 0.0] (the top left).

Positioning and scaling will be calculated relative to this point.

rotation: f32

The rotation of the graphic, in radians. Defaults to 0.0.

color: Color

A color to multiply the graphic by. Defaults to white.

clip: Option<Rectangle>

A sub-region of the graphic to draw. Defaults to None, which means the the full graphic will be drawn.

This is useful if you're using spritesheets (which you should be!).

Methods

impl DrawParams

pub fn new() -> DrawParams

Creates a new set of DrawParams.

pub fn position(self, position: Vec2) -> DrawParams

Sets the position that the graphic should be drawn at.

pub fn scale(self, scale: Vec2) -> DrawParams

Sets the scale that the graphic should be drawn at.

pub fn origin(self, origin: Vec2) -> DrawParams

Sets the origin of the graphic.

pub fn rotation(self, rotation: f32) -> DrawParams

Sets the rotation of the graphic, in radians.

pub fn color(self, color: Color) -> DrawParams

Sets the color to multiply the graphic by.

pub fn clip(self, clip: Rectangle) -> DrawParams

Sets the region of the graphic to draw.

Trait Implementations

impl Clone for DrawParams

fn clone(&self) -> DrawParams

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<DrawParams> for DrawParams

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

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

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

This method tests for !=.

impl Default for DrawParams

fn default() -> DrawParams

Returns the "default value" for a type.

impl From<Matrix<f32, U2, U1, <DefaultAllocator as Allocator<f32, U2, U1>>::Buffer>> for DrawParams

fn from(position: Vec2) -> DrawParams

Performs the conversion.

impl Debug for DrawParams

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

Formats the value using the given formatter.