mirror of
https://github.com/mackron/miniaudio.git
synced 2026-04-24 01:04:02 +02:00
Update documentation.
This commit is contained in:
@@ -490,7 +490,19 @@ struct mal_device
|
|||||||
// is stored in the mal_device structure.
|
// is stored in the mal_device structure.
|
||||||
//
|
//
|
||||||
// <backends> is used to allow the application to prioritize backends depending on it's specific
|
// <backends> is used to allow the application to prioritize backends depending on it's specific
|
||||||
// requirements. This can be null in which case it uses the default priority.
|
// requirements. This can be null in which case it uses the default priority, which is as follows:
|
||||||
|
// - WASAPI
|
||||||
|
// - DirectSound
|
||||||
|
// - ALSA
|
||||||
|
// - OpenSL|ES
|
||||||
|
// - Null
|
||||||
|
//
|
||||||
|
// Return Value:
|
||||||
|
// - MAL_SUCCESS if successful.
|
||||||
|
// - MAL_INVALID_ARGS
|
||||||
|
// One or more of the input arguments is invalid.
|
||||||
|
// - MAL_NO_BACKEND
|
||||||
|
// There is no supported backend, or there was an error loading it (such as a missing dll/so).
|
||||||
//
|
//
|
||||||
// Thread Safety: UNSAFE
|
// Thread Safety: UNSAFE
|
||||||
//
|
//
|
||||||
@@ -502,6 +514,13 @@ mal_result mal_context_init(mal_backend backends[], mal_uint32 backendCount, mal
|
|||||||
//
|
//
|
||||||
// Results are undefined if you call this while a related is still active.
|
// Results are undefined if you call this while a related is still active.
|
||||||
//
|
//
|
||||||
|
// Return Value:
|
||||||
|
// - MAL_SUCCESS if successful.
|
||||||
|
// - MAL_INVALID_ARGS
|
||||||
|
// One or more of the input arguments is invalid.
|
||||||
|
// - MAL_NO_BACKEND
|
||||||
|
// The device has an unknown backend. This probably means the context of <pContext> has been trashed.
|
||||||
|
//
|
||||||
// Thread Safety: UNSAFE
|
// Thread Safety: UNSAFE
|
||||||
//
|
//
|
||||||
// Efficiency: LOW
|
// Efficiency: LOW
|
||||||
@@ -4228,6 +4247,7 @@ mal_result mal_context_uninit(mal_context* pContext)
|
|||||||
default: break;
|
default: break;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
mal_assert(false);
|
||||||
return MAL_NO_BACKEND;
|
return MAL_NO_BACKEND;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user