include/SDL_syswm.h
author Sam Lantinga <slouken@lokigames.com>
Sun, 08 Jul 2001 09:00:06 +0000
changeset 94 ae6e6b73333f
parent 32 13ae3bc6e39a
child 251 b8688cfdc232
permissions -rw-r--r--
Cleaned up the OpenBSD port, thanks to Peter Valchev
slouken@0
     1
/*
slouken@0
     2
    SDL - Simple DirectMedia Layer
slouken@0
     3
    Copyright (C) 1997, 1998, 1999, 2000, 2001  Sam Lantinga
slouken@0
     4
slouken@0
     5
    This library is free software; you can redistribute it and/or
slouken@0
     6
    modify it under the terms of the GNU Library General Public
slouken@0
     7
    License as published by the Free Software Foundation; either
slouken@0
     8
    version 2 of the License, or (at your option) any later version.
slouken@0
     9
slouken@0
    10
    This library is distributed in the hope that it will be useful,
slouken@0
    11
    but WITHOUT ANY WARRANTY; without even the implied warranty of
slouken@0
    12
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
slouken@0
    13
    Library General Public License for more details.
slouken@0
    14
slouken@0
    15
    You should have received a copy of the GNU Library General Public
slouken@0
    16
    License along with this library; if not, write to the Free
slouken@0
    17
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
slouken@0
    18
slouken@0
    19
    Sam Lantinga
slouken@0
    20
    slouken@devolution.com
slouken@0
    21
*/
slouken@0
    22
slouken@0
    23
#ifdef SAVE_RCSID
slouken@0
    24
static char rcsid =
slouken@0
    25
 "@(#) $Id$";
slouken@0
    26
#endif
slouken@0
    27
slouken@0
    28
/* Include file for SDL custom system window manager hooks */
slouken@0
    29
slouken@0
    30
#ifndef _SDL_syswm_h
slouken@0
    31
#define _SDL_syswm_h
slouken@0
    32
slouken@0
    33
#include "SDL_version.h"
slouken@0
    34
slouken@0
    35
#include "begin_code.h"
slouken@0
    36
/* Set up for C function definitions, even when using C++ */
slouken@0
    37
#ifdef __cplusplus
slouken@0
    38
extern "C" {
slouken@0
    39
#endif
slouken@0
    40
slouken@0
    41
/* Your application has access to a special type of event 'SDL_SYSWMEVENT',
slouken@0
    42
   which contains window-manager specific information and arrives whenever
slouken@0
    43
   an unhandled window event occurs.  This event is ignored by default, but
slouken@0
    44
   you can enable it with SDL_EventState()
slouken@0
    45
*/
slouken@0
    46
#ifdef SDL_PROTOTYPES_ONLY
slouken@0
    47
struct SDL_SysWMinfo;
slouken@0
    48
typedef struct SDL_SysWMinfo SDL_SysWMinfo;
slouken@0
    49
#else
slouken@0
    50
slouken@0
    51
/* This is the structure for custom window manager events */
slouken@94
    52
#if (defined(unix) || defined(__unix__) || defined(_AIX) || defined(__OpenBSD__)) && \
slouken@32
    53
    (!defined(DISABLE_X11) && !defined(__CYGWIN32__))
slouken@0
    54
 /* AIX is unix, of course, but the native compiler CSet doesn't define unix */
slouken@0
    55
#include <X11/Xlib.h>
slouken@0
    56
#include <X11/Xatom.h>
slouken@0
    57
slouken@0
    58
/* These are the various supported subsystems under UNIX */
slouken@0
    59
typedef enum {
slouken@0
    60
	SDL_SYSWM_X11
slouken@0
    61
} SDL_SYSWM_TYPE;
slouken@0
    62
slouken@0
    63
/* The UNIX custom event structure */
slouken@0
    64
struct SDL_SysWMmsg {
slouken@0
    65
	SDL_version version;
slouken@0
    66
	SDL_SYSWM_TYPE subsystem;
slouken@0
    67
	union {
slouken@0
    68
	    XEvent xevent;
slouken@0
    69
	} event;
slouken@0
    70
};
slouken@0
    71
slouken@0
    72
/* The UNIX custom window manager information structure.
slouken@0
    73
   When this structure is returned, it holds information about which
slouken@0
    74
   low level system it is using, and will be one of SDL_SYSWM_TYPE.
slouken@0
    75
 */
slouken@0
    76
typedef struct {
slouken@0
    77
	SDL_version version;
slouken@0
    78
	SDL_SYSWM_TYPE subsystem;
slouken@0
    79
	union {
slouken@0
    80
	    struct {
slouken@0
    81
	    	Display *display;	/* The X11 display */
slouken@0
    82
	    	Window window;		/* The X11 display window */
slouken@0
    83
		/* These locking functions should be called around
slouken@0
    84
                   any X11 functions using the display variable.
slouken@0
    85
                   They lock the event thread, so should not be
slouken@0
    86
		   called around event functions or from event filters.
slouken@0
    87
		 */
slouken@0
    88
		void (*lock_func)(void);
slouken@0
    89
		void (*unlock_func)(void);
slouken@0
    90
slouken@0
    91
		/* Introduced in SDL 1.0.2 */
slouken@0
    92
	    	Window fswindow;	/* The X11 fullscreen window */
slouken@0
    93
	    	Window wmwindow;	/* The X11 managed input window */
slouken@0
    94
	    } x11;
slouken@0
    95
	} info;
slouken@0
    96
} SDL_SysWMinfo;
slouken@0
    97
slouken@30
    98
#elif defined(ENABLE_NANOX)
slouken@30
    99
#include <microwin/nano-X.h>
slouken@30
   100
slouken@30
   101
/* The generic custom event structure */
slouken@30
   102
struct SDL_SysWMmsg {
slouken@30
   103
	SDL_version version;
slouken@30
   104
	int data;
slouken@30
   105
};
slouken@30
   106
slouken@30
   107
/* The windows custom window manager information structure */
slouken@30
   108
typedef struct {
slouken@30
   109
	SDL_version version ;
slouken@30
   110
	GR_WINDOW_ID window ;	/* The display window */
slouken@30
   111
} SDL_SysWMinfo;
slouken@30
   112
slouken@0
   113
#elif defined(WIN32)
slouken@0
   114
#include <windows.h>
slouken@0
   115
slouken@0
   116
/* The windows custom event structure */
slouken@0
   117
struct SDL_SysWMmsg {
slouken@0
   118
	SDL_version version;
slouken@0
   119
	HWND hwnd;			/* The window for the message */
slouken@0
   120
	UINT msg;			/* The type of message */
slouken@0
   121
	WPARAM wParam;			/* WORD message parameter */
slouken@0
   122
	LPARAM lParam;			/* LONG message parameter */
slouken@0
   123
};
slouken@0
   124
slouken@0
   125
/* The windows custom window manager information structure */
slouken@0
   126
typedef struct {
slouken@0
   127
	SDL_version version;
slouken@0
   128
	HWND window;			/* The Win32 display window */
slouken@0
   129
} SDL_SysWMinfo;
slouken@0
   130
slouken@0
   131
#else
slouken@0
   132
slouken@0
   133
/* The generic custom event structure */
slouken@0
   134
struct SDL_SysWMmsg {
slouken@0
   135
	SDL_version version;
slouken@0
   136
	int data;
slouken@0
   137
};
slouken@0
   138
slouken@0
   139
/* The generic custom window manager information structure */
slouken@0
   140
typedef struct {
slouken@0
   141
	SDL_version version;
slouken@0
   142
	int data;
slouken@0
   143
} SDL_SysWMinfo;
slouken@0
   144
slouken@0
   145
#endif /* OS type */
slouken@0
   146
slouken@0
   147
#endif /* SDL_PROTOTYPES_ONLY */
slouken@0
   148
slouken@0
   149
/* Function prototypes */
slouken@0
   150
/*
slouken@0
   151
 * This function gives you custom hooks into the window manager information.
slouken@0
   152
 * It fills the structure pointed to by 'info' with custom information and
slouken@0
   153
 * returns 1 if the function is implemented.  If it's not implemented, or
slouken@0
   154
 * the version member of the 'info' structure is invalid, it returns 0. 
slouken@0
   155
 */
slouken@0
   156
extern DECLSPEC int SDL_GetWMInfo(SDL_SysWMinfo *info);
slouken@0
   157
slouken@0
   158
slouken@0
   159
/* Ends C function definitions when using C++ */
slouken@0
   160
#ifdef __cplusplus
slouken@0
   161
}
slouken@0
   162
#endif
slouken@0
   163
#include "close_code.h"
slouken@0
   164
slouken@0
   165
#endif /* _SDL_syswm_h */