# Struct pango::Matrix

``#[repr(transparent)]pub struct Matrix { /* private fields */ }``
Expand description

A `Matrix` specifies a transformation between user-space and device coordinates.

The transformation is given by

``````x_device = x_user * matrix->xx + y_user * matrix->xy + matrix->x0;
y_device = x_user * matrix->yx + y_user * matrix->yy + matrix->y0;
``````

## Implementations§

source§

### impl Matrix

source

source

#### pub unsafe fn from_glib_ptr_borrow<'a>(ptr: *const PangoMatrix) -> &'a Self

Borrows the underlying C value.

source

#### pub unsafe fn from_glib_ptr_borrow_mut<'a>( ptr: *mut PangoMatrix ) -> &'a mut Self

Borrows the underlying C value mutably.

source§

### impl Matrix

source

#### pub fn concat(&mut self, new_matrix: &Matrix)

Changes the transformation represented by @self to be the transformation given by first applying transformation given by @new_matrix then applying the original transformation.

source

#### pub fn font_scale_factor(&self) -> f64

Returns the scale factor of a matrix on the height of the font.

That is, the scale factor in the direction perpendicular to the vector that the X coordinate is mapped to. If the scale in the X coordinate is needed as well, use `font_scale_factors()`.

##### Returns

the scale factor of @self on the height of the font, or 1.0 if @self is `None`.

source

#### pub fn font_scale_factors(&self) -> (f64, f64)

Calculates the scale factor of a matrix on the width and height of the font.

That is, @xscale is the scale factor in the direction of the X coordinate, and @yscale is the scale factor in the direction perpendicular to the vector that the X coordinate is mapped to.

Note that output numbers will always be non-negative.

##### Returns
###### `xscale`

output scale factor in the x direction

###### `yscale`

output scale factor perpendicular to the x direction

source

#### pub fn slant_ratio(&self) -> f64

Available on crate feature `v1_50` only.

Gets the slant ratio of a matrix.

For a simple shear matrix in the form:

``````1 λ
0 1``````

this is simply λ.

##### Returns

the slant ratio of @self

source

#### pub fn rotate(&mut self, degrees: f64)

Changes the transformation represented by @self to be the transformation given by first rotating by @degrees degrees counter-clockwise then applying the original transformation.

###### `degrees`

degrees to rotate counter-clockwise

source

#### pub fn scale(&mut self, scale_x: f64, scale_y: f64)

Changes the transformation represented by @self to be the transformation given by first scaling by @sx in the X direction and @sy in the Y direction then applying the original transformation.

###### `scale_x`

amount to scale by in X direction

###### `scale_y`

amount to scale by in Y direction

source

#### pub fn transform_distance(&self, dx: &mut f64, dy: &mut f64)

Transforms the distance vector (@dx,@dy) by @self.

This is similar to `transform_point()`, except that the translation components of the transformation are ignored. The calculation of the returned vector is as follows:

``````dx2 = dx1 * xx + dy1 * xy;
dy2 = dx1 * yx + dy1 * yy;
``````

Affine transformations are position invariant, so the same vector always transforms to the same vector. If (@x1,@y1) transforms to (@x2,@y2) then (@x1+@dx1,@y1+@dy1) will transform to (@x1+@dx2,@y1+@dy2) for all values of @x1 and @x2.

###### `dx`

in/out X component of a distance vector

###### `dy`

in/out Y component of a distance vector

source

#### pub fn transform_point(&self, x: &mut f64, y: &mut f64)

Transforms the point (@x, @y) by @self.

###### `x`

in/out X position

###### `y`

in/out Y position

source

#### pub fn translate(&mut self, tx: f64, ty: f64)

Changes the transformation represented by @self to be the transformation given by first translating by (@tx, @ty) then applying the original transformation.

###### `tx`

amount to translate in the X direction

###### `ty`

amount to translate in the Y direction

source§

### impl Matrix

source

source

#### pub fn transform_pixel_rectangle(&self, rect: &mut Rectangle)

First transforms the @rect using @self, then calculates the bounding box of the transformed rectangle.

This function is useful for example when you want to draw a rotated @PangoLayout to an image buffer, and want to know how large the image should be and how much you should shift the layout when rendering.

For better accuracy, you should use `transform_rectangle()` on original rectangle in Pango units and convert to pixels afterward using `extents_to_pixels()`’s first argument.

###### `rect`

in/out bounding box in device units

source

#### pub fn transform_rectangle(&self, rect: &mut Rectangle)

First transforms @rect using @self, then calculates the bounding box of the transformed rectangle.

This function is useful for example when you want to draw a rotated @PangoLayout to an image buffer, and want to know how large the image should be and how much you should shift the layout when rendering.

If you have a rectangle in device units (pixels), use `transform_pixel_rectangle()`.

If you have the rectangle in Pango units and want to convert to transformed pixel bounding box, it is more accurate to transform it first (using this function) and pass the result to pango_extents_to_pixels(), first argument, for an inclusive rounded rectangle. However, there are valid reasons that you may want to convert to pixels first and then transform, for example when the transformed coordinates may overflow in Pango units (large matrix translation for example).

###### `rect`

in/out bounding box in Pango units

source

source

source

source

source

source

## Trait Implementations§

source§

### impl Clone for Matrix

source§

#### fn clone(&self) -> Self

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from `source`. Read more
source§

### impl Debug for Matrix

source§

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

Formats the value using the given formatter. Read more
source§

### impl HasParamSpec for Matrix

§

§

#### type SetValue = Matrix

Preferred value to be used as setter for the associated ParamSpec.
§

source§

source§

### impl StaticType for Matrix

source§

#### fn static_type() -> Type

Returns the type identifier of `Self`.
source§

§

§

§

§

§

## Blanket Implementations§

source§

### impl<T> Any for Twhere T: 'static + ?Sized,

source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
source§

### impl<T> Borrow<T> for Twhere T: ?Sized,

source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

### impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

### impl<T> From<T> for T

source§

#### fn from(t: T) -> T

Returns the argument unchanged.

source§

source§

source§

source§

source§

source§

source§

source§

source§

source§

source§

source§

source§

source§

source§

source§

source§

source§

source§

source§

source§

source§

source§

source§

source§

source§

source§

source§

source§

source§

source§

source§

source§

source§

source§

source§

source§

source§

source§

source§

source§

source§

source§

source§

source§

source§

source§

source§

source§

### impl<T, U> Into<U> for Twhere U: From<T>,

source§

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

source§

source§

source§

§

source§

§

source§

source§

### impl<T> StaticTypeExt for Twhere T: StaticType,

source§

#### fn ensure_type()

Ensures that the type has been registered with the type system.
source§

### impl<T> ToOwned for Twhere T: Clone,

§

#### type Owned = T

The resulting type after obtaining ownership.
source§

#### fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

#### fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

### impl<T> ToSendValue for Twhere T: Send + ToValue + ?Sized,

source§

#### fn to_send_value(&self) -> SendValue

Returns a `SendValue` clone of `self`.
source§

### impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

#### type Error = Infallible

The type returned in the event of a conversion error.
source§

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

source§

source§

### impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§