(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_HINT_WAVE_RIFF_CHUNK_SIZE

A variable controlling how the size of the RIFF chunk affects the loading of a WAVE file.

Header File

Defined in <SDL3/SDL_hints.h>

Syntax

#define SDL_HINT_WAVE_RIFF_CHUNK_SIZE "SDL_WAVE_RIFF_CHUNK_SIZE"

Remarks

The size of the RIFF chunk (which includes all the sub-chunks of the WAVE file) is not always reliable. In case the size is wrong, it's possible to just ignore it and step through the chunks until a fixed limit is reached.

Note that files that have trailing data unrelated to the WAVE file or corrupt files may slow down the loading process without a reliable boundary. By default, SDL stops after 10000 chunks to prevent wasting time. Use SDL_HINT_WAVE_CHUNK_LIMIT to adjust this value.

The variable can be set to the following values:

• "force" - Always use the RIFF chunk size as a boundary for the chunk search.
• "ignorezero" - Like "force", but a zero size searches up to 4 GiB. (default)
• "ignore" - Ignore the RIFF chunk size and always search up to 4 GiB.
• "maximum" - Search for chunks until the end of file. (not recommended)

This hint should be set before calling SDL_LoadWAV() or SDL_LoadWAV_IO()

Version

This hint is available since SDL 3.1.3.

---

CategoryAPI, CategoryAPIMacro, CategoryHints

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.