cvmath 0.0.5

Computer Graphics Vector Math Library
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69

Computer Vector Graphics Math Library
=====================================

[![MIT License](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![crates.io](https://img.shields.io/crates/v/cvmath.svg)](https://crates.io/crates/cvmath)
[![docs.rs](https://docs.rs/cvmath/badge.svg)](https://docs.rs/cvmath)
[![Build status](https://github.com/CasualX/cvmath/workflows/CI/badge.svg)](https://github.com/CasualX/cvmath/actions)

> Because reinventing the wheel is half the fun.

![Path Tracing Example](images/pathtracing.png)  
*A path tracing scene using `cvmath`. See [pathtracing.rs](examples/pathtracing/main.rs).*

🔍 What is this?
---------------

`cvmath` is a lightweight, graphics-oriented math library written in Rust. It focuses on **vector math and geometric primitives** commonly used in computer graphics. It is not a general-purpose numerical library.

If you're building 2D/3D renderers, ray tracers, or similar tools and want something compact and to the point, this might be a good fit.

The API is lean, clear, and practical.


✨ Features Overview
--------------------

All types are available at the crate root.

### General Types

- `Vec2<T>`, `Vec3<T>`, `Vec4<T>` — 2D, 3D, and 4D vectors
- `Bool2`, `Bool3`, `Bool4` — Boolean vector masks
- `Angle<T>` — Angles in radians
- `Complex<T>`, `Polar<T>`, `Quat<T>` — Complex numbers, polar coordinates, and quaternions

### Matrices and Transformations

- `Mat2<T>`, `Mat3<T>`, `Mat4<T>` — General-purpose matrices
- `Transform2<T>`, `Transform3<T>` — Affine transformations

### Shapes and Geometry

Shapes are available in 2D and 3D variants.

- `Point2<T>`, `Point3<T>` — 2D and 3D points
- `Bounds2<T>`, `Bounds3<T>` — Axis-aligned bounding boxes
- `Plane2<T>`, `Plane3<T>` — Infinite planes
- `Circle<T>`, `Sphere<T>` — Defined by a center point and radius
- `Line2<T>`, `Line3<T>` — Line segments defined by two points
- `Triangle2<T>`, `Triangle3<T>` — Triangles defined by three points
- `Shape2<T>`, `Shape3<T>` — Generic shape enums for flexible composition

### Ray Tracing

Types involved in ray casting and intersection:

- `Ray2<T>`, `Ray3<T>` — Rays defined by origin, direction, and max distance
- `Hit2<T>`, `Hit3<T>` — Intersection results (distance, normal, index)
- `Trace2<T>`, `Trace3<T>` — Traits for types that support ray tracing

🔓 License
----------

Licensed under the [MIT License](https://opensource.org/licenses/MIT), see [license.txt](license.txt) for details.

### Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, shall be licensed as above, without any additional terms or conditions.