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