Enum ggez::graphics::Transform

pub enum Transform {
    Values {
        dest: Point2<f32>,
        rotation: f32,
        scale: Vector2<f32>,
        offset: Point2<f32>,
    },
    Matrix(ColumnMatrix4<f32>),
}

A struct that represents where to put a drawable object.

This can either be a set of individual components, or a single Matrix4 transform.

Variants

Values

Fields

dest: Point2<f32>

The position to draw the graphic expressed as a Point2.

rotation: f32

The orientation of the graphic in radians.

scale: Vector2<f32>

The x/y scale factors expressed as a Vector2.

offset: Point2<f32>

An offset, which is applied before scaling and rotation happen.

For most objects this works as a relative offset (meaning [0.5,0.5] is an offset which centers the object on the destination). These objects are:

• Image, Canvas, Text and the sprites inside an InstanceArray (as long as you’re not making an instanced mesh-draw)

Transform made of individual values

Matrix(ColumnMatrix4<f32>)

Transform made of an arbitrary matrix.

It should represent the final model matrix of the given drawable. This is useful for situations where, for example, you build your own hierarchy system, where you calculate matrices of each hierarchy item and store a calculated world-space model matrix of an item. This lets you implement transform stacks, skeletal animations, etc.

Implementations

impl Transform

pub fn to_matrix(self) -> Self

Crunches the transform down to a single matrix, if it’s not one already.

pub fn to_bare_matrix(self) -> ColumnMatrix4<f32>

Same as to_matrix() but just returns a bare mint matrix.

Trait Implementations

impl Clone for Transform

fn clone(&self) -> Transform

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Transform

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

Formats the value using the given formatter.

impl Default for Transform

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq<Transform> for Transform

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

impl StructuralPartialEq for Transform