include/SDL_system.h
author Sam Lantinga <slouken@libsdl.org>
Thu, 13 Feb 2014 11:05:30 -0800
changeset 8213 c08568651ebb
parent 8149 681eb46b8ac4
child 8583 fb2933ca805f
permissions -rw-r--r--
Added SDL_DXGIGetOutputInfo which returns the adapter and output indices that are used to create DX10 and DX11 devices and swap chains on a particular display.

CR: SamL
slouken@6342
     1
/*
slouken@6342
     2
  Simple DirectMedia Layer
slouken@8149
     3
  Copyright (C) 1997-2014 Sam Lantinga <slouken@libsdl.org>
slouken@6342
     4
slouken@6342
     5
  This software is provided 'as-is', without any express or implied
slouken@6342
     6
  warranty.  In no event will the authors be held liable for any damages
slouken@6342
     7
  arising from the use of this software.
slouken@6342
     8
slouken@6342
     9
  Permission is granted to anyone to use this software for any purpose,
slouken@6342
    10
  including commercial applications, and to alter it and redistribute it
slouken@6342
    11
  freely, subject to the following restrictions:
slouken@6342
    12
slouken@6342
    13
  1. The origin of this software must not be misrepresented; you must not
slouken@6342
    14
     claim that you wrote the original software. If you use this software
slouken@6342
    15
     in a product, an acknowledgment in the product documentation would be
slouken@6342
    16
     appreciated but is not required.
slouken@6342
    17
  2. Altered source versions must be plainly marked as such, and must not be
slouken@6342
    18
     misrepresented as being the original software.
slouken@6342
    19
  3. This notice may not be removed or altered from any source distribution.
slouken@6342
    20
*/
slouken@6342
    21
slouken@6342
    22
/**
slouken@6342
    23
 *  \file SDL_system.h
slouken@7191
    24
 *
slouken@6342
    25
 *  Include file for platform specific SDL API functions
slouken@6342
    26
 */
slouken@6342
    27
slouken@6342
    28
#ifndef _SDL_system_h
slouken@6342
    29
#define _SDL_system_h
slouken@6342
    30
slouken@6342
    31
#include "SDL_stdinc.h"
slouken@7763
    32
#include "SDL_keyboard.h"
slouken@7763
    33
#include "SDL_render.h"
slouken@6392
    34
#include "SDL_video.h"
slouken@6392
    35
slouken@6342
    36
#include "begin_code.h"
slouken@6342
    37
/* Set up for C function definitions, even when using C++ */
slouken@6342
    38
#ifdef __cplusplus
slouken@6342
    39
extern "C" {
slouken@6342
    40
#endif
slouken@6342
    41
slouken@7742
    42
slouken@7742
    43
/* Platform specific functions for Windows */
slouken@7742
    44
#ifdef __WIN32__
slouken@7742
    45
slouken@7742
    46
/* Returns the D3D9 adapter index that matches the specified display index.
slouken@7742
    47
   This adapter index can be passed to IDirect3D9::CreateDevice and controls
slouken@7742
    48
   on which monitor a full screen application will appear.
slouken@7742
    49
*/
slouken@7742
    50
extern DECLSPEC int SDLCALL SDL_Direct3D9GetAdapterIndex( int displayIndex );
slouken@7742
    51
slouken@7766
    52
/* Returns the D3D device associated with a renderer, or NULL if it's not a D3D renderer.
slouken@7766
    53
   Once you are done using the device, you should release it to avoid a resource leak.
slouken@7766
    54
 */
slouken@7763
    55
typedef struct IDirect3DDevice9 IDirect3DDevice9;
slouken@7765
    56
extern DECLSPEC IDirect3DDevice9* SDLCALL SDL_RenderGetD3D9Device(SDL_Renderer * renderer);
slouken@7763
    57
slouken@8213
    58
/* Returns the DXGI Adapter and Output indices for the specified display index. 
slouken@8213
    59
   These can be passed to EnumAdapters and EnumOutputs respectively to get the objects
slouken@8213
    60
   required to create a DX10 or DX11 device and swap chain.
slouken@8213
    61
 */
slouken@8213
    62
extern DECLSPEC void SDLCALL SDL_DXGIGetOutputInfo( int displayIndex, int *adapterIndex, int *outputIndex );
slouken@8213
    63
slouken@7742
    64
#endif /* __WIN32__ */
slouken@7742
    65
slouken@7742
    66
icculus@6635
    67
/* Platform specific functions for iOS */
slouken@6683
    68
#if defined(__IPHONEOS__) && __IPHONEOS__
slouken@6342
    69
slouken@6342
    70
extern DECLSPEC int SDLCALL SDL_iPhoneSetAnimationCallback(SDL_Window * window, int interval, void (*callback)(void*), void *callbackParam);
slouken@6346
    71
extern DECLSPEC void SDLCALL SDL_iPhoneSetEventPump(SDL_bool enabled);
slouken@6342
    72
slouken@6630
    73
#endif /* __IPHONEOS__ */
slouken@6630
    74
slouken@6630
    75
icculus@6636
    76
/* Platform specific functions for Android */
slouken@6683
    77
#if defined(__ANDROID__) && __ANDROID__
slouken@6630
    78
slouken@6630
    79
/* Get the JNI environment for the current thread
slouken@6630
    80
   This returns JNIEnv*, but the prototype is void* so we don't need jni.h
slouken@6630
    81
 */
slouken@6630
    82
extern DECLSPEC void * SDLCALL SDL_AndroidGetJNIEnv();
slouken@6630
    83
slouken@6630
    84
/* Get the SDL Activity object for the application
slouken@6630
    85
   This returns jobject, but the prototype is void* so we don't need jni.h
gabomdq@7095
    86
   The jobject returned by SDL_AndroidGetActivity is a local reference.
gabomdq@7095
    87
   It is the caller's responsibility to properly release it
philipp@7264
    88
   (using env->Push/PopLocalFrame or manually with env->DeleteLocalRef)
slouken@6630
    89
 */
slouken@6630
    90
extern DECLSPEC void * SDLCALL SDL_AndroidGetActivity();
slouken@6630
    91
slouken@6630
    92
/* See the official Android developer guide for more information:
slouken@6630
    93
   http://developer.android.com/guide/topics/data/data-storage.html
slouken@6630
    94
*/
slouken@6630
    95
#define SDL_ANDROID_EXTERNAL_STORAGE_READ   0x01
slouken@6630
    96
#define SDL_ANDROID_EXTERNAL_STORAGE_WRITE  0x02
slouken@6630
    97
slouken@6646
    98
/* Get the path used for internal storage for this application.
slouken@6646
    99
   This path is unique to your application and cannot be written to
slouken@6646
   100
   by other applications.
slouken@6646
   101
 */
slouken@6630
   102
extern DECLSPEC const char * SDLCALL SDL_AndroidGetInternalStoragePath();
slouken@6630
   103
slouken@6630
   104
/* Get the current state of external storage, a bitmask of these values:
slouken@6630
   105
    SDL_ANDROID_EXTERNAL_STORAGE_READ
slouken@6630
   106
    SDL_ANDROID_EXTERNAL_STORAGE_WRITE
slouken@6630
   107
   If external storage is currently unavailable, this will return 0.
slouken@6630
   108
*/
slouken@6630
   109
extern DECLSPEC int SDLCALL SDL_AndroidGetExternalStorageState();
slouken@6630
   110
slouken@6646
   111
/* Get the path used for external storage for this application.
slouken@6646
   112
   This path is unique to your application, but is public and can be
slouken@6646
   113
   written to by other applications.
slouken@6646
   114
 */
slouken@6630
   115
extern DECLSPEC const char * SDLCALL SDL_AndroidGetExternalStoragePath();
slouken@6630
   116
slouken@6630
   117
#endif /* __ANDROID__ */
slouken@6630
   118
slouken@6342
   119
/* Ends C function definitions when using C++ */
slouken@6342
   120
#ifdef __cplusplus
slouken@6342
   121
}
slouken@6342
   122
#endif
slouken@6342
   123
#include "close_code.h"
slouken@6342
   124
slouken@6342
   125
#endif /* _SDL_system_h */
slouken@6342
   126
slouken@6342
   127
/* vi: set ts=4 sw=4 expandtab: */