include/SDL_system.h
author David Ludwig <dludwig@pobox.com>
Tue, 22 Jan 2013 21:45:59 -0500
changeset 8388 1e6ddf458e65
parent 6683 b1124b32b07d
child 8403 fbf6bb26c8ce
permissions -rw-r--r--
WinRT: added platform-specific APIs to access common, writable folder paths
     1 /*
     2   Simple DirectMedia Layer
     3   Copyright (C) 1997-2012 Sam Lantinga <slouken@libsdl.org>
     4 
     5   This software is provided 'as-is', without any express or implied
     6   warranty.  In no event will the authors be held liable for any damages
     7   arising from the use of this software.
     8 
     9   Permission is granted to anyone to use this software for any purpose,
    10   including commercial applications, and to alter it and redistribute it
    11   freely, subject to the following restrictions:
    12 
    13   1. The origin of this software must not be misrepresented; you must not
    14      claim that you wrote the original software. If you use this software
    15      in a product, an acknowledgment in the product documentation would be
    16      appreciated but is not required.
    17   2. Altered source versions must be plainly marked as such, and must not be
    18      misrepresented as being the original software.
    19   3. This notice may not be removed or altered from any source distribution.
    20 */
    21 
    22 /**
    23  *  \file SDL_system.h
    24  *  
    25  *  Include file for platform specific SDL API functions
    26  */
    27 
    28 #ifndef _SDL_system_h
    29 #define _SDL_system_h
    30 
    31 #include "SDL_stdinc.h"
    32 
    33 #if defined(__IPHONEOS__) && __IPHONEOS__
    34 #include "SDL_video.h"
    35 #include "SDL_keyboard.h"
    36 #endif
    37 
    38 #include "begin_code.h"
    39 /* Set up for C function definitions, even when using C++ */
    40 #ifdef __cplusplus
    41 /* *INDENT-OFF* */
    42 extern "C" {
    43 /* *INDENT-ON* */
    44 #endif
    45 
    46 /* Platform specific functions for iOS */
    47 #if defined(__IPHONEOS__) && __IPHONEOS__
    48 
    49 extern DECLSPEC int SDLCALL SDL_iPhoneSetAnimationCallback(SDL_Window * window, int interval, void (*callback)(void*), void *callbackParam);
    50 extern DECLSPEC void SDLCALL SDL_iPhoneSetEventPump(SDL_bool enabled);
    51 
    52 #endif /* __IPHONEOS__ */
    53 
    54 
    55 /* Platform specific functions for Android */
    56 #if defined(__ANDROID__) && __ANDROID__
    57 
    58 /* Get the JNI environment for the current thread
    59    This returns JNIEnv*, but the prototype is void* so we don't need jni.h
    60  */
    61 extern DECLSPEC void * SDLCALL SDL_AndroidGetJNIEnv();
    62 
    63 /* Get the SDL Activity object for the application
    64    This returns jobject, but the prototype is void* so we don't need jni.h
    65  */
    66 extern DECLSPEC void * SDLCALL SDL_AndroidGetActivity();
    67 
    68 /* See the official Android developer guide for more information:
    69    http://developer.android.com/guide/topics/data/data-storage.html
    70 */
    71 #define SDL_ANDROID_EXTERNAL_STORAGE_READ   0x01
    72 #define SDL_ANDROID_EXTERNAL_STORAGE_WRITE  0x02
    73 
    74 /* Get the path used for internal storage for this application.
    75    This path is unique to your application and cannot be written to
    76    by other applications.
    77  */
    78 extern DECLSPEC const char * SDLCALL SDL_AndroidGetInternalStoragePath();
    79 
    80 /* Get the current state of external storage, a bitmask of these values:
    81     SDL_ANDROID_EXTERNAL_STORAGE_READ
    82     SDL_ANDROID_EXTERNAL_STORAGE_WRITE
    83    If external storage is currently unavailable, this will return 0.
    84 */
    85 extern DECLSPEC int SDLCALL SDL_AndroidGetExternalStorageState();
    86 
    87 /* Get the path used for external storage for this application.
    88    This path is unique to your application, but is public and can be
    89    written to by other applications.
    90  */
    91 extern DECLSPEC const char * SDLCALL SDL_AndroidGetExternalStoragePath();
    92 
    93 #endif /* __ANDROID__ */
    94 
    95 
    96 /* Platform specific functions for Windows RT */
    97 #if defined(__WINRT__) && __WINRT__
    98 
    99 /* Gets the path to the local app data store.
   100    Files and directories that should be limited to the local device can be
   101    created in this path.
   102 
   103    This function may be used safely on Windows Phone 8, as opposed to
   104    SDL_WinRTGetRoamingFolderPath() and SDL_WinRTGetTemporaryFolderPath(),
   105    which do not work on Windows Phone 8 (and will return NULL if called
   106    from this platform).
   107  */
   108 extern DECLSPEC const char * SDLCALL SDL_WinRTGetLocalFolderPath();
   109 
   110 /* Gets the path to the roaming app data store.
   111    Files and directories that should roam to different devices can be
   112    created in this path.  Be sure to read Microsoft's documentation on
   113    roaming files for more information on how this works, as restrictions
   114    do apply.
   115 
   116    Please note that on Windows Phone 8, this function will return NULL,
   117    as Windows Phone 8 apps do not have an accessible roaming app data
   118    store.
   119  */
   120 extern DECLSPEC const char * SDLCALL SDL_WinRTGetRoamingFolderPath();
   121 
   122 /* Gets the path to the temporary app data store.
   123    Files and directories may be written here, however they may be deleted
   124    by Windows at a future date.
   125 
   126    Please note that on Windows Phone 8, this function will return NULL,
   127    as Windows Phone 8 apps do not have an accessible temporary app data
   128    store.
   129 */
   130 extern DECLSPEC const char * SDLCALL SDL_WinRTGetTemporaryFolderPath();
   131 
   132 #endif /* __WINRT__ */
   133 
   134 
   135 /* Ends C function definitions when using C++ */
   136 #ifdef __cplusplus
   137 /* *INDENT-OFF* */
   138 }
   139 /* *INDENT-ON* */
   140 #endif
   141 #include "close_code.h"
   142 
   143 #endif /* _SDL_system_h */
   144 
   145 /* vi: set ts=4 sw=4 expandtab: */