include/SDL_system.h
author Sam Lantinga <slouken@libsdl.org>
Tue, 05 Jun 2018 12:46:13 -0700
changeset 12008 91f9b8f22b17
parent 11947 89b721a030c0
child 12024 3688283680b1
permissions -rw-r--r--
Added SDL_IsChromebook() to determine if we're running on a Chromebook.
     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 Linux */
    80 #ifdef __LINUX__
    81 
    82 /**
    83    \brief Sets the UNIX nice value for a thread, using setpriority() if possible, and RealtimeKit if available.
    84 
    85    \return 0 on success, or -1 on error.
    86  */
    87 extern DECLSPEC int SDLCALL SDL_LinuxSetThreadPriority(Sint64 threadID, int priority);
    88  
    89 #endif /* __LINUX__ */
    90 	
    91 /* Platform specific functions for iOS */
    92 #if defined(__IPHONEOS__) && __IPHONEOS__
    93 
    94 #define SDL_iOSSetAnimationCallback(window, interval, callback, callbackParam) SDL_iPhoneSetAnimationCallback(window, interval, callback, callbackParam)
    95 extern DECLSPEC int SDLCALL SDL_iPhoneSetAnimationCallback(SDL_Window * window, int interval, void (*callback)(void*), void *callbackParam);
    96 
    97 #define SDL_iOSSetEventPump(enabled) SDL_iPhoneSetEventPump(enabled)
    98 extern DECLSPEC void SDLCALL SDL_iPhoneSetEventPump(SDL_bool enabled);
    99 
   100 #endif /* __IPHONEOS__ */
   101 
   102 
   103 /* Platform specific functions for Android */
   104 #if defined(__ANDROID__) && __ANDROID__
   105 
   106 /**
   107    \brief Get the JNI environment for the current thread
   108 
   109    This returns JNIEnv*, but the prototype is void* so we don't need jni.h
   110  */
   111 extern DECLSPEC void * SDLCALL SDL_AndroidGetJNIEnv(void);
   112 
   113 /**
   114    \brief Get the SDL Activity object for the application
   115 
   116    This returns jobject, but the prototype is void* so we don't need jni.h
   117    The jobject returned by SDL_AndroidGetActivity is a local reference.
   118    It is the caller's responsibility to properly release it
   119    (using env->Push/PopLocalFrame or manually with env->DeleteLocalRef)
   120  */
   121 extern DECLSPEC void * SDLCALL SDL_AndroidGetActivity(void);
   122 
   123 /**
   124    \brief Return true if the application is running on Android TV
   125  */
   126 extern DECLSPEC SDL_bool SDLCALL SDL_IsAndroidTV(void);
   127 
   128 /**
   129    \brief Return true if the application is running on a Chromebook
   130  */
   131 extern DECLSPEC SDL_bool SDLCALL SDL_IsChromebook(void);
   132 
   133 /**
   134    See the official Android developer guide for more information:
   135    http://developer.android.com/guide/topics/data/data-storage.html
   136 */
   137 #define SDL_ANDROID_EXTERNAL_STORAGE_READ   0x01
   138 #define SDL_ANDROID_EXTERNAL_STORAGE_WRITE  0x02
   139 
   140 /**
   141    \brief Get the path used for internal storage for this application.
   142 
   143    This path is unique to your application and cannot be written to
   144    by other applications.
   145  */
   146 extern DECLSPEC const char * SDLCALL SDL_AndroidGetInternalStoragePath(void);
   147 
   148 /**
   149    \brief Get the current state of external storage, a bitmask of these values:
   150     SDL_ANDROID_EXTERNAL_STORAGE_READ
   151     SDL_ANDROID_EXTERNAL_STORAGE_WRITE
   152 
   153    If external storage is currently unavailable, this will return 0.
   154 */
   155 extern DECLSPEC int SDLCALL SDL_AndroidGetExternalStorageState(void);
   156 
   157 /**
   158    \brief Get the path used for external storage for this application.
   159 
   160    This path is unique to your application, but is public and can be
   161    written to by other applications.
   162  */
   163 extern DECLSPEC const char * SDLCALL SDL_AndroidGetExternalStoragePath(void);
   164 
   165 #endif /* __ANDROID__ */
   166 
   167 /* Platform specific functions for WinRT */
   168 #if defined(__WINRT__) && __WINRT__
   169 
   170 /**
   171  *  \brief WinRT / Windows Phone path types
   172  */
   173 typedef enum
   174 {
   175     /** \brief The installed app's root directory.
   176         Files here are likely to be read-only. */
   177     SDL_WINRT_PATH_INSTALLED_LOCATION,
   178 
   179     /** \brief The app's local data store.  Files may be written here */
   180     SDL_WINRT_PATH_LOCAL_FOLDER,
   181 
   182     /** \brief The app's roaming data store.  Unsupported on Windows Phone.
   183         Files written here may be copied to other machines via a network
   184         connection.
   185     */
   186     SDL_WINRT_PATH_ROAMING_FOLDER,
   187 
   188     /** \brief The app's temporary data store.  Unsupported on Windows Phone.
   189         Files written here may be deleted at any time. */
   190     SDL_WINRT_PATH_TEMP_FOLDER
   191 } SDL_WinRT_Path;
   192 
   193 
   194 /**
   195  *  \brief WinRT Device Family
   196  */
   197 typedef enum
   198 {
   199     /** \brief Unknown family  */
   200     SDL_WINRT_DEVICEFAMILY_UNKNOWN,
   201 
   202     /** \brief Desktop family*/
   203     SDL_WINRT_DEVICEFAMILY_DESKTOP,
   204 
   205     /** \brief Mobile family (for example smartphone) */
   206     SDL_WINRT_DEVICEFAMILY_MOBILE,
   207 
   208     /** \brief XBox family */
   209     SDL_WINRT_DEVICEFAMILY_XBOX,
   210 } SDL_WinRT_DeviceFamily;
   211 
   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 UCS-2 string (16-bit, wide-char) 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 wchar_t * SDLCALL SDL_WinRTGetFSPathUNICODE(SDL_WinRT_Path pathType);
   229 
   230 /**
   231  *  \brief Retrieves a WinRT defined path on the local file system
   232  *
   233  *  \note Documentation on most app-specific path types on WinRT
   234  *      can be found on MSDN, at the URL:
   235  *      http://msdn.microsoft.com/en-us/library/windows/apps/hh464917.aspx
   236  *
   237  *  \param pathType The type of path to retrieve.
   238  *  \return A UTF-8 string (8-bit, multi-byte) containing the path, or NULL
   239  *      if the path is not available for any reason.  Not all paths are
   240  *      available on all versions of Windows.  This is especially true on
   241  *      Windows Phone.  Check the documentation for the given
   242  *      SDL_WinRT_Path for more information on which path types are
   243  *      supported where.
   244  */
   245 extern DECLSPEC const char * SDLCALL SDL_WinRTGetFSPathUTF8(SDL_WinRT_Path pathType);
   246 
   247 /**
   248  *  \brief Detects the device family of WinRT plattform on runtime
   249  *
   250  *  \return Device family
   251  */
   252 extern DECLSPEC SDL_WinRT_DeviceFamily SDLCALL SDL_WinRTGetDeviceFamily();
   253 
   254 #endif /* __WINRT__ */
   255 
   256 /* Ends C function definitions when using C++ */
   257 #ifdef __cplusplus
   258 }
   259 #endif
   260 #include "close_code.h"
   261 
   262 #endif /* SDL_system_h_ */
   263 
   264 /* vi: set ts=4 sw=4 expandtab: */