include/SDL_system.h
author David Ludwig <dludwig@pobox.com>
Mon, 01 Apr 2013 21:33:06 -0400
changeset 8453 499aa167ea79
parent 8439 14d94a8a9fb6
child 8477 ad08f0d710f3
permissions -rw-r--r--
WinRT: made WinRT path retrieval be available in both UCS-2 and UTF-8 flavors
     1 /*
     2   Simple DirectMedia Layer
     3   Copyright (C) 1997-2013 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 /**
   100  *  \brief Windows RT / Windows Phone path types
   101  */
   102 typedef enum
   103 {
   104     /** \brief The installed app's root directory.
   105         Files here are likely to be read-only. */
   106     SDL_WINRT_PATH_INSTALLED_LOCATION,
   107 
   108     /** \brief The app's local data store.  Files may be written here */
   109     SDL_WINRT_PATH_LOCAL_FOLDER,
   110 
   111     /** \brief The app's roaming data store.  Unsupported on Windows Phone.
   112         Files written here may be copied to other machines via a network
   113         connection.
   114     */
   115     SDL_WINRT_PATH_ROAMING_FOLDER,
   116 
   117     /** \brief The app's temporary data store.  Unsupported on Windows Phone.
   118         Files written here may be deleted at any time. */
   119     SDL_WINRT_PATH_TEMP_FOLDER
   120 } SDL_WinRT_Path;
   121 
   122 
   123 /**
   124  *  \brief Retrieves a Windows RT defined path on the local file system
   125  *
   126  *  \note Documentation on most app-specific path types on Windows RT
   127  *      can be found on MSDN, at the URL:
   128  *      http://msdn.microsoft.com/en-us/library/windows/apps/hh464917.aspx
   129  *
   130  *  \param pathType The type of path to retrieve.
   131  *  \ret A UCS-2 string (16-bit, wide-char) containing the path, or NULL
   132  *      if the path is not available for any reason.  Not all paths are
   133  *      available on all versions of Windows.  This is especially true on
   134  *      Windows Phone.  Check the documentation for the given
   135  *      SDL_WinRT_Path for more information on which path types are
   136  *      supported where.
   137  */
   138 extern DECLSPEC const wchar_t * SDLCALL SDL_WinRTGetFSPathUNICODE(SDL_WinRT_Path pathType);
   139 
   140 /**
   141  *  \brief Retrieves a Windows RT defined path on the local file system
   142  *
   143  *  \note Documentation on most app-specific path types on Windows RT
   144  *      can be found on MSDN, at the URL:
   145  *      http://msdn.microsoft.com/en-us/library/windows/apps/hh464917.aspx
   146  *
   147  *  \param pathType The type of path to retrieve.
   148  *  \ret A UTF-8 string (8-bit, multi-byte) containing the path, or NULL
   149  *      if the path is not available for any reason.  Not all paths are
   150  *      available on all versions of Windows.  This is especially true on
   151  *      Windows Phone.  Check the documentation for the given
   152  *      SDL_WinRT_Path for more information on which path types are
   153  *      supported where.
   154  */
   155 extern DECLSPEC const char * SDLCALL SDL_WinRTGetFSPathUTF8(SDL_WinRT_Path pathType);
   156 
   157 
   158 #endif /* __WINRT__ */
   159 
   160 
   161 /* Ends C function definitions when using C++ */
   162 #ifdef __cplusplus
   163 /* *INDENT-OFF* */
   164 }
   165 /* *INDENT-ON* */
   166 #endif
   167 #include "close_code.h"
   168 
   169 #endif /* _SDL_system_h */
   170 
   171 /* vi: set ts=4 sw=4 expandtab: */