![Build Status] ![Coverage Status] ![Latest Version] ![docs]
A simple and fast 3D math library for games and graphics.
glam is in beta stage. Base functionality has been implemented and the look
and feel of the API has solidified.
f32) arithmetic is supportedVec2, Vec3, Vec3A Vec4Mat2, Mat3, Mat4QuatThe Vec3A, Vec4 and Quat types use SSE2 on x86/x86_64 architectures.
Mat2, Mat3 and Mat4 also use SSE2 for some functionality. Not everything
has a SIMD implementation yet.
Note that this does result in some wasted space in the case of Vec3A as the
SIMD vector type is 16 bytes large and 16 byte aligned.
glam outperforms similar Rust libraries for common operations as tested by the
mathbench project.
Due to the use of SIMD, vector elements may only be get and set via accessor
methods, e.g. Vec4::x() and Vec4::x_mut() or Vec4::set_x(). If getting or
setting more than one element it is more efficient to convert from tuples or
arrays:
let (x, y, z, w) = v.into();
let [x, y, z, w]: [f32; 4] = v.into();
no_std supportno_std support can be enabled by compiling with --no-default-features to
disable std support and --features libm for math functions that are only
defined in std. For example:
toml
[dependencies]
glam = { version = "0.10.0", default-features = false, features = ["libm"] }
bytemuck - for casting into slices of byteslibm - required to compile with no_stdmint - for interoperating with other 3D math librariesnum-traits - required to compile no_std, will be included when enabling
the libm featurerand - implementations of Distribution trait for all glam types. This
is primarily used for unit testingserde - implementations of Serialize and Deserialize for all glam
types. Note that serialization should work between builds of glam with and
without SIMD enabledscalar-math - compiles with SIMD support disableddebug-glam-assert - adds assertions in debug builds which check the validity
of parameters passed to glam to help catch runtime errorsglam-assert - adds validation assertions to all buildsThe minimum supported version of Rust for glam is 1.36.0.
glam interprets vectors as column matrices (also known as "column vectors")
meaning when transforming a vector with a matrix the matrix goes on the left,
e.g. v' = Mv. DirectX uses row vectors, OpenGL uses column vectors. There
are pros and cons to both.
Matrices are stored in column major format. Each column vector is stored in contiguous memory.
glam is co-ordinate system agnostic and intends to support both right handed
and left handed conventions.
The design of this library is guided by a desire for simplicity and good performance.
f32 arithmetic is supported for nowmint, rand and serde)Mat4 for certain operations like inverse and multipliesno-std supportwasm supportThere were many inspirations for the interface and internals of glam from the Rust and C++ worlds. In particular:
Vec3A
implementationglam is a play on the name of the popular C++ library [GLM]Licensed under either of
at your option.
Contributions in any form (issues, pull requests, etc.) to this project must adhere to Rust's [Code of Conduct].
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
Thank you to all of the glam [contributors]!
If you are interested in contributing or have a request or suggestion [create an issue] on github.
The [Game Development in Rust Discord] and [Bevy Engine Discord] servers can are
also good places to ask for help with glam.
glam contains code ported from the following C++ libraries:
See [ATTRIBUTION.md] for details.