Clarify async loading documentation in preset load callback

This commit is contained in:
Mischa
2026-01-24 23:34:00 -08:00
committed by Mischa Spiegelmock
parent e718f99e6f
commit 5acd8bf9ee

View File

@ -76,7 +76,6 @@ typedef void (*projectm_playlist_preset_switch_failed_event)(const char* preset_
* letting the playlist library load presets from the filesystem. This is useful for:
* - Loading presets from archives (e.g., ZIP files)
* - Loading presets from network sources (e.g., HTTP)
* - Asynchronous preset loading
* - Custom preset storage solutions
*
* When this callback is set and returns true, the playlist library will NOT attempt
@ -86,6 +85,9 @@ typedef void (*projectm_playlist_preset_switch_failed_event)(const char* preset_
* - Handling any loading errors
* - Firing the preset_switched_event callback when the preset is ready (if desired)
*
* Note: If implementing asynchronous loading, the application must complete the load and
* fire the preset_switched_event callback itself after the async operation completes.
*
* If the callback returns false or is not set, the playlist library will use the
* default behavior of loading the preset from the filesystem.
*