Struct tetra::graphics::DrawParams

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

Parameters that can be manipulated when drawing an object.

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<f32>

The position that the graphic should be drawn at. Defaults to (0.0, 0.0).

scale: Vec2<f32>

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<f32>

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

This offset is applied before scaling, rotation and positioning. For example, if you have a 16x16 image and set the origin to [8.0, 8.0], subsequent transformations will be performed relative to the center of the image.

rotation: f32

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

color: Color

A color to multiply the graphic by. Defaults to Color::WHITE.

Implementations

impl DrawParams

pub fn new() -> DrawParams

Creates a new set of DrawParams.

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

Sets the position that the graphic should be drawn at.

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

Sets the scale that the graphic should be drawn at.

pub fn origin(self, origin: Vec2<f32>) -> 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 to_matrix(&self) -> Mat4<f32>

Creates a new transformation matrix equivalent to this set of params.

This method does not take into account color, as it cannot be represented via a matrix.

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 Debug for DrawParams

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

Formats the value using the given formatter.

impl Default for DrawParams

fn default() -> DrawParams

Returns the “default value” for a type.

impl From<DrawParams> for Mat4<f32>

fn from(params: DrawParams) -> Self

Converts to this type from the input type.

impl From<Vec2<f32>> for DrawParams

fn from(position: Vec2<f32>) -> DrawParams

Converts to this type from the input type.

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: &Rhs) -> bool

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

impl StructuralPartialEq for DrawParams