encounter
/
SDL
mirror of https://github.com/encounter/SDL.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

N3DS: Document the SDL_GetBasePath behaviour.

This commit is contained in:
Pierre Wendling 2022-11-14 17:34:22 -05:00 committed by Sam Lantinga
parent de5fa89b50
commit dcfa127fd4
2 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/README-n3ds.md
View File

@ -24,3 +24,4 @@ cmake --install build
- Currently only software rendering is supported. - Currently only software rendering is supported.
- SDL2main should be used to ensure ROMFS is enabled. - SDL2main should be used to ensure ROMFS is enabled.
- 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. - 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.

4
include/SDL_filesystem.h
View File

@ -60,6 +60,10 @@ extern "C" {
* - `parent`: the containing directory of the bundle. For example: * - `parent`: the containing directory of the bundle. For example:
* `/Applications/SDLApp/` * `/Applications/SDLApp/`
* *
* **Nintendo 3DS Specific Functionality**: This function returns "romfs"
* directory of the application as it is uncommon to store resources
* outside the executable. As such it is not a writable directory.
*
* The returned path is guaranteed to end with a path separator ('\' on * The returned path is guaranteed to end with a path separator ('\' on
* Windows, '/' on most other platforms). * Windows, '/' on most other platforms).
* *