Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Up for assigning - Documenting AL constants #1

Open
YanniZ06 opened this issue Aug 7, 2023 · 0 comments
Open

Up for assigning - Documenting AL constants #1

YanniZ06 opened this issue Aug 7, 2023 · 0 comments
Labels
Improvement Suggestion Any: Suggests improvement of code or feature

Comments

@YanniZ06
Copy link
Owner

YanniZ06 commented Aug 7, 2023

OpenAL has a lot of constants set to be used as parameters in various get and set functions, some of which even ambigiously work with multiple functions.

The constants are already in the source:

image

It would be pretty nice to have them documented properly for the API webpage that will be set up once this is done (using dox).
I could very much do this myself, however im trying to focus more on the main important stuff for now and anyone that (for some reason) feels like doing this can leave a comment and I'll assign them this "issue".

For information on the constants you can and probably should use the openal soft documentation page (https://www.openal.org/documentation/OpenAL_Programmers_Guide.pdf).
You may also freely directly copy the information given to a degree, as the programmers guide will be listed as a source I used for the project anyways.

@YanniZ06 YanniZ06 added the Improvement Suggestion Any: Suggests improvement of code or feature label Aug 7, 2023
@YanniZ06 YanniZ06 pinned this issue Aug 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Improvement Suggestion Any: Suggests improvement of code or feature
Projects
None yet
Development

No branches or pull requests

1 participant