include/SDL_system.h
author Ryan C. Gordon <icculus@icculus.org>
Fri, 20 Mar 2015 21:57:15 -0400
changeset 9414 669bf9fb901e
parent 9309 221b071c37d6
child 9533 e5693e855338
permissions -rw-r--r--
Several corrections to the CMake project files (thanks, Ozkan!).

Fixes Bugzilla #2732.
slouken@8582
     1
/*
slouken@8582
     2
  Simple DirectMedia Layer
slouken@8149
     3
  Copyright (C) 1997-2014 Sam Lantinga <slouken@libsdl.org>
slouken@8582
     4
slouken@8582
     5
  This software is provided 'as-is', without any express or implied
slouken@8582
     6
  warranty.  In no event will the authors be held liable for any damages
slouken@8582
     7
  arising from the use of this software.
slouken@8582
     8
slouken@8582
     9
  Permission is granted to anyone to use this software for any purpose,
slouken@8582
    10
  including commercial applications, and to alter it and redistribute it
slouken@8582
    11
  freely, subject to the following restrictions:
slouken@8582
    12
slouken@8582
    13
  1. The origin of this software must not be misrepresented; you must not
slouken@8582
    14
     claim that you wrote the original software. If you use this software
slouken@8582
    15
     in a product, an acknowledgment in the product documentation would be
slouken@8582
    16
     appreciated but is not required.
slouken@8582
    17
  2. Altered source versions must be plainly marked as such, and must not be
slouken@8582
    18
     misrepresented as being the original software.
slouken@8582
    19
  3. This notice may not be removed or altered from any source distribution.
slouken@8582
    20
*/
slouken@8582
    21
slouken@8582
    22
/**
slouken@8582
    23
 *  \file SDL_system.h
slouken@8582
    24
 *
slouken@8582
    25
 *  Include file for platform specific SDL API functions
slouken@8582
    26
 */
slouken@8582
    27
slouken@8582
    28
#ifndef _SDL_system_h
slouken@8582
    29
#define _SDL_system_h
slouken@8582
    30
slouken@8582
    31
#include "SDL_stdinc.h"
slouken@8582
    32
#include "SDL_keyboard.h"
slouken@8582
    33
#include "SDL_render.h"
slouken@8582
    34
#include "SDL_video.h"
slouken@8582
    35
slouken@8582
    36
#include "begin_code.h"
slouken@8582
    37
/* Set up for C function definitions, even when using C++ */
slouken@8582
    38
#ifdef __cplusplus
slouken@8582
    39
extern "C" {
slouken@8582
    40
#endif
slouken@8582
    41
slouken@8582
    42
slouken@8582
    43
/* Platform specific functions for Windows */
slouken@8582
    44
#ifdef __WIN32__
slouken@8582
    45
philipp@9309
    46
/**
philipp@9309
    47
   \brief Returns the D3D9 adapter index that matches the specified display index.
philipp@9309
    48
slouken@8582
    49
   This adapter index can be passed to IDirect3D9::CreateDevice and controls
slouken@8582
    50
   on which monitor a full screen application will appear.
slouken@8582
    51
*/
slouken@8582
    52
extern DECLSPEC int SDLCALL SDL_Direct3D9GetAdapterIndex( int displayIndex );
slouken@8582
    53
philipp@9309
    54
typedef struct IDirect3DDevice9 IDirect3DDevice9;
philipp@9309
    55
/**
philipp@9309
    56
   \brief Returns the D3D device associated with a renderer, or NULL if it's not a D3D renderer.
philipp@9309
    57
slouken@8582
    58
   Once you are done using the device, you should release it to avoid a resource leak.
slouken@8582
    59
 */
slouken@8582
    60
extern DECLSPEC IDirect3DDevice9* SDLCALL SDL_RenderGetD3D9Device(SDL_Renderer * renderer);
slouken@8582
    61
philipp@9309
    62
/**
philipp@9309
    63
   \brief Returns the DXGI Adapter and Output indices for the specified display index.
philipp@9309
    64
slouken@8213
    65
   These can be passed to EnumAdapters and EnumOutputs respectively to get the objects
slouken@8213
    66
   required to create a DX10 or DX11 device and swap chain.
slouken@8213
    67
 */
slouken@8719
    68
extern DECLSPEC SDL_bool SDLCALL SDL_DXGIGetOutputInfo( int displayIndex, int *adapterIndex, int *outputIndex );
slouken@8213
    69
slouken@8582
    70
#endif /* __WIN32__ */
slouken@8582
    71
slouken@8582
    72
slouken@8582
    73
/* Platform specific functions for iOS */
slouken@8582
    74
#if defined(__IPHONEOS__) && __IPHONEOS__
slouken@8582
    75
slouken@8582
    76
extern DECLSPEC int SDLCALL SDL_iPhoneSetAnimationCallback(SDL_Window * window, int interval, void (*callback)(void*), void *callbackParam);
slouken@8582
    77
extern DECLSPEC void SDLCALL SDL_iPhoneSetEventPump(SDL_bool enabled);
slouken@8582
    78
slouken@8582
    79
#endif /* __IPHONEOS__ */
slouken@8582
    80
slouken@8582
    81
slouken@8582
    82
/* Platform specific functions for Android */
slouken@8582
    83
#if defined(__ANDROID__) && __ANDROID__
slouken@8582
    84
philipp@9309
    85
/**
philipp@9309
    86
   \brief Get the JNI environment for the current thread
philipp@9309
    87
slouken@8582
    88
   This returns JNIEnv*, but the prototype is void* so we don't need jni.h
slouken@8582
    89
 */
slouken@8582
    90
extern DECLSPEC void * SDLCALL SDL_AndroidGetJNIEnv();
slouken@8582
    91
philipp@9309
    92
/**
philipp@9309
    93
   \brief Get the SDL Activity object for the application
philipp@9309
    94
slouken@8582
    95
   This returns jobject, but the prototype is void* so we don't need jni.h
slouken@8582
    96
   The jobject returned by SDL_AndroidGetActivity is a local reference.
slouken@8582
    97
   It is the caller's responsibility to properly release it
slouken@8582
    98
   (using env->Push/PopLocalFrame or manually with env->DeleteLocalRef)
slouken@8582
    99
 */
slouken@8582
   100
extern DECLSPEC void * SDLCALL SDL_AndroidGetActivity();
slouken@8582
   101
philipp@9309
   102
/**
philipp@9309
   103
   See the official Android developer guide for more information:
slouken@8582
   104
   http://developer.android.com/guide/topics/data/data-storage.html
slouken@8582
   105
*/
slouken@8582
   106
#define SDL_ANDROID_EXTERNAL_STORAGE_READ   0x01
slouken@8582
   107
#define SDL_ANDROID_EXTERNAL_STORAGE_WRITE  0x02
slouken@8582
   108
philipp@9309
   109
/**
philipp@9309
   110
   \brief Get the path used for internal storage for this application.
philipp@9309
   111
slouken@8582
   112
   This path is unique to your application and cannot be written to
slouken@8582
   113
   by other applications.
slouken@8582
   114
 */
slouken@8582
   115
extern DECLSPEC const char * SDLCALL SDL_AndroidGetInternalStoragePath();
slouken@8582
   116
philipp@9309
   117
/**
philipp@9309
   118
   \brief Get the current state of external storage, a bitmask of these values:
slouken@8582
   119
    SDL_ANDROID_EXTERNAL_STORAGE_READ
slouken@8582
   120
    SDL_ANDROID_EXTERNAL_STORAGE_WRITE
philipp@9309
   121
slouken@8582
   122
   If external storage is currently unavailable, this will return 0.
slouken@8582
   123
*/
slouken@8582
   124
extern DECLSPEC int SDLCALL SDL_AndroidGetExternalStorageState();
slouken@8582
   125
philipp@9309
   126
/**
philipp@9309
   127
   \brief Get the path used for external storage for this application.
philipp@9309
   128
slouken@8582
   129
   This path is unique to your application, but is public and can be
slouken@8582
   130
   written to by other applications.
slouken@8582
   131
 */
slouken@8582
   132
extern DECLSPEC const char * SDLCALL SDL_AndroidGetExternalStoragePath();
slouken@8582
   133
slouken@8582
   134
#endif /* __ANDROID__ */
slouken@8582
   135
slouken@8582
   136
/* Platform specific functions for WinRT */
slouken@8582
   137
#if defined(__WINRT__) && __WINRT__
slouken@8582
   138
slouken@8582
   139
/**
slouken@8582
   140
 *  \brief WinRT / Windows Phone path types
slouken@8582
   141
 */
slouken@8582
   142
typedef enum
slouken@8582
   143
{
slouken@8582
   144
    /** \brief The installed app's root directory.
slouken@8582
   145
        Files here are likely to be read-only. */
slouken@8582
   146
    SDL_WINRT_PATH_INSTALLED_LOCATION,
slouken@8582
   147
slouken@8582
   148
    /** \brief The app's local data store.  Files may be written here */
slouken@8582
   149
    SDL_WINRT_PATH_LOCAL_FOLDER,
slouken@8582
   150
slouken@8582
   151
    /** \brief The app's roaming data store.  Unsupported on Windows Phone.
slouken@8582
   152
        Files written here may be copied to other machines via a network
slouken@8582
   153
        connection.
slouken@8582
   154
    */
slouken@8582
   155
    SDL_WINRT_PATH_ROAMING_FOLDER,
slouken@8582
   156
slouken@8582
   157
    /** \brief The app's temporary data store.  Unsupported on Windows Phone.
slouken@8582
   158
        Files written here may be deleted at any time. */
slouken@8582
   159
    SDL_WINRT_PATH_TEMP_FOLDER
slouken@8582
   160
} SDL_WinRT_Path;
slouken@8582
   161
slouken@8582
   162
slouken@8582
   163
/**
slouken@8582
   164
 *  \brief Retrieves a WinRT defined path on the local file system
slouken@8582
   165
 *
slouken@8582
   166
 *  \note Documentation on most app-specific path types on WinRT
slouken@8582
   167
 *      can be found on MSDN, at the URL:
slouken@8582
   168
 *      http://msdn.microsoft.com/en-us/library/windows/apps/hh464917.aspx
slouken@8582
   169
 *
slouken@8582
   170
 *  \param pathType The type of path to retrieve.
philipp@9309
   171
 *  \return A UCS-2 string (16-bit, wide-char) containing the path, or NULL
slouken@8582
   172
 *      if the path is not available for any reason.  Not all paths are
slouken@8582
   173
 *      available on all versions of Windows.  This is especially true on
slouken@8582
   174
 *      Windows Phone.  Check the documentation for the given
slouken@8582
   175
 *      SDL_WinRT_Path for more information on which path types are
slouken@8582
   176
 *      supported where.
slouken@8582
   177
 */
slouken@8582
   178
extern DECLSPEC const wchar_t * SDLCALL SDL_WinRTGetFSPathUNICODE(SDL_WinRT_Path pathType);
slouken@8582
   179
slouken@8582
   180
/**
slouken@8582
   181
 *  \brief Retrieves a WinRT defined path on the local file system
slouken@8582
   182
 *
slouken@8582
   183
 *  \note Documentation on most app-specific path types on WinRT
slouken@8582
   184
 *      can be found on MSDN, at the URL:
slouken@8582
   185
 *      http://msdn.microsoft.com/en-us/library/windows/apps/hh464917.aspx
slouken@8582
   186
 *
slouken@8582
   187
 *  \param pathType The type of path to retrieve.
philipp@9309
   188
 *  \return A UTF-8 string (8-bit, multi-byte) containing the path, or NULL
slouken@8582
   189
 *      if the path is not available for any reason.  Not all paths are
slouken@8582
   190
 *      available on all versions of Windows.  This is especially true on
slouken@8582
   191
 *      Windows Phone.  Check the documentation for the given
slouken@8582
   192
 *      SDL_WinRT_Path for more information on which path types are
slouken@8582
   193
 *      supported where.
slouken@8582
   194
 */
slouken@8582
   195
extern DECLSPEC const char * SDLCALL SDL_WinRTGetFSPathUTF8(SDL_WinRT_Path pathType);
slouken@8582
   196
slouken@8582
   197
#endif /* __WINRT__ */
slouken@8582
   198
slouken@8582
   199
/* Ends C function definitions when using C++ */
slouken@8582
   200
#ifdef __cplusplus
slouken@8582
   201
}
slouken@8582
   202
#endif
slouken@8582
   203
#include "close_code.h"
slouken@8582
   204
slouken@8582
   205
#endif /* _SDL_system_h */
slouken@8582
   206
slouken@8582
   207
/* vi: set ts=4 sw=4 expandtab: */