https://github.com/stregasgate/gamemath
GameMath provides common types, related functions, and operators used for interactive realtime simulations (games).
https://github.com/stregasgate/gamemath
gamedev
Last synced: about 1 year ago
JSON representation
GameMath provides common types, related functions, and operators used for interactive realtime simulations (games).
- Host: GitHub
- URL: https://github.com/stregasgate/gamemath
- Owner: STREGAsGate
- License: apache-2.0
- Created: 2021-03-29T01:36:26.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-05-21T23:08:39.000Z (about 3 years ago)
- Last Synced: 2025-04-14T23:55:05.252Z (about 1 year ago)
- Topics: gamedev
- Language: Swift
- Homepage:
- Size: 357 KB
- Stars: 53
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# GameMath
[](https://github.com/STREGAsGate/GameMath/actions/workflows/Windows.yml)
[](https://github.com/STREGAsGate/GameMath/actions/workflows/macOS.yml)
[](https://github.com/STREGAsGate/GameMath/actions/workflows/Linux.yml)
[](https://github.com/STREGAsGate/GameMath/actions/workflows/SwiftWasm.yml)
GameMath provides common types, related functions, and operators commonly used for interactive realtime simulations (games).
You can use this library to create simple games, or use it as a cornerstone for a more complex engine like [GateEngine](https://github.com/STREGAsGate/GateEngine).
## Swift 100%
GameMath uses protocols and generics to promote clear type intention. Vector types as an example have many variations including `Position3`, `Direction3`, and `Size3` that all conform to`Vector3`, a protocol that provides common functionality to these types.
Operators such as multiplication, division, addition, and subtraction, can be used across types so long as they use the same generic constraint. The type returned will be the logical result of the operation, usually the left side.
```swift
//Success
let pos: Position3 = Position3(0, 1, 0) * Size3(1, 1, 1)
//Error: Size3 cannot be converted to Position3
let pos: Position3 = Size3(1, 1, 1) * Position3(0, 1, 0)
```
## Easy To Understand
GameMath is intended to make doing gamming math easier for everyone. An example is interpolation.
The functions `lerp()` and `slerp()` are commonly seen in game libraries for linear interpolation. Without advanced knowledge of these functions it's difficult to reason about them and know what they do.
GameMath attempts to improve on this issue by introducing a common syntax for interpolation for all types across the package.
```swift
let halfway = source.interpolated(to: destination, .linear(0.5))
```
This syntax will be expanded with new interpolation methods like easeIn and easeOut in the future.
## Coordinate Space
GameMath uses a *Y Up*, *-Z forward*, coordinate system for 3D and *Y Up*, *X Right* for 2D.
Matrix types are assumed to always be *"left handed"*. Use the `transposedArray` and `transposedSIMD` properties when sending data to Metal, Vulkan, OpenGL, and the `array` and `simd` properties when sending data to DirectX.
# Cross Platform
GameMath is tested to work on Windows 10, macOS, Ubuntu, iOS, tvOS, and HTML5.
Other platforms should also work.
# Support Gate Engine!
This package is seperated for you to enjoy, but it's built for and used by [GateEngine](https://github.com/STREGAsGate/GateEngine).
If you appreciate this project, and want it to continue, then please consider putting some dollars into it.
Every little bit helps! Support With: [GitHub](https://github.com/sponsors/STREGAsGate), [Ko-fi](https://ko-fi.com/STREGAsGate), [Pateron](https://www.patreon.com/STREGAsGate)
## Community & Followables
[](https://discord.gg/5JdRJhD)
[](https://twitter.com/stregasgate)
[](https://youtube.com/stregasgate)
[](https://www.reddit.com/r/stregasgate/)