Commit dcfa127fd4c553db20f3e53cad9dfa7916a19b84

Pierre Wendling 2022-11-14T17:34:22

N3DS: Document the SDL_GetBasePath behaviour.

diff --git a/docs/README-n3ds.md b/docs/README-n3ds.md
index 991eaa0..66e194d 100644
--- a/docs/README-n3ds.md
+++ b/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.
diff --git a/include/SDL_filesystem.h b/include/SDL_filesystem.h
index a7606bd..60f8202 100644
--- a/include/SDL_filesystem.h
+++ b/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).
  *