Sort out primary include headers for users

dangmoody / HLML

Auto-generated maths library for C and C++ based on HLSL/Cg

24 stars 1 forks source link

Sort out primary include headers for users #8

Closed dangmoody closed 4 years ago

dangmoody commented 5 years ago

The main headers that users include are currently:

hlml_functions_scalar.h
hlml_functions_vector.h
hlml_functions_matrix.h

It's not obvious that these are the main headers to include (both by name and documentation).

So either this needs to be documented, or better header names need to be thought of.

dangmoody commented 4 years ago

This has been sorted in one of my development branches and I'll mark it as closed when that all gets merged in.

dangmoody commented 4 years ago

I can't find the commit where this got fixed, but it got fixed.

Depending on if you're using the C or C++ implementations of the library, you'll have to either include #include <hlml/c/hlml.h> or #include <hlml/cpp/hlml.h>.

In one source file you'll also need to define HLML_IMPLEMENTATION so that the function bodies themselves get defined. This is the same as how the STB libraries work.