include/SDL_system.h
author Sam Lantinga <slouken@libsdl.org>
Wed, 13 May 2015 22:39:20 -0700
changeset 9597 345bc53b52b8
parent 9540 32ddc92d78cf
child 9599 223fbcc6a327
permissions -rw-r--r--
Added SDL_SetWindowsMessageHook() to facilitate full IME support on Windows
     1 /*
     2   Simple DirectMedia Layer
     3   Copyright (C) 1997-2014 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 #include "SDL_keyboard.h"
    33 #include "SDL_render.h"
    34 #include "SDL_video.h"
    35 
    36 #include "begin_code.h"
    37 /* Set up for C function definitions, even when using C++ */
    38 #ifdef __cplusplus
    39 extern "C" {
    40 #endif
    41 
    42 
    43 /* Platform specific functions for Windows */
    44 #ifdef __WIN32__
    45 	
    46 /**
    47    \brief Set a function that is called for every windows message, before TranslateMessage()
    48 */
    49 typedef void (*SDL_WindowsMessageHook)(void *hWnd, unsigned int message, Uint64 wParam, Sint64 lParam);
    50 extern DECLSPEC void SDLCALL SDL_SetWindowsMessageHook(SDL_WindowsMessageHook callback);
    51 
    52 /**
    53    \brief Returns the D3D9 adapter index that matches the specified display index.
    54 
    55    This adapter index can be passed to IDirect3D9::CreateDevice and controls
    56    on which monitor a full screen application will appear.
    57 */
    58 extern DECLSPEC int SDLCALL SDL_Direct3D9GetAdapterIndex( int displayIndex );
    59 
    60 typedef struct IDirect3DDevice9 IDirect3DDevice9;
    61 /**
    62    \brief Returns the D3D device associated with a renderer, or NULL if it's not a D3D renderer.
    63 
    64    Once you are done using the device, you should release it to avoid a resource leak.
    65  */
    66 extern DECLSPEC IDirect3DDevice9* SDLCALL SDL_RenderGetD3D9Device(SDL_Renderer * renderer);
    67 
    68 /**
    69    \brief Returns the DXGI Adapter and Output indices for the specified display index.
    70 
    71    These can be passed to EnumAdapters and EnumOutputs respectively to get the objects
    72    required to create a DX10 or DX11 device and swap chain.
    73  */
    74 extern DECLSPEC SDL_bool SDLCALL SDL_DXGIGetOutputInfo( int displayIndex, int *adapterIndex, int *outputIndex );
    75 
    76 #endif /* __WIN32__ */
    77 
    78 
    79 /* Platform specific functions for iOS */
    80 #if defined(__IPHONEOS__) && __IPHONEOS__
    81 
    82 #define SDL_iOSSetAnimationCallback(window, interval, callback, callbackParam) SDL_iPhoneSetAnimationCallback(window, interval, callback, callbackParam)
    83 extern DECLSPEC int SDLCALL SDL_iPhoneSetAnimationCallback(SDL_Window * window, int interval, void (*callback)(void*), void *callbackParam);
    84 
    85 #define SDL_iOSSetEventPump(enabled) SDL_iPhoneSetEventPump(enabled)
    86 extern DECLSPEC void SDLCALL SDL_iPhoneSetEventPump(SDL_bool enabled);
    87 
    88 #endif /* __IPHONEOS__ */
    89 
    90 
    91 /* Platform specific functions for Android */
    92 #if defined(__ANDROID__) && __ANDROID__
    93 
    94 /**
    95    \brief Get the JNI environment for the current thread
    96 
    97    This returns JNIEnv*, but the prototype is void* so we don't need jni.h
    98  */
    99 extern DECLSPEC void * SDLCALL SDL_AndroidGetJNIEnv();
   100 
   101 /**
   102    \brief Get the SDL Activity object for the application
   103 
   104    This returns jobject, but the prototype is void* so we don't need jni.h
   105    The jobject returned by SDL_AndroidGetActivity is a local reference.
   106    It is the caller's responsibility to properly release it
   107    (using env->Push/PopLocalFrame or manually with env->DeleteLocalRef)
   108  */
   109 extern DECLSPEC void * SDLCALL SDL_AndroidGetActivity();
   110 
   111 /**
   112    See the official Android developer guide for more information:
   113    http://developer.android.com/guide/topics/data/data-storage.html
   114 */
   115 #define SDL_ANDROID_EXTERNAL_STORAGE_READ   0x01
   116 #define SDL_ANDROID_EXTERNAL_STORAGE_WRITE  0x02
   117 
   118 /**
   119    \brief Get the path used for internal storage for this application.
   120 
   121    This path is unique to your application and cannot be written to
   122    by other applications.
   123  */
   124 extern DECLSPEC const char * SDLCALL SDL_AndroidGetInternalStoragePath();
   125 
   126 /**
   127    \brief Get the current state of external storage, a bitmask of these values:
   128     SDL_ANDROID_EXTERNAL_STORAGE_READ
   129     SDL_ANDROID_EXTERNAL_STORAGE_WRITE
   130 
   131    If external storage is currently unavailable, this will return 0.
   132 */
   133 extern DECLSPEC int SDLCALL SDL_AndroidGetExternalStorageState();
   134 
   135 /**
   136    \brief Get the path used for external storage for this application.
   137 
   138    This path is unique to your application, but is public and can be
   139    written to by other applications.
   140  */
   141 extern DECLSPEC const char * SDLCALL SDL_AndroidGetExternalStoragePath();
   142 
   143 #endif /* __ANDROID__ */
   144 
   145 /* Platform specific functions for WinRT */
   146 #if defined(__WINRT__) && __WINRT__
   147 
   148 /**
   149  *  \brief WinRT / Windows Phone path types
   150  */
   151 typedef enum
   152 {
   153     /** \brief The installed app's root directory.
   154         Files here are likely to be read-only. */
   155     SDL_WINRT_PATH_INSTALLED_LOCATION,
   156 
   157     /** \brief The app's local data store.  Files may be written here */
   158     SDL_WINRT_PATH_LOCAL_FOLDER,
   159 
   160     /** \brief The app's roaming data store.  Unsupported on Windows Phone.
   161         Files written here may be copied to other machines via a network
   162         connection.
   163     */
   164     SDL_WINRT_PATH_ROAMING_FOLDER,
   165 
   166     /** \brief The app's temporary data store.  Unsupported on Windows Phone.
   167         Files written here may be deleted at any time. */
   168     SDL_WINRT_PATH_TEMP_FOLDER
   169 } SDL_WinRT_Path;
   170 
   171 
   172 /**
   173  *  \brief Retrieves a WinRT defined path on the local file system
   174  *
   175  *  \note Documentation on most app-specific path types on WinRT
   176  *      can be found on MSDN, at the URL:
   177  *      http://msdn.microsoft.com/en-us/library/windows/apps/hh464917.aspx
   178  *
   179  *  \param pathType The type of path to retrieve.
   180  *  \return A UCS-2 string (16-bit, wide-char) containing the path, or NULL
   181  *      if the path is not available for any reason.  Not all paths are
   182  *      available on all versions of Windows.  This is especially true on
   183  *      Windows Phone.  Check the documentation for the given
   184  *      SDL_WinRT_Path for more information on which path types are
   185  *      supported where.
   186  */
   187 extern DECLSPEC const wchar_t * SDLCALL SDL_WinRTGetFSPathUNICODE(SDL_WinRT_Path pathType);
   188 
   189 /**
   190  *  \brief Retrieves a WinRT defined path on the local file system
   191  *
   192  *  \note Documentation on most app-specific path types on WinRT
   193  *      can be found on MSDN, at the URL:
   194  *      http://msdn.microsoft.com/en-us/library/windows/apps/hh464917.aspx
   195  *
   196  *  \param pathType The type of path to retrieve.
   197  *  \return A UTF-8 string (8-bit, multi-byte) containing the path, or NULL
   198  *      if the path is not available for any reason.  Not all paths are
   199  *      available on all versions of Windows.  This is especially true on
   200  *      Windows Phone.  Check the documentation for the given
   201  *      SDL_WinRT_Path for more information on which path types are
   202  *      supported where.
   203  */
   204 extern DECLSPEC const char * SDLCALL SDL_WinRTGetFSPathUTF8(SDL_WinRT_Path pathType);
   205 
   206 #endif /* __WINRT__ */
   207 
   208 /* Ends C function definitions when using C++ */
   209 #ifdef __cplusplus
   210 }
   211 #endif
   212 #include "close_code.h"
   213 
   214 #endif /* _SDL_system_h */
   215 
   216 /* vi: set ts=4 sw=4 expandtab: */