Home | History | Annotate | Download | only in include
      1 /*
      2   Simple DirectMedia Layer
      3   Copyright (C) 1997-2014 Sam Lantinga <slouken (at) 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 /* Returns the D3D9 adapter index that matches the specified display index.
     47    This adapter index can be passed to IDirect3D9::CreateDevice and controls
     48    on which monitor a full screen application will appear.
     49 */
     50 extern DECLSPEC int SDLCALL SDL_Direct3D9GetAdapterIndex( int displayIndex );
     51 
     52 /* Returns the D3D device associated with a renderer, or NULL if it's not a D3D renderer.
     53    Once you are done using the device, you should release it to avoid a resource leak.
     54  */
     55 typedef struct IDirect3DDevice9 IDirect3DDevice9;
     56 extern DECLSPEC IDirect3DDevice9* SDLCALL SDL_RenderGetD3D9Device(SDL_Renderer * renderer);
     57 
     58 /* Returns the DXGI Adapter and Output indices for the specified display index.
     59    These can be passed to EnumAdapters and EnumOutputs respectively to get the objects
     60    required to create a DX10 or DX11 device and swap chain.
     61  */
     62 extern DECLSPEC void SDLCALL SDL_DXGIGetOutputInfo( int displayIndex, int *adapterIndex, int *outputIndex );
     63 
     64 #endif /* __WIN32__ */
     65 
     66 
     67 /* Platform specific functions for iOS */
     68 #if defined(__IPHONEOS__) && __IPHONEOS__
     69 
     70 extern DECLSPEC int SDLCALL SDL_iPhoneSetAnimationCallback(SDL_Window * window, int interval, void (*callback)(void*), void *callbackParam);
     71 extern DECLSPEC void SDLCALL SDL_iPhoneSetEventPump(SDL_bool enabled);
     72 
     73 #endif /* __IPHONEOS__ */
     74 
     75 
     76 /* Platform specific functions for Android */
     77 #if defined(__ANDROID__) && __ANDROID__
     78 
     79 /* Get the JNI environment for the current thread
     80    This returns JNIEnv*, but the prototype is void* so we don't need jni.h
     81  */
     82 extern DECLSPEC void * SDLCALL SDL_AndroidGetJNIEnv();
     83 
     84 /* Get the SDL Activity object for the application
     85    This returns jobject, but the prototype is void* so we don't need jni.h
     86    The jobject returned by SDL_AndroidGetActivity is a local reference.
     87    It is the caller's responsibility to properly release it
     88    (using env->Push/PopLocalFrame or manually with env->DeleteLocalRef)
     89  */
     90 extern DECLSPEC void * SDLCALL SDL_AndroidGetActivity();
     91 
     92 /* See the official Android developer guide for more information:
     93    http://developer.android.com/guide/topics/data/data-storage.html
     94 */
     95 #define SDL_ANDROID_EXTERNAL_STORAGE_READ   0x01
     96 #define SDL_ANDROID_EXTERNAL_STORAGE_WRITE  0x02
     97 
     98 /* Get the path used for internal storage for this application.
     99    This path is unique to your application and cannot be written to
    100    by other applications.
    101  */
    102 extern DECLSPEC const char * SDLCALL SDL_AndroidGetInternalStoragePath();
    103 
    104 /* Get the current state of external storage, a bitmask of these values:
    105     SDL_ANDROID_EXTERNAL_STORAGE_READ
    106     SDL_ANDROID_EXTERNAL_STORAGE_WRITE
    107    If external storage is currently unavailable, this will return 0.
    108 */
    109 extern DECLSPEC int SDLCALL SDL_AndroidGetExternalStorageState();
    110 
    111 /* Get the path used for external storage for this application.
    112    This path is unique to your application, but is public and can be
    113    written to by other applications.
    114  */
    115 extern DECLSPEC const char * SDLCALL SDL_AndroidGetExternalStoragePath();
    116 
    117 #endif /* __ANDROID__ */
    118 
    119 /* Ends C function definitions when using C++ */
    120 #ifdef __cplusplus
    121 }
    122 #endif
    123 #include "close_code.h"
    124 
    125 #endif /* _SDL_system_h */
    126 
    127 /* vi: set ts=4 sw=4 expandtab: */
    128