Add a compat option to change the error value with no context

1 files changed, 9 insertions, 0 deletions

diff --git a/docs/env-vars.txt b/docs/env-vars.txt
index 815a3098..0c15cbe9 100644
--- a/docs/env-vars.txt
+++ b/docs/env-vars.txt
@@ -78,6 +78,15 @@ Same as for __ALSOFT_REVERSE_Z, but for Y (up/down) panning.
 __ALSOFT_REVERSE_X
 Same as for __ALSOFT_REVERSE_Z, but for X (left/right) panning.
 
+__ALSOFT_DEFAULT_ERROR
+Applications that erroneously call alGetError prior to setting a context as
+current may not like that OpenAL Soft returns 0xA004 (AL_INVALID_OPERATION),
+indicating that the call could not be executed as there's no context to get the
+error value from. This can be set to 0 (AL_NO_ERROR) to let such apps pass the
+check despite the problem. Other applications, however, may see AL_NO_ERROR
+returned and assume any previous AL calls succeeded when they actually failed,
+so this should only be set when necessary.
+
 __ALSOFT_SUSPEND_CONTEXT
 Due to the OpenAL spec not being very clear about them, behavior of the
 alcSuspendContext and alcProcessContext methods has varied, and because of