hodasemi/cgmath
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity
838 commits 1 branch 0 tags 3.5 MiB
Rust 100%
Go to file
Corey Richardson 82529eec25 Update transform test to use Decomposed instead of Transform3D
2014-06-24 00:25:57 -07:00
src Update transform test to use Decomposed instead of Transform3D 2014-06-24 00:25:57 -07:00
.gitignore Document Matrix 2014-05-25 01:01:02 -07:00
.travis.yml Update for Cargo 2014-06-23 23:49:29 -07:00
AUTHORS Add Colin Sherratt to AUTHORS 2013-11-28 11:00:06 +10:00
cargo-lite.conf Update cargo-lite.conf 2014-02-17 06:53:33 -05:00
Cargo.toml Update for Cargo 2014-06-23 23:49:29 -07:00
LICENSE Add license/copyright notices to source files 2013-06-01 08:01:01 +10:00
Makefile Update for Cargo 2014-06-23 23:49:29 -07:00
README.md Remove obsolete compilation instructions 2014-02-14 07:29:24 +11:00

README.md

cgmath-rs

Build Status

A linear algebra and mathematics library for computer graphics.

The library provides:

  • vectors: Vec2, Vec3, Vec4
  • square matrices: Mat2, Mat3, Mat4
  • a quaternion type: Quat
  • rotation matrices: Rot2, Rot3
  • angle units: Rad, Deg
  • points: Point2, Point3
  • rays: Ray2, Ray3
  • a plane type: Plane
  • perspective projections: Perspective, PerspectiveFov, Ortho
  • a view frustum: Frustrum
  • spatial transformations: AffineMatrix3, Transform3D
  • axis-aligned bounding boxes: Aabb2, Aabb3
  • oriented bounding boxes: Obb2, Obb3
  • collision primitives: Sphere, Cylinder

Not all of the functionality has been implemented yet, and the existing code is not fully covered by the testsuite. If you encounter any mistakes or omissions please let me know by posting an issue, or even better: send me a pull request with a fix.

Limitations

cgmath is not an n-dimensional library and is aimed at computer graphics applications rather than general linear algebra. It only offers the 2, 3, and 4 dimensional structures that are more than useful for most computer graphics applications. This design decision was made in order to simplify the implementation (Rust cannot paramerise over constants at compile time), and to make dimension-specific optimisations easier in the future.

Contributing

Pull requests are most welcome, especially in the realm of performance enhancements and fixing any mistakes I may have made along the way. Unit tests and benchmarks are also required, so help on that front would be most appreciated.

Support

Contact bjz on irc.mozilla.org #rust and #rust-gamedev, or post an issue on Github.