Struct tiny_skia::Transform

pub struct Transform { /* fields omitted */ }

An affine transformation matrix.

Stores scale, skew and transform coordinates and a type of a transform.

Guarantees

• All values are finite.

Implementations

impl Transform

pub fn identity() -> Self

Creates an identity transform.

pub fn from_row(
    sx: f32,
    ky: f32,
    kx: f32,
    sy: f32,
    tx: f32,
    ty: f32
) -> Option<Self>

Creates a new Transform.

We are using column-major-column-vector matrix notation, therefore it's ky-kx, not kx-ky.

Checks

• All values must be finite.
• sx and sy must not be zero.

pub unsafe fn from_row_unchecked(
    sx: f32,
    ky: f32,
    kx: f32,
    sy: f32,
    tx: f32,
    ty: f32
) -> Self

Creates a new Transform without checking values.

Safety

• All values must be finite.
• sx and sy must be non-zero.

pub fn from_translate(tx: f32, ty: f32) -> Option<Self>

Creates a new translating Transform.

Checks

• All values must be finite.

pub fn from_scale(sx: f32, sy: f32) -> Option<Self>

Creates a new scaling Transform.

Checks

• All values must be finite.
• sx and sy must not be zero.

pub fn from_skew(kx: f32, ky: f32) -> Option<Self>

Creates a new skewing Transform.

Checks

• All values must be finite.

pub fn get_scale(&self) -> (f32, f32)

Returns scale pair.

pub fn get_skew(&self) -> (f32, f32)

Returns skew pair.

pub fn get_translate(&self) -> (f32, f32)

Returns translate pair.

pub fn get_row(&self) -> (f32, f32, f32, f32, f32, f32)

Returns all values.

pub fn is_identity(&self) -> bool

Checks that transform is identity.

The transform type is detected on creation, so this method is essentially free.

pub fn is_scale(&self) -> bool

Checks that transform is scale-only.

The transform type is detected on creation, so this method is essentially free.

pub fn is_skew(&self) -> bool

Checks that transform is skew-only.

The transform type is detected on creation, so this method is essentially free.

pub fn is_translate(&self) -> bool

Checks that transform is translate-only.

The transform type is detected on creation, so this method is essentially free.

pub fn is_scale_translate(&self) -> bool

Checks that transform contains only scale and translate.

The transform type is detected on creation, so this method is essentially free.

pub fn has_scale(&self) -> bool

Checks that transform contains a scale part.

The transform type is detected on creation, so this method is essentially free.

pub fn has_skew(&self) -> bool

Checks that transform contains a skew part.

The transform type is detected on creation, so this method is essentially free.

pub fn has_translate(&self) -> bool

Checks that transform contains a translate part.

The transform type is detected on creation, so this method is essentially free.

#[must_use]pub fn pre_scale(&self, sx: f32, sy: f32) -> Option<Self>

Pre-scales the current transform.

#[must_use]pub fn post_scale(&mut self, sx: f32, sy: f32) -> Option<Self>

Post-scales the current transform.

#[must_use]pub fn pre_translate(&self, tx: f32, ty: f32) -> Option<Self>

Pre-translates the current transform.

#[must_use]pub fn post_translate(&self, tx: f32, ty: f32) -> Option<Self>

Post-translates the current transform.

#[must_use]pub fn pre_concat(&self, other: &Self) -> Option<Self>

Pre-concats the current transform.

#[must_use]pub fn post_concat(&self, other: &Self) -> Option<Self>

Post-concats the current transform.

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 Copy for Transform

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 ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.