mirror/miniaudio
1
0
Fork 0
mirror of https://github.com/mackron/miniaudio.git synced 2026-04-23 00:34:03 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update docs.

Browse Source
This commit is contained in:
David Reid
2022-11-04 11:39:33 +10:00
parent 950d4e31d0
commit aa8fdec254
1 changed files with 15 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/manual/index.html
+15 -3
View File
@@ -2379,6 +2379,16 @@ tracks in games.
</p> </p>
<p> <p>
When loading a sound from a file path, the engine will reference count the file to prevent it from
being loaded if it&#39;s already in memory. When you uninitialize a sound, the reference count will be
decremented, and if it hits zero, the sound will be unloaded from memory. This reference counting
system is not used for streams. The engine will use a 64-bit hash of the file name when comparing
file paths which means there&#39;s a small chance you might encounter a name collision. If this is an
issue, you&#39;ll need to use a different name for one of the colliding file paths, or just not load
from files and instead load from a data source.
</p>
<p>
When you initialize a sound, if you specify a sound group the sound will be attached to that group When you initialize a sound, if you specify a sound group the sound will be attached to that group
automatically. If you set it to NULL, it will be automatically attached to the engine&#39;s endpoint. automatically. If you set it to NULL, it will be automatically attached to the engine&#39;s endpoint.
If you would instead rather leave the sound unattached by default, you can can specify the If you would instead rather leave the sound unattached by default, you can can specify the
@@ -3180,9 +3190,11 @@ A binary search tree (BST) is used for storing data buffers as it has good balan
efficiency and simplicity. The key of the BST is a 64-bit hash of the file path that was passed efficiency and simplicity. The key of the BST is a 64-bit hash of the file path that was passed
into <span style="font-family:monospace;">ma_resource_manager_data_source_init()</span>. The advantage of using a hash is that it saves into <span style="font-family:monospace;">ma_resource_manager_data_source_init()</span>. The advantage of using a hash is that it saves
memory over storing the entire path, has faster comparisons, and results in a mostly balanced BST memory over storing the entire path, has faster comparisons, and results in a mostly balanced BST
due to the random nature of the hash. The disadvantage is that file names are case-sensitive. If due to the random nature of the hash. The disadvantages are that file names are case-sensitive and
this is an issue, you should normalize your file names to upper- or lower-case before initializing there&#39;s a small chance of name collisions. If case-sensitivity is an issue, you should normalize
your data sources. your file names to upper- or lower-case before initializing your data sources. If name collisions
become an issue, you&#39;ll need to change the name of one of the colliding names or just not use the
resource manager.
</p> </p>
<p> <p>