Added documentation on loading assets on Android.

libsdl-org · Nov 4, 2012 · 81cc7c6 · 81cc7c6
1 parent dfa9336
commit 81cc7c6
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 2 deletions.
diff --git a/README.android b/README.android
@@ -123,6 +123,22 @@ res directory.
 You may need to change the name of your icon in AndroidManifest.xml to match
 the filename used by Eclipse.
 
+================================================================================
+ Loading assets
+================================================================================
+
+Any files you put in the "assets" directory of your android-project directory
+will get bundled into the application package and you can load them using the
+standard functions in SDL_rwops.h.
+
+There are also a few Android specific functions that allow you to get other
+useful paths for saving and loading data:
+SDL_AndroidGetInternalStoragePath()
+SDL_AndroidGetExternalStorageState()
+SDL_AndroidGetExternalStoragePath()
+
+See SDL_system.h for more details on these functions.
+
 ================================================================================
  Pause / Resume behaviour
 ================================================================================

diff --git a/include/SDL_system.h b/include/SDL_system.h
@@ -76,7 +76,10 @@ extern DECLSPEC void * SDLCALL SDL_AndroidGetActivity();
 #define SDL_ANDROID_EXTERNAL_STORAGE_READ   0x01
 #define SDL_ANDROID_EXTERNAL_STORAGE_WRITE  0x02
 
-/* Get the path used for internal storage for this application */
+/* Get the path used for internal storage for this application.
+   This path is unique to your application and cannot be written to
+   by other applications.
+ */
 extern DECLSPEC const char * SDLCALL SDL_AndroidGetInternalStoragePath();
 
 /* Get the current state of external storage, a bitmask of these values:
@@ -86,7 +89,10 @@ extern DECLSPEC const char * SDLCALL SDL_AndroidGetInternalStoragePath();
 */
 extern DECLSPEC int SDLCALL SDL_AndroidGetExternalStorageState();
 
-/* Get the path used for external storage for this application */
+/* Get the path used for external storage for this application.
+   This path is unique to your application, but is public and can be
+   written to by other applications.
+ */
 extern DECLSPEC const char * SDLCALL SDL_AndroidGetExternalStoragePath();
 
 #endif /* __ANDROID__ */