include/SDL_system.h
author David Ludwig <dludwig@pobox.com>
Mon, 12 Aug 2013 22:29:55 -0400
changeset 8477 ad08f0d710f3
parent 8453 499aa167ea79
parent 7264 23a5c8f4b312
child 8500 f25ef28d61e8
permissions -rw-r--r--
WinRT: merged with SDL 2.0.0 codebase (aka. SDL hg rev d6a8fa507a45)
     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 extern "C" {
    42 #endif
    43 
    44 /* Platform specific functions for iOS */
    45 #if defined(__IPHONEOS__) && __IPHONEOS__
    46 
    47 extern DECLSPEC int SDLCALL SDL_iPhoneSetAnimationCallback(SDL_Window * window, int interval, void (*callback)(void*), void *callbackParam);
    48 extern DECLSPEC void SDLCALL SDL_iPhoneSetEventPump(SDL_bool enabled);
    49 
    50 #endif /* __IPHONEOS__ */
    51 
    52 
    53 /* Platform specific functions for Android */
    54 #if defined(__ANDROID__) && __ANDROID__
    55 
    56 /* Get the JNI environment for the current thread
    57    This returns JNIEnv*, but the prototype is void* so we don't need jni.h
    58  */
    59 extern DECLSPEC void * SDLCALL SDL_AndroidGetJNIEnv();
    60 
    61 /* Get the SDL Activity object for the application
    62    This returns jobject, but the prototype is void* so we don't need jni.h
    63    The jobject returned by SDL_AndroidGetActivity is a local reference.
    64    It is the caller's responsibility to properly release it
    65    (using env->Push/PopLocalFrame or manually with env->DeleteLocalRef)
    66  */
    67 extern DECLSPEC void * SDLCALL SDL_AndroidGetActivity();
    68 
    69 /* See the official Android developer guide for more information:
    70    http://developer.android.com/guide/topics/data/data-storage.html
    71 */
    72 #define SDL_ANDROID_EXTERNAL_STORAGE_READ   0x01
    73 #define SDL_ANDROID_EXTERNAL_STORAGE_WRITE  0x02
    74 
    75 /* Get the path used for internal storage for this application.
    76    This path is unique to your application and cannot be written to
    77    by other applications.
    78  */
    79 extern DECLSPEC const char * SDLCALL SDL_AndroidGetInternalStoragePath();
    80 
    81 /* Get the current state of external storage, a bitmask of these values:
    82     SDL_ANDROID_EXTERNAL_STORAGE_READ
    83     SDL_ANDROID_EXTERNAL_STORAGE_WRITE
    84    If external storage is currently unavailable, this will return 0.
    85 */
    86 extern DECLSPEC int SDLCALL SDL_AndroidGetExternalStorageState();
    87 
    88 /* Get the path used for external storage for this application.
    89    This path is unique to your application, but is public and can be
    90    written to by other applications.
    91  */
    92 extern DECLSPEC const char * SDLCALL SDL_AndroidGetExternalStoragePath();
    93 
    94 #endif /* __ANDROID__ */
    95 
    96 
    97 /* Platform specific functions for Windows RT */
    98 #if defined(__WINRT__) && __WINRT__
    99 
   100 /**
   101  *  \brief Windows RT / Windows Phone path types
   102  */
   103 typedef enum
   104 {
   105     /** \brief The installed app's root directory.
   106         Files here are likely to be read-only. */
   107     SDL_WINRT_PATH_INSTALLED_LOCATION,
   108 
   109     /** \brief The app's local data store.  Files may be written here */
   110     SDL_WINRT_PATH_LOCAL_FOLDER,
   111 
   112     /** \brief The app's roaming data store.  Unsupported on Windows Phone.
   113         Files written here may be copied to other machines via a network
   114         connection.
   115     */
   116     SDL_WINRT_PATH_ROAMING_FOLDER,
   117 
   118     /** \brief The app's temporary data store.  Unsupported on Windows Phone.
   119         Files written here may be deleted at any time. */
   120     SDL_WINRT_PATH_TEMP_FOLDER
   121 } SDL_WinRT_Path;
   122 
   123 
   124 /**
   125  *  \brief Retrieves a Windows RT defined path on the local file system
   126  *
   127  *  \note Documentation on most app-specific path types on Windows RT
   128  *      can be found on MSDN, at the URL:
   129  *      http://msdn.microsoft.com/en-us/library/windows/apps/hh464917.aspx
   130  *
   131  *  \param pathType The type of path to retrieve.
   132  *  \ret A UCS-2 string (16-bit, wide-char) containing the path, or NULL
   133  *      if the path is not available for any reason.  Not all paths are
   134  *      available on all versions of Windows.  This is especially true on
   135  *      Windows Phone.  Check the documentation for the given
   136  *      SDL_WinRT_Path for more information on which path types are
   137  *      supported where.
   138  */
   139 extern DECLSPEC const wchar_t * SDLCALL SDL_WinRTGetFSPathUNICODE(SDL_WinRT_Path pathType);
   140 
   141 /**
   142  *  \brief Retrieves a Windows RT defined path on the local file system
   143  *
   144  *  \note Documentation on most app-specific path types on Windows RT
   145  *      can be found on MSDN, at the URL:
   146  *      http://msdn.microsoft.com/en-us/library/windows/apps/hh464917.aspx
   147  *
   148  *  \param pathType The type of path to retrieve.
   149  *  \ret A UTF-8 string (8-bit, multi-byte) containing the path, or NULL
   150  *      if the path is not available for any reason.  Not all paths are
   151  *      available on all versions of Windows.  This is especially true on
   152  *      Windows Phone.  Check the documentation for the given
   153  *      SDL_WinRT_Path for more information on which path types are
   154  *      supported where.
   155  */
   156 extern DECLSPEC const char * SDLCALL SDL_WinRTGetFSPathUTF8(SDL_WinRT_Path pathType);
   157 
   158 
   159 #endif /* __WINRT__ */
   160 
   161 
   162 /* Ends C function definitions when using C++ */
   163 #ifdef __cplusplus
   164 }
   165 #endif
   166 #include "close_code.h"
   167 
   168 #endif /* _SDL_system_h */
   169 
   170 /* vi: set ts=4 sw=4 expandtab: */