include/SDL_system.h
author Sam Lantinga <slouken@libsdl.org>
Tue, 06 Feb 2018 15:03:35 -0800
changeset 11844 8e2ca40e07f3
parent 11811 5d94cb6b24d3
child 11947 89b721a030c0
permissions -rw-r--r--
Added SDL_IsAndroidTV()
     1 /*
     2   Simple DirectMedia Layer
     3   Copyright (C) 1997-2018 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 (SDLCALL * SDL_WindowsMessageHook)(void *userdata, void *hWnd, unsigned int message, Uint64 wParam, Sint64 lParam);
    50 extern DECLSPEC void SDLCALL SDL_SetWindowsMessageHook(SDL_WindowsMessageHook callback, void *userdata);
    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(void);
   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(void);
   110 
   111 /**
   112    \brief Return true if the application is running on Android TV
   113  */
   114 extern DECLSPEC SDL_bool SDLCALL SDL_IsAndroidTV(void);
   115 
   116 /**
   117    See the official Android developer guide for more information:
   118    http://developer.android.com/guide/topics/data/data-storage.html
   119 */
   120 #define SDL_ANDROID_EXTERNAL_STORAGE_READ   0x01
   121 #define SDL_ANDROID_EXTERNAL_STORAGE_WRITE  0x02
   122 
   123 /**
   124    \brief Get the path used for internal storage for this application.
   125 
   126    This path is unique to your application and cannot be written to
   127    by other applications.
   128  */
   129 extern DECLSPEC const char * SDLCALL SDL_AndroidGetInternalStoragePath(void);
   130 
   131 /**
   132    \brief Get the current state of external storage, a bitmask of these values:
   133     SDL_ANDROID_EXTERNAL_STORAGE_READ
   134     SDL_ANDROID_EXTERNAL_STORAGE_WRITE
   135 
   136    If external storage is currently unavailable, this will return 0.
   137 */
   138 extern DECLSPEC int SDLCALL SDL_AndroidGetExternalStorageState(void);
   139 
   140 /**
   141    \brief Get the path used for external storage for this application.
   142 
   143    This path is unique to your application, but is public and can be
   144    written to by other applications.
   145  */
   146 extern DECLSPEC const char * SDLCALL SDL_AndroidGetExternalStoragePath(void);
   147 
   148 #endif /* __ANDROID__ */
   149 
   150 /* Platform specific functions for WinRT */
   151 #if defined(__WINRT__) && __WINRT__
   152 
   153 /**
   154  *  \brief WinRT / Windows Phone path types
   155  */
   156 typedef enum
   157 {
   158     /** \brief The installed app's root directory.
   159         Files here are likely to be read-only. */
   160     SDL_WINRT_PATH_INSTALLED_LOCATION,
   161 
   162     /** \brief The app's local data store.  Files may be written here */
   163     SDL_WINRT_PATH_LOCAL_FOLDER,
   164 
   165     /** \brief The app's roaming data store.  Unsupported on Windows Phone.
   166         Files written here may be copied to other machines via a network
   167         connection.
   168     */
   169     SDL_WINRT_PATH_ROAMING_FOLDER,
   170 
   171     /** \brief The app's temporary data store.  Unsupported on Windows Phone.
   172         Files written here may be deleted at any time. */
   173     SDL_WINRT_PATH_TEMP_FOLDER
   174 } SDL_WinRT_Path;
   175 
   176 
   177 /**
   178  *  \brief WinRT Device Family
   179  */
   180 typedef enum
   181 {
   182     /** \brief Unknown family  */
   183     SDL_WINRT_DEVICEFAMILY_UNKNOWN,
   184 
   185     /** \brief Desktop family*/
   186     SDL_WINRT_DEVICEFAMILY_DESKTOP,
   187 
   188     /** \brief Mobile family (for example smartphone) */
   189     SDL_WINRT_DEVICEFAMILY_MOBILE,
   190 
   191     /** \brief XBox family */
   192     SDL_WINRT_DEVICEFAMILY_XBOX,
   193 } SDL_WinRT_DeviceFamily;
   194 
   195 
   196 /**
   197  *  \brief Retrieves a WinRT defined path on the local file system
   198  *
   199  *  \note Documentation on most app-specific path types on WinRT
   200  *      can be found on MSDN, at the URL:
   201  *      http://msdn.microsoft.com/en-us/library/windows/apps/hh464917.aspx
   202  *
   203  *  \param pathType The type of path to retrieve.
   204  *  \return A UCS-2 string (16-bit, wide-char) containing the path, or NULL
   205  *      if the path is not available for any reason.  Not all paths are
   206  *      available on all versions of Windows.  This is especially true on
   207  *      Windows Phone.  Check the documentation for the given
   208  *      SDL_WinRT_Path for more information on which path types are
   209  *      supported where.
   210  */
   211 extern DECLSPEC const wchar_t * SDLCALL SDL_WinRTGetFSPathUNICODE(SDL_WinRT_Path pathType);
   212 
   213 /**
   214  *  \brief Retrieves a WinRT defined path on the local file system
   215  *
   216  *  \note Documentation on most app-specific path types on WinRT
   217  *      can be found on MSDN, at the URL:
   218  *      http://msdn.microsoft.com/en-us/library/windows/apps/hh464917.aspx
   219  *
   220  *  \param pathType The type of path to retrieve.
   221  *  \return A UTF-8 string (8-bit, multi-byte) containing the path, or NULL
   222  *      if the path is not available for any reason.  Not all paths are
   223  *      available on all versions of Windows.  This is especially true on
   224  *      Windows Phone.  Check the documentation for the given
   225  *      SDL_WinRT_Path for more information on which path types are
   226  *      supported where.
   227  */
   228 extern DECLSPEC const char * SDLCALL SDL_WinRTGetFSPathUTF8(SDL_WinRT_Path pathType);
   229 
   230 /**
   231  *  \brief Detects the device family of WinRT plattform on runtime
   232  *
   233  *  \return Device family
   234  */
   235 extern DECLSPEC SDL_WinRT_DeviceFamily SDLCALL SDL_WinRTGetDeviceFamily();
   236 
   237 #endif /* __WINRT__ */
   238 
   239 /* Ends C function definitions when using C++ */
   240 #ifdef __cplusplus
   241 }
   242 #endif
   243 #include "close_code.h"
   244 
   245 #endif /* SDL_system_h_ */
   246 
   247 /* vi: set ts=4 sw=4 expandtab: */