Added the Programmer's Guide for documentation #168
Conversation
|
|
||
| #### alGetBooleanv | ||
| ##### Description | ||
| This function returns an integer OpenAL state. |
There was a problem hiding this comment.
Seems to be a copy-paste error, this should be boolean OpenAL state.
| ```cpp | ||
| void alGetBooleanv( | ||
| ALenum param, | ||
| ALboolean* data |
There was a problem hiding this comment.
Not sure if this was intentional, but a number of functions seem to have extra indentation on some parameters.
| | ----------------- | --------- | ----------- | | ||
| | AL_DOPPLER_FACTOR | `f` | Global Doppler factor | | ||
| | AL_SPEED_OF_SOUND | `f` | Speed of sound in units per second | | ||
| | AL_DISTANCE_MODEL | `f` | Distance model enumeration value | |
There was a problem hiding this comment.
AL_DISTANCE_MODEL should have the i data type.
| | AL_GAIN | `f`, `fv` | Master gain. Value should be positive | | ||
| | AL_POSITION | `fv`, `3f`, `iv`, `3i` | X, Y, Z position | | ||
| | AL_VELOCITY | `fv`, `3f`, `iv`, `3i` | Velocity vector | | ||
| | AL_ORIENTATION | `fv`, `fv` | Orientation expressed as "at" and "up" vectors | |
| ``` | ||
|
|
||
| Here is a graph showing the inverse distance curve: | ||
|  |
There was a problem hiding this comment.
This seems to be showing as a link, rather than an inline image. The same happens for the Linear and Exponential figures, which also have an incorrect caption (they both say "Inverse Distance Curve" as well).
|
Shouldn't this documentation also have OpenAL Soft specific details? Currently I'm implementing the audio subsystem with OpenAL Soft in my game, but I've no idea what are the specific OpenAL Soft changes, if there are any. This documentation is also missing the Effects Extension Guide :). |
I couldn't find any documentation on how to use this library. I noticed in #164 that there was a complaint that the documentation was not in a format that was editable so I went through the Programmer's Guide and changed it into markdown.
This won't exactly follow how openal-soft works but should form a good base for editing.
Let me know if it needs any changes.