gmm 0.3.0

Math library for video games
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

# Game Math for Me
A math library for video games that allow independent management of data.
Just like [DirectXMath](https://github.com/microsoft/DirectXMath), data and vectors are divided.

# Design
### Data Type
Data types are designed to be used when storing data in files or exchanging it with other systems.

#### Example
```rust
use gmm::Float4;
 
let a = Float4::new(1.0, 2.0, 3.0, 4.0);
let s = Float4::fill(5.0);
let res = a + s;
 
println!("{} + {} = {}", a, s, res);
```

### Vector Type
Vector types are designed to be used when processing calculations.
Some systems use `SIMD` instructions.

#### Example
```rust
use gmm::Vector;
 
let a = Vector::new(1.0, 2.0, 3.0, 4.0);
let s = Vector::fill(5.0);
 
let res = a + s;
 
println!("{} + {} = {}", a, s, res);
```


# Features
### Supports SIMD operations
The gmm library supports SIMD instructions on the `x86`, `x86_64` and the `aarch64` architecture.

### Compile Features
- `bytemuck` - Enables the bytemuck library implementation.
- `serde` - Enables the serde library implementation.
- `mint` - Enables the mint library implementation.
- `scalar-math` - Disable the simd instruction in the library.
- `use-assertion` - Allow panic calls within a function.

# License
MIT license (LICENSE or http://opensource.org/licenses/MIT)