maihd / hlslmath

HLSL math types and functions for C++

HLSL's Math library

Vectors and matrices for based on HLSL language for C++.

License

This library is unlicensed.

Build

cd tools

# Unix or OS X (require gcc)
make
./build --output=<output> --namespace=<namespace>

# Windows (has prebuilt)
# `make` if you build new executor
build.exe --output=<output> --namespace=<namespace>

Scalar types

• int
• uint
• bool
• float
• double
• fixed
• half
• short
• ushort
• long
• ulong

Template types

• Vector 2, 3, 4 (float, int, uint, bool)
• Matrix 2x2, 3x3, 4x4 (float, int, uint, bool)
• Matrix 2x3, 2x4
• Matrix 3x2, 3x4
• Matrix 4x2, 4x3
• Quaternion: present as float4, qmul, qinverse, qconj, qeuler

Examples

...
float3 position;
float3 scalation;
float3 axis;
float  angle;

// Initialize your transform with deprecated API
//  - Have some issues to implements
//  - More cleaner for some guys are familiar with '::'
//  - Will be remove because data & code should be seperate from the API, you can use your own code on float4x4 (or any type) if you know that give better result

float4x4 translateMatrix = float4x4::translate(position);
float4x4 scalationMatrix = float4x4::scale(scalation);
float4x4 axisAngleMatrix = float4x4::rotate(axis, angle);

float4x4 modelMatrix = mul(mul(translateMatrix, scalationMatrix), axisAngleMatrix);
float4x4 projectionMatrix = float4x4::perspective(radian(45.0f), WIDTH / HEIGHT, 0.0f, 100.0f);
float4x4 projectionMatrix2DOrIsometric = float4x4::ortho(0.0f, WIDTH, 0.0f, HEIGHT, 0.0f, 1.0f);

// Initialize your transform with new API
//  - Data and code seperates
//  - Easier to add extensions
//  - Prefix with type name, familiar to OpenGL, Vulkan guys

float4x4 positionMatrix = float4x4Translation(position);
float4x4 scalationMatrix = float4x4Scalation(scalation);

float4x4 xAxisRotationMatrix = float4x4RotationX(angle);
float4x4 yAxisRotationMatrix = float4x4RotationY(angle);
float4x4 zAxisRotationMatrix = float4x4RotationZ(angle);
float4x4 eulerRotationMatrix = float4x4Rotation(euler);
float4x4 quaternionRotationMatrix = float4x4Rotation(quaterion);
float4x4 axisAngleRotationMatrix = float4x4Rotation(axis, angle);

float4x4 modelMatrix = mul(mul(translateMatrix, scalationMatrix), axisAngleMatrix);
float4x4 projectionMatrix = float4x4Perspective(radian(45.0f), WIDTH / HEIGHT, 0.0f, 100.0f);
float4x4 projectionMatrix2DOrIsometric = float4x4Ortho(0.0f, WIDTH, 0.0f, HEIGHT, 0.0f, 1.0f);

// Apply matrix to your render pipeline
...

Documentation

Work in progress.