Bladeren bron

N3DS: Document the SDL_GetBasePath behaviour.

Pierre Wendling 2 jaren geleden
bovenliggende
commit
dcfa127fd4
2 gewijzigde bestanden met toevoegingen van 5 en 0 verwijderingen
  1. 1 0
      docs/README-n3ds.md
  2. 4 0
      include/SDL_filesystem.h

+ 1 - 0
docs/README-n3ds.md

@@ -24,3 +24,4 @@ cmake --install build
 -   Currently only software rendering is supported.
 -   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.
+-   `SDL_GetBasePath` returns the romfs root instead of the executable's directory.

+ 4 - 0
include/SDL_filesystem.h

@@ -60,6 +60,10 @@ extern "C" {
  * - `parent`: the containing directory of the bundle. For example:
  *   `/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
  * Windows, '/' on most other platforms).
  *