Update doc/README-* for header-only SDL_main

This commit is contained in:
Daniel Gibson
2022-12-12 23:27:58 +01:00
committed by Sam Lantinga
parent c3bf253b09
commit ab554c8392
8 changed files with 38 additions and 23 deletions

View File

@@ -22,7 +22,7 @@ cmake --install build
## Notes
- Currently only software rendering is supported.
- SDL3_main should be used to ensure ROMFS is enabled.
- SDL3_main should be used to ensure ROMFS is enabled - this is done with `#include <SDL3/SDL_main.h>` in the source file that contains your main function.
- By default, the extra L2 cache and higher clock speeds of the New 2/3DS lineup are enabled. If you wish to turn it off, use `osSetSpeedupEnable(false)` in your main function.
- `SDL_GetBasePath` returns the romfs root instead of the executable's directory.
- The Nintendo 3DS uses a cooperative threading model on a single core, meaning a thread will never yield unless done manually through the `SDL_Delay` functions, or blocking waits (`SDL_LockMutex`, `SDL_SemWait`, `SDL_CondWait`, `SDL_WaitThread`). To avoid starving other threads, `SDL_SemTryWait` and `SDL_SemWaitTimeout` will yield if they fail to acquire the semaphore, see https://github.com/libsdl-org/SDL/pull/6776 for more information.