Expand description
A collection of strongly typed math tools for computer graphics with an inclination towards 2d graphics and layout.
All types are generic over the scalar type of their component (f32
, i32
, etc.),
and tagged with a generic Unit parameter which is useful to prevent mixing
values from different spaces. For example it should not be legal to translate
a screen-space position by a world-space vector and this can be expressed using
the generic Unit parameter.
This unit system is not mandatory and all structures have an alias
with the default unit: UnknownUnit
.
for example default::Point2D<T>
is equivalent to Point2D<T, UnknownUnit>
.
Client code typically creates a set of aliases for each type and doesn’t need
to deal with the specifics of typed units further. For example:
use euclid::*;
pub struct ScreenSpace;
pub type ScreenPoint = Point2D<f32, ScreenSpace>;
pub type ScreenSize = Size2D<f32, ScreenSpace>;
pub struct WorldSpace;
pub type WorldPoint = Point3D<f32, WorldSpace>;
pub type ProjectionMatrix = Transform3D<f32, WorldSpace, ScreenSpace>;
// etc...
All euclid types are marked #[repr(C)]
in order to facilitate exposing them to
foreign function interfaces (provided the underlying scalar type is also repr(C)
).
Modules
Structs
T
and unit of measurement Unit
.Traits
Functions
Box3D::new(Point3D::new(x1, y1, z1), Point3D::new(x2, y2, z2))
.BoolVector2D { x, y }
.BoolVector3D { x, y, z }
.Point2D::new(x, y)
.Point3D::new(x, y)
.Rect::new(Point2D::new(x, y), Size2D::new(w, h))
.Size2D::new(w, h)
.Size3D::new(w, h, d)
.