include/SDL_video.h
author Sam Lantinga <slouken@libsdl.org>
Thu, 11 Apr 2002 14:35:16 +0000
changeset 337 9154ec9ca3d2
parent 297 f6ffac90895c
child 431 41cadcba32e8
permissions -rw-r--r--
Explicitly specify the SDL API calling convention (C by default)
slouken@0
     1
/*
slouken@0
     2
    SDL - Simple DirectMedia Layer
slouken@297
     3
    Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002  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@251
    20
    slouken@libsdl.org
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
/* Header file for access to the SDL raw framebuffer window */
slouken@0
    29
slouken@0
    30
#ifndef _SDL_video_h
slouken@0
    31
#define _SDL_video_h
slouken@0
    32
slouken@0
    33
#include <stdio.h>
slouken@0
    34
slouken@0
    35
#include "SDL_types.h"
slouken@0
    36
#include "SDL_mutex.h"
slouken@0
    37
#include "SDL_rwops.h"
slouken@0
    38
slouken@0
    39
#include "begin_code.h"
slouken@0
    40
/* Set up for C function definitions, even when using C++ */
slouken@0
    41
#ifdef __cplusplus
slouken@0
    42
extern "C" {
slouken@0
    43
#endif
slouken@0
    44
slouken@0
    45
/* Transparency definitions: These define alpha as the opacity of a surface */
slouken@0
    46
#define SDL_ALPHA_OPAQUE 255
slouken@0
    47
#define SDL_ALPHA_TRANSPARENT 0
slouken@0
    48
slouken@0
    49
/* Useful data types */
slouken@0
    50
typedef struct {
slouken@0
    51
	Sint16 x, y;
slouken@0
    52
	Uint16 w, h;
slouken@0
    53
} SDL_Rect;
slouken@0
    54
slouken@0
    55
typedef struct {
slouken@0
    56
	Uint8 r;
slouken@0
    57
	Uint8 g;
slouken@0
    58
	Uint8 b;
slouken@0
    59
	Uint8 unused;
slouken@0
    60
} SDL_Color;
slouken@0
    61
slouken@0
    62
typedef struct {
slouken@0
    63
	int       ncolors;
slouken@0
    64
	SDL_Color *colors;
slouken@0
    65
} SDL_Palette;
slouken@0
    66
slouken@0
    67
/* Everything in the pixel format structure is read-only */
slouken@0
    68
typedef struct SDL_PixelFormat {
slouken@0
    69
	SDL_Palette *palette;
slouken@0
    70
	Uint8  BitsPerPixel;
slouken@0
    71
	Uint8  BytesPerPixel;
slouken@0
    72
	Uint8  Rloss;
slouken@0
    73
	Uint8  Gloss;
slouken@0
    74
	Uint8  Bloss;
slouken@0
    75
	Uint8  Aloss;
slouken@0
    76
	Uint8  Rshift;
slouken@0
    77
	Uint8  Gshift;
slouken@0
    78
	Uint8  Bshift;
slouken@0
    79
	Uint8  Ashift;
slouken@0
    80
	Uint32 Rmask;
slouken@0
    81
	Uint32 Gmask;
slouken@0
    82
	Uint32 Bmask;
slouken@0
    83
	Uint32 Amask;
slouken@0
    84
slouken@0
    85
	/* RGB color key information */
slouken@0
    86
	Uint32 colorkey;
slouken@0
    87
	/* Alpha value information (per-surface alpha) */
slouken@0
    88
	Uint8  alpha;
slouken@0
    89
} SDL_PixelFormat;
slouken@0
    90
slouken@0
    91
/* typedef for private surface blitting functions */
slouken@0
    92
struct SDL_Surface;
slouken@0
    93
typedef int (*SDL_blit)(struct SDL_Surface *src, SDL_Rect *srcrect,
slouken@0
    94
			struct SDL_Surface *dst, SDL_Rect *dstrect);
slouken@0
    95
slouken@0
    96
/* This structure should be treated as read-only, except for 'pixels',
slouken@0
    97
   which, if not NULL, contains the raw pixel data for the surface.
slouken@0
    98
*/
slouken@0
    99
typedef struct SDL_Surface {
slouken@0
   100
	Uint32 flags;				/* Read-only */
slouken@0
   101
	SDL_PixelFormat *format;		/* Read-only */
slouken@0
   102
	int w, h;				/* Read-only */
slouken@0
   103
	Uint16 pitch;				/* Read-only */
slouken@0
   104
	void *pixels;				/* Read-write */
slouken@0
   105
	int offset;				/* Private */
slouken@0
   106
slouken@0
   107
	/* Hardware-specific surface info */
slouken@0
   108
	struct private_hwdata *hwdata;
slouken@0
   109
slouken@0
   110
	/* clipping information */
slouken@0
   111
	SDL_Rect clip_rect;			/* Read-only */
slouken@0
   112
	Uint32 unused1;				/* for binary compatibility */
slouken@0
   113
slouken@0
   114
	/* Allow recursive locks */
slouken@0
   115
	Uint32 locked;				/* Private */
slouken@0
   116
slouken@0
   117
	/* info for fast blit mapping to other surfaces */
slouken@0
   118
	struct SDL_BlitMap *map;		/* Private */
slouken@0
   119
slouken@0
   120
	/* format version, bumped at every change to invalidate blit maps */
slouken@0
   121
	unsigned int format_version;		/* Private */
slouken@0
   122
slouken@0
   123
	/* Reference count -- used when freeing surface */
slouken@0
   124
	int refcount;				/* Read-mostly */
slouken@0
   125
} SDL_Surface;
slouken@0
   126
slouken@0
   127
/* These are the currently supported flags for the SDL_surface */
slouken@0
   128
/* Available for SDL_CreateRGBSurface() or SDL_SetVideoMode() */
slouken@0
   129
#define SDL_SWSURFACE	0x00000000	/* Surface is in system memory */
slouken@0
   130
#define SDL_HWSURFACE	0x00000001	/* Surface is in video memory */
slouken@0
   131
#define SDL_ASYNCBLIT	0x00000004	/* Use asynchronous blits if possible */
slouken@0
   132
/* Available for SDL_SetVideoMode() */
slouken@0
   133
#define SDL_ANYFORMAT	0x10000000	/* Allow any video depth/pixel-format */
slouken@0
   134
#define SDL_HWPALETTE	0x20000000	/* Surface has exclusive palette */
slouken@0
   135
#define SDL_DOUBLEBUF	0x40000000	/* Set up double-buffered video mode */
slouken@0
   136
#define SDL_FULLSCREEN	0x80000000	/* Surface is a full screen display */
slouken@0
   137
#define SDL_OPENGL      0x00000002      /* Create an OpenGL rendering context */
slouken@0
   138
#define SDL_OPENGLBLIT	0x0000000A	/* Create an OpenGL rendering context and use it for blitting */
slouken@0
   139
#define SDL_RESIZABLE	0x00000010	/* This video mode may be resized */
slouken@0
   140
#define SDL_NOFRAME	0x00000020	/* No window caption or edge frame */
slouken@0
   141
/* Used internally (read-only) */
slouken@0
   142
#define SDL_HWACCEL	0x00000100	/* Blit uses hardware acceleration */
slouken@0
   143
#define SDL_SRCCOLORKEY	0x00001000	/* Blit uses a source color key */
slouken@0
   144
#define SDL_RLEACCELOK	0x00002000	/* Private flag */
slouken@0
   145
#define SDL_RLEACCEL	0x00004000	/* Surface is RLE encoded */
slouken@0
   146
#define SDL_SRCALPHA	0x00010000	/* Blit uses source alpha blending */
slouken@0
   147
#define SDL_PREALLOC	0x01000000	/* Surface uses preallocated memory */
slouken@0
   148
slouken@0
   149
/* Evaluates to true if the surface needs to be locked before access */
slouken@0
   150
#define SDL_MUSTLOCK(surface)	\
slouken@0
   151
  (surface->offset ||		\
slouken@0
   152
  ((surface->flags & (SDL_HWSURFACE|SDL_ASYNCBLIT|SDL_RLEACCEL)) != 0))
slouken@0
   153
slouken@0
   154
slouken@0
   155
/* Useful for determining the video hardware capabilities */
slouken@0
   156
typedef struct {
slouken@0
   157
	Uint32 hw_available :1;	/* Flag: Can you create hardware surfaces? */
slouken@0
   158
	Uint32 wm_available :1;	/* Flag: Can you talk to a window manager? */
slouken@0
   159
	Uint32 UnusedBits1  :6;
slouken@0
   160
	Uint32 UnusedBits2  :1;
slouken@0
   161
	Uint32 blit_hw      :1;	/* Flag: Accelerated blits HW --> HW */
slouken@0
   162
	Uint32 blit_hw_CC   :1;	/* Flag: Accelerated blits with Colorkey */
slouken@0
   163
	Uint32 blit_hw_A    :1;	/* Flag: Accelerated blits with Alpha */
slouken@0
   164
	Uint32 blit_sw      :1;	/* Flag: Accelerated blits SW --> HW */
slouken@0
   165
	Uint32 blit_sw_CC   :1;	/* Flag: Accelerated blits with Colorkey */
slouken@0
   166
	Uint32 blit_sw_A    :1;	/* Flag: Accelerated blits with Alpha */
slouken@0
   167
	Uint32 blit_fill    :1;	/* Flag: Accelerated color fill */
slouken@0
   168
	Uint32 UnusedBits3  :16;
slouken@0
   169
	Uint32 video_mem;	/* The total amount of video memory (in K) */
slouken@0
   170
	SDL_PixelFormat *vfmt;	/* Value: The format of the video surface */
slouken@0
   171
} SDL_VideoInfo;
slouken@0
   172
slouken@0
   173
slouken@0
   174
/* The most common video overlay formats.
slouken@0
   175
   For an explanation of these pixel formats, see:
slouken@0
   176
	http://www.webartz.com/fourcc/indexyuv.htm
slouken@0
   177
slouken@0
   178
   For information on the relationship between color spaces, see:
slouken@0
   179
   http://www.neuro.sfc.keio.ac.jp/~aly/polygon/info/color-space-faq.html
slouken@0
   180
 */
slouken@0
   181
#define SDL_YV12_OVERLAY  0x32315659	/* Planar mode: Y + V + U  (3 planes) */
slouken@0
   182
#define SDL_IYUV_OVERLAY  0x56555949	/* Planar mode: Y + U + V  (3 planes) */
slouken@0
   183
#define SDL_YUY2_OVERLAY  0x32595559	/* Packed mode: Y0+U0+Y1+V0 (1 plane) */
slouken@0
   184
#define SDL_UYVY_OVERLAY  0x59565955	/* Packed mode: U0+Y0+V0+Y1 (1 plane) */
slouken@0
   185
#define SDL_YVYU_OVERLAY  0x55595659	/* Packed mode: Y0+V0+Y1+U0 (1 plane) */
slouken@0
   186
slouken@0
   187
/* The YUV hardware video overlay */
slouken@0
   188
typedef struct SDL_Overlay {
slouken@0
   189
	Uint32 format;				/* Read-only */
slouken@0
   190
	int w, h;				/* Read-only */
slouken@0
   191
	int planes;				/* Read-only */
slouken@0
   192
	Uint16 *pitches;			/* Read-only */
slouken@0
   193
	Uint8 **pixels;				/* Read-write */
slouken@0
   194
slouken@0
   195
	/* Hardware-specific surface info */
slouken@0
   196
	struct private_yuvhwfuncs *hwfuncs;
slouken@0
   197
	struct private_yuvhwdata *hwdata;
slouken@0
   198
slouken@0
   199
	/* Special flags */
slouken@0
   200
	Uint32 hw_overlay :1;	/* Flag: This overlay hardware accelerated? */
slouken@0
   201
	Uint32 UnusedBits :31;
slouken@0
   202
} SDL_Overlay;
slouken@0
   203
slouken@0
   204
slouken@0
   205
/* Public enumeration for setting the OpenGL window attributes. */
slouken@0
   206
typedef enum {
slouken@0
   207
    SDL_GL_RED_SIZE,
slouken@0
   208
    SDL_GL_GREEN_SIZE,
slouken@0
   209
    SDL_GL_BLUE_SIZE,
slouken@0
   210
    SDL_GL_ALPHA_SIZE,
slouken@0
   211
    SDL_GL_BUFFER_SIZE,
slouken@0
   212
    SDL_GL_DOUBLEBUFFER,
slouken@0
   213
    SDL_GL_DEPTH_SIZE,
slouken@0
   214
    SDL_GL_STENCIL_SIZE,
slouken@0
   215
    SDL_GL_ACCUM_RED_SIZE,
slouken@0
   216
    SDL_GL_ACCUM_GREEN_SIZE,
slouken@0
   217
    SDL_GL_ACCUM_BLUE_SIZE,
slouken@0
   218
    SDL_GL_ACCUM_ALPHA_SIZE
slouken@0
   219
} SDL_GLattr;
slouken@0
   220
slouken@0
   221
/* flags for SDL_SetPalette() */
slouken@0
   222
#define SDL_LOGPAL 0x01
slouken@0
   223
#define SDL_PHYSPAL 0x02
slouken@0
   224
slouken@0
   225
/* Function prototypes */
slouken@0
   226
slouken@0
   227
/* These functions are used internally, and should not be used unless you
slouken@0
   228
 * have a specific need to specify the video driver you want to use.
slouken@0
   229
 * You should normally use SDL_Init() or SDL_InitSubSystem().
slouken@0
   230
 *
slouken@0
   231
 * SDL_VideoInit() initializes the video subsystem -- sets up a connection
slouken@0
   232
 * to the window manager, etc, and determines the current video mode and
slouken@0
   233
 * pixel format, but does not initialize a window or graphics mode.
slouken@0
   234
 * Note that event handling is activated by this routine.
slouken@0
   235
 *
slouken@0
   236
 * If you use both sound and video in your application, you need to call
slouken@0
   237
 * SDL_Init() before opening the sound device, otherwise under Win32 DirectX,
slouken@0
   238
 * you won't be able to set full-screen display modes.
slouken@0
   239
 */
slouken@337
   240
extern DECLSPEC int SDLCALL SDL_VideoInit(const char *driver_name, Uint32 flags);
slouken@337
   241
extern DECLSPEC void SDLCALL SDL_VideoQuit(void);
slouken@0
   242
slouken@0
   243
/* This function fills the given character buffer with the name of the
slouken@0
   244
 * video driver, and returns a pointer to it if the video driver has
slouken@0
   245
 * been initialized.  It returns NULL if no driver has been initialized.
slouken@0
   246
 */
slouken@337
   247
extern DECLSPEC char * SDLCALL SDL_VideoDriverName(char *namebuf, int maxlen);
slouken@0
   248
slouken@0
   249
/*
slouken@0
   250
 * This function returns a pointer to the current display surface.
slouken@0
   251
 * If SDL is doing format conversion on the display surface, this
slouken@0
   252
 * function returns the publicly visible surface, not the real video
slouken@0
   253
 * surface.
slouken@0
   254
 */
slouken@337
   255
extern DECLSPEC SDL_Surface * SDLCALL SDL_GetVideoSurface(void);
slouken@0
   256
slouken@0
   257
/*
slouken@0
   258
 * This function returns a read-only pointer to information about the
slouken@0
   259
 * video hardware.  If this is called before SDL_SetVideoMode(), the 'vfmt'
slouken@0
   260
 * member of the returned structure will contain the pixel format of the
slouken@0
   261
 * "best" video mode.
slouken@0
   262
 */
slouken@337
   263
extern DECLSPEC const SDL_VideoInfo * SDLCALL SDL_GetVideoInfo(void);
slouken@0
   264
slouken@0
   265
/* 
slouken@0
   266
 * Check to see if a particular video mode is supported.
slouken@0
   267
 * It returns 0 if the requested mode is not supported under any bit depth,
slouken@0
   268
 * or returns the bits-per-pixel of the closest available mode with the
slouken@0
   269
 * given width and height.  If this bits-per-pixel is different from the
slouken@0
   270
 * one used when setting the video mode, SDL_SetVideoMode() will succeed,
slouken@0
   271
 * but will emulate the requested bits-per-pixel with a shadow surface.
slouken@0
   272
 *
slouken@0
   273
 * The arguments to SDL_VideoModeOK() are the same ones you would pass to
slouken@0
   274
 * SDL_SetVideoMode()
slouken@0
   275
 */
slouken@337
   276
extern DECLSPEC int SDLCALL SDL_VideoModeOK(int width, int height, int bpp, Uint32 flags);
slouken@0
   277
slouken@0
   278
/*
slouken@0
   279
 * Return a pointer to an array of available screen dimensions for the
slouken@0
   280
 * given format and video flags, sorted largest to smallest.  Returns 
slouken@0
   281
 * NULL if there are no dimensions available for a particular format, 
slouken@0
   282
 * or (SDL_Rect **)-1 if any dimension is okay for the given format.
slouken@0
   283
 *
slouken@0
   284
 * If 'format' is NULL, the mode list will be for the format given 
slouken@0
   285
 * by SDL_GetVideoInfo()->vfmt
slouken@0
   286
 */
slouken@337
   287
extern DECLSPEC SDL_Rect ** SDLCALL SDL_ListModes(SDL_PixelFormat *format, Uint32 flags);
slouken@0
   288
slouken@0
   289
/*
slouken@0
   290
 * Set up a video mode with the specified width, height and bits-per-pixel.
slouken@0
   291
 *
slouken@0
   292
 * If 'bpp' is 0, it is treated as the current display bits per pixel.
slouken@0
   293
 *
slouken@0
   294
 * If SDL_ANYFORMAT is set in 'flags', the SDL library will try to set the
slouken@0
   295
 * requested bits-per-pixel, but will return whatever video pixel format is
slouken@0
   296
 * available.  The default is to emulate the requested pixel format if it
slouken@0
   297
 * is not natively available.
slouken@0
   298
 *
slouken@0
   299
 * If SDL_HWSURFACE is set in 'flags', the video surface will be placed in
slouken@0
   300
 * video memory, if possible, and you may have to call SDL_LockSurface()
slouken@0
   301
 * in order to access the raw framebuffer.  Otherwise, the video surface
slouken@0
   302
 * will be created in system memory.
slouken@0
   303
 *
slouken@0
   304
 * If SDL_ASYNCBLIT is set in 'flags', SDL will try to perform rectangle
slouken@0
   305
 * updates asynchronously, but you must always lock before accessing pixels.
slouken@0
   306
 * SDL will wait for updates to complete before returning from the lock.
slouken@0
   307
 *
slouken@0
   308
 * If SDL_HWPALETTE is set in 'flags', the SDL library will guarantee
slouken@0
   309
 * that the colors set by SDL_SetColors() will be the colors you get.
slouken@0
   310
 * Otherwise, in 8-bit mode, SDL_SetColors() may not be able to set all
slouken@0
   311
 * of the colors exactly the way they are requested, and you should look
slouken@0
   312
 * at the video surface structure to determine the actual palette.
slouken@0
   313
 * If SDL cannot guarantee that the colors you request can be set, 
slouken@0
   314
 * i.e. if the colormap is shared, then the video surface may be created
slouken@0
   315
 * under emulation in system memory, overriding the SDL_HWSURFACE flag.
slouken@0
   316
 *
slouken@0
   317
 * If SDL_FULLSCREEN is set in 'flags', the SDL library will try to set
slouken@0
   318
 * a fullscreen video mode.  The default is to create a windowed mode
slouken@0
   319
 * if the current graphics system has a window manager.
slouken@0
   320
 * If the SDL library is able to set a fullscreen video mode, this flag 
slouken@0
   321
 * will be set in the surface that is returned.
slouken@0
   322
 *
slouken@0
   323
 * If SDL_DOUBLEBUF is set in 'flags', the SDL library will try to set up
slouken@0
   324
 * two surfaces in video memory and swap between them when you call 
slouken@0
   325
 * SDL_Flip().  This is usually slower than the normal single-buffering
slouken@0
   326
 * scheme, but prevents "tearing" artifacts caused by modifying video 
slouken@0
   327
 * memory while the monitor is refreshing.  It should only be used by 
slouken@0
   328
 * applications that redraw the entire screen on every update.
slouken@0
   329
 *
slouken@0
   330
 * If SDL_RESIZABLE is set in 'flags', the SDL library will allow the
slouken@0
   331
 * window manager, if any, to resize the window at runtime.  When this
slouken@0
   332
 * occurs, SDL will send a SDL_VIDEORESIZE event to you application,
slouken@0
   333
 * and you must respond to the event by re-calling SDL_SetVideoMode()
slouken@0
   334
 * with the requested size (or another size that suits the application).
slouken@0
   335
 *
slouken@0
   336
 * If SDL_NOFRAME is set in 'flags', the SDL library will create a window
slouken@0
   337
 * without any title bar or frame decoration.  Fullscreen video modes have
slouken@0
   338
 * this flag set automatically.
slouken@0
   339
 *
slouken@0
   340
 * This function returns the video framebuffer surface, or NULL if it fails.
slouken@0
   341
 *
slouken@0
   342
 * If you rely on functionality provided by certain video flags, check the
slouken@0
   343
 * flags of the returned surface to make sure that functionality is available.
slouken@0
   344
 * SDL will fall back to reduced functionality if the exact flags you wanted
slouken@0
   345
 * are not available.
slouken@0
   346
 */
slouken@337
   347
extern DECLSPEC SDL_Surface * SDLCALL SDL_SetVideoMode
slouken@0
   348
			(int width, int height, int bpp, Uint32 flags);
slouken@0
   349
slouken@0
   350
/*
slouken@0
   351
 * Makes sure the given list of rectangles is updated on the given screen.
slouken@0
   352
 * If 'x', 'y', 'w' and 'h' are all 0, SDL_UpdateRect will update the entire
slouken@0
   353
 * screen.
slouken@0
   354
 * These functions should not be called while 'screen' is locked.
slouken@0
   355
 */
slouken@337
   356
extern DECLSPEC void SDLCALL SDL_UpdateRects
slouken@0
   357
		(SDL_Surface *screen, int numrects, SDL_Rect *rects);
slouken@337
   358
extern DECLSPEC void SDLCALL SDL_UpdateRect
slouken@0
   359
		(SDL_Surface *screen, Sint32 x, Sint32 y, Uint32 w, Uint32 h);
slouken@0
   360
slouken@0
   361
/*
slouken@0
   362
 * On hardware that supports double-buffering, this function sets up a flip
slouken@0
   363
 * and returns.  The hardware will wait for vertical retrace, and then swap
slouken@0
   364
 * video buffers before the next video surface blit or lock will return.
slouken@0
   365
 * On hardware that doesn not support double-buffering, this is equivalent
slouken@0
   366
 * to calling SDL_UpdateRect(screen, 0, 0, 0, 0);
slouken@0
   367
 * The SDL_DOUBLEBUF flag must have been passed to SDL_SetVideoMode() when
slouken@0
   368
 * setting the video mode for this function to perform hardware flipping.
slouken@0
   369
 * This function returns 0 if successful, or -1 if there was an error.
slouken@0
   370
 */
slouken@337
   371
extern DECLSPEC int SDLCALL SDL_Flip(SDL_Surface *screen);
slouken@0
   372
slouken@0
   373
/*
slouken@0
   374
 * Set the gamma correction for each of the color channels.
slouken@0
   375
 * The gamma values range (approximately) between 0.1 and 10.0
slouken@0
   376
 * 
slouken@0
   377
 * If this function isn't supported directly by the hardware, it will
slouken@0
   378
 * be emulated using gamma ramps, if available.  If successful, this
slouken@0
   379
 * function returns 0, otherwise it returns -1.
slouken@0
   380
 */
slouken@337
   381
extern DECLSPEC int SDLCALL SDL_SetGamma(float red, float green, float blue);
slouken@0
   382
slouken@0
   383
/*
slouken@0
   384
 * Set the gamma translation table for the red, green, and blue channels
slouken@0
   385
 * of the video hardware.  Each table is an array of 256 16-bit quantities,
slouken@0
   386
 * representing a mapping between the input and output for that channel.
slouken@0
   387
 * The input is the index into the array, and the output is the 16-bit
slouken@0
   388
 * gamma value at that index, scaled to the output color precision.
slouken@0
   389
 * 
slouken@0
   390
 * You may pass NULL for any of the channels to leave it unchanged.
slouken@0
   391
 * If the call succeeds, it will return 0.  If the display driver or
slouken@0
   392
 * hardware does not support gamma translation, or otherwise fails,
slouken@0
   393
 * this function will return -1.
slouken@0
   394
 */
slouken@337
   395
extern DECLSPEC int SDLCALL SDL_SetGammaRamp(Uint16 *red, Uint16 *green, Uint16 *blue);
slouken@0
   396
slouken@0
   397
/*
slouken@0
   398
 * Retrieve the current values of the gamma translation tables.
slouken@0
   399
 * 
slouken@0
   400
 * You must pass in valid pointers to arrays of 256 16-bit quantities.
slouken@0
   401
 * Any of the pointers may be NULL to ignore that channel.
slouken@0
   402
 * If the call succeeds, it will return 0.  If the display driver or
slouken@0
   403
 * hardware does not support gamma translation, or otherwise fails,
slouken@0
   404
 * this function will return -1.
slouken@0
   405
 */
slouken@337
   406
extern DECLSPEC int SDLCALL SDL_GetGammaRamp(Uint16 *red, Uint16 *green, Uint16 *blue);
slouken@0
   407
slouken@0
   408
/*
slouken@0
   409
 * Sets a portion of the colormap for the given 8-bit surface.  If 'surface'
slouken@0
   410
 * is not a palettized surface, this function does nothing, returning 0.
slouken@0
   411
 * If all of the colors were set as passed to SDL_SetColors(), it will
slouken@0
   412
 * return 1.  If not all the color entries were set exactly as given,
slouken@0
   413
 * it will return 0, and you should look at the surface palette to
slouken@0
   414
 * determine the actual color palette.
slouken@0
   415
 *
slouken@0
   416
 * When 'surface' is the surface associated with the current display, the
slouken@0
   417
 * display colormap will be updated with the requested colors.  If 
slouken@0
   418
 * SDL_HWPALETTE was set in SDL_SetVideoMode() flags, SDL_SetColors()
slouken@0
   419
 * will always return 1, and the palette is guaranteed to be set the way
slouken@0
   420
 * you desire, even if the window colormap has to be warped or run under
slouken@0
   421
 * emulation.
slouken@0
   422
 */
slouken@337
   423
extern DECLSPEC int SDLCALL SDL_SetColors(SDL_Surface *surface, 
slouken@0
   424
			SDL_Color *colors, int firstcolor, int ncolors);
slouken@0
   425
slouken@0
   426
/*
slouken@0
   427
 * Sets a portion of the colormap for a given 8-bit surface.
slouken@0
   428
 * 'flags' is one or both of:
slouken@0
   429
 * SDL_LOGPAL  -- set logical palette, which controls how blits are mapped
slouken@0
   430
 *                to/from the surface,
slouken@0
   431
 * SDL_PHYSPAL -- set physical palette, which controls how pixels look on
slouken@0
   432
 *                the screen
slouken@0
   433
 * Only screens have physical palettes. Separate change of physical/logical
slouken@0
   434
 * palettes is only possible if the screen has SDL_HWPALETTE set.
slouken@0
   435
 *
slouken@0
   436
 * The return value is 1 if all colours could be set as requested, and 0
slouken@0
   437
 * otherwise.
slouken@0
   438
 *
slouken@0
   439
 * SDL_SetColors() is equivalent to calling this function with
slouken@0
   440
 *     flags = (SDL_LOGPAL|SDL_PHYSPAL).
slouken@0
   441
 */
slouken@337
   442
extern DECLSPEC int SDLCALL SDL_SetPalette(SDL_Surface *surface, int flags,
slouken@0
   443
				   SDL_Color *colors, int firstcolor,
slouken@0
   444
				   int ncolors);
slouken@0
   445
slouken@0
   446
/*
slouken@0
   447
 * Maps an RGB triple to an opaque pixel value for a given pixel format
slouken@0
   448
 */
slouken@337
   449
extern DECLSPEC Uint32 SDLCALL SDL_MapRGB
slouken@0
   450
			(SDL_PixelFormat *format, Uint8 r, Uint8 g, Uint8 b);
slouken@0
   451
slouken@0
   452
/*
slouken@0
   453
 * Maps an RGBA quadruple to a pixel value for a given pixel format
slouken@0
   454
 */
slouken@337
   455
extern DECLSPEC Uint32 SDLCALL SDL_MapRGBA(SDL_PixelFormat *format,
slouken@0
   456
				   Uint8 r, Uint8 g, Uint8 b, Uint8 a);
slouken@0
   457
slouken@0
   458
/*
slouken@0
   459
 * Maps a pixel value into the RGB components for a given pixel format
slouken@0
   460
 */
slouken@337
   461
extern DECLSPEC void SDLCALL SDL_GetRGB(Uint32 pixel, SDL_PixelFormat *fmt,
slouken@0
   462
				Uint8 *r, Uint8 *g, Uint8 *b);
slouken@0
   463
slouken@0
   464
/*
slouken@0
   465
 * Maps a pixel value into the RGBA components for a given pixel format
slouken@0
   466
 */
slouken@337
   467
extern DECLSPEC void SDLCALL SDL_GetRGBA(Uint32 pixel, SDL_PixelFormat *fmt,
slouken@0
   468
				 Uint8 *r, Uint8 *g, Uint8 *b, Uint8 *a);
slouken@0
   469
slouken@0
   470
/*
slouken@0
   471
 * Allocate and free an RGB surface (must be called after SDL_SetVideoMode)
slouken@0
   472
 * If the depth is 4 or 8 bits, an empty palette is allocated for the surface.
slouken@0
   473
 * If the depth is greater than 8 bits, the pixel format is set using the
slouken@0
   474
 * flags '[RGB]mask'.
slouken@0
   475
 * If the function runs out of memory, it will return NULL.
slouken@0
   476
 *
slouken@0
   477
 * The 'flags' tell what kind of surface to create.
slouken@0
   478
 * SDL_SWSURFACE means that the surface should be created in system memory.
slouken@0
   479
 * SDL_HWSURFACE means that the surface should be created in video memory,
slouken@0
   480
 * with the same format as the display surface.  This is useful for surfaces
slouken@0
   481
 * that will not change much, to take advantage of hardware acceleration
slouken@0
   482
 * when being blitted to the display surface.
slouken@0
   483
 * SDL_ASYNCBLIT means that SDL will try to perform asynchronous blits with
slouken@0
   484
 * this surface, but you must always lock it before accessing the pixels.
slouken@0
   485
 * SDL will wait for current blits to finish before returning from the lock.
slouken@0
   486
 * SDL_SRCCOLORKEY indicates that the surface will be used for colorkey blits.
slouken@0
   487
 * If the hardware supports acceleration of colorkey blits between
slouken@0
   488
 * two surfaces in video memory, SDL will try to place the surface in
slouken@0
   489
 * video memory. If this isn't possible or if there is no hardware
slouken@0
   490
 * acceleration available, the surface will be placed in system memory.
slouken@0
   491
 * SDL_SRCALPHA means that the surface will be used for alpha blits and 
slouken@0
   492
 * if the hardware supports hardware acceleration of alpha blits between
slouken@0
   493
 * two surfaces in video memory, to place the surface in video memory
slouken@0
   494
 * if possible, otherwise it will be placed in system memory.
slouken@0
   495
 * If the surface is created in video memory, blits will be _much_ faster,
slouken@0
   496
 * but the surface format must be identical to the video surface format,
slouken@0
   497
 * and the only way to access the pixels member of the surface is to use
slouken@0
   498
 * the SDL_LockSurface() and SDL_UnlockSurface() calls.
slouken@0
   499
 * If the requested surface actually resides in video memory, SDL_HWSURFACE
slouken@0
   500
 * will be set in the flags member of the returned surface.  If for some
slouken@0
   501
 * reason the surface could not be placed in video memory, it will not have
slouken@0
   502
 * the SDL_HWSURFACE flag set, and will be created in system memory instead.
slouken@0
   503
 */
slouken@0
   504
#define SDL_AllocSurface    SDL_CreateRGBSurface
slouken@337
   505
extern DECLSPEC SDL_Surface * SDLCALL SDL_CreateRGBSurface
slouken@0
   506
			(Uint32 flags, int width, int height, int depth, 
slouken@0
   507
			Uint32 Rmask, Uint32 Gmask, Uint32 Bmask, Uint32 Amask);
slouken@337
   508
extern DECLSPEC SDL_Surface * SDLCALL SDL_CreateRGBSurfaceFrom(void *pixels,
slouken@0
   509
			int width, int height, int depth, int pitch,
slouken@0
   510
			Uint32 Rmask, Uint32 Gmask, Uint32 Bmask, Uint32 Amask);
slouken@337
   511
extern DECLSPEC void SDLCALL SDL_FreeSurface(SDL_Surface *surface);
slouken@0
   512
slouken@0
   513
/*
slouken@0
   514
 * SDL_LockSurface() sets up a surface for directly accessing the pixels.
slouken@0
   515
 * Between calls to SDL_LockSurface()/SDL_UnlockSurface(), you can write
slouken@0
   516
 * to and read from 'surface->pixels', using the pixel format stored in 
slouken@0
   517
 * 'surface->format'.  Once you are done accessing the surface, you should 
slouken@0
   518
 * use SDL_UnlockSurface() to release it.
slouken@0
   519
 *
slouken@0
   520
 * Not all surfaces require locking.  If SDL_MUSTLOCK(surface) evaluates
slouken@0
   521
 * to 0, then you can read and write to the surface at any time, and the
slouken@0
   522
 * pixel format of the surface will not change.  In particular, if the
slouken@0
   523
 * SDL_HWSURFACE flag is not given when calling SDL_SetVideoMode(), you
slouken@0
   524
 * will not need to lock the display surface before accessing it.
slouken@0
   525
 * 
slouken@0
   526
 * No operating system or library calls should be made between lock/unlock
slouken@0
   527
 * pairs, as critical system locks may be held during this time.
slouken@0
   528
 *
slouken@0
   529
 * SDL_LockSurface() returns 0, or -1 if the surface couldn't be locked.
slouken@0
   530
 */
slouken@337
   531
extern DECLSPEC int SDLCALL SDL_LockSurface(SDL_Surface *surface);
slouken@337
   532
extern DECLSPEC void SDLCALL SDL_UnlockSurface(SDL_Surface *surface);
slouken@0
   533
slouken@0
   534
/*
slouken@0
   535
 * Load a surface from a seekable SDL data source (memory or file.)
slouken@0
   536
 * If 'freesrc' is non-zero, the source will be closed after being read.
slouken@0
   537
 * Returns the new surface, or NULL if there was an error.
slouken@0
   538
 * The new surface should be freed with SDL_FreeSurface().
slouken@0
   539
 */
slouken@337
   540
extern DECLSPEC SDL_Surface * SDLCALL SDL_LoadBMP_RW(SDL_RWops *src, int freesrc);
slouken@0
   541
slouken@0
   542
/* Convenience macro -- load a surface from a file */
slouken@0
   543
#define SDL_LoadBMP(file)	SDL_LoadBMP_RW(SDL_RWFromFile(file, "rb"), 1)
slouken@0
   544
slouken@0
   545
/*
slouken@0
   546
 * Save a surface to a seekable SDL data source (memory or file.)
slouken@0
   547
 * If 'freedst' is non-zero, the source will be closed after being written.
slouken@0
   548
 * Returns 0 if successful or -1 if there was an error.
slouken@0
   549
 */
slouken@337
   550
extern DECLSPEC int SDLCALL SDL_SaveBMP_RW
slouken@0
   551
		(SDL_Surface *surface, SDL_RWops *dst, int freedst);
slouken@0
   552
slouken@0
   553
/* Convenience macro -- save a surface to a file */
slouken@0
   554
#define SDL_SaveBMP(surface, file) \
slouken@0
   555
		SDL_SaveBMP_RW(surface, SDL_RWFromFile(file, "wb"), 1)
slouken@0
   556
slouken@0
   557
/*
slouken@0
   558
 * Sets the color key (transparent pixel) in a blittable surface.
slouken@0
   559
 * If 'flag' is SDL_SRCCOLORKEY (optionally OR'd with SDL_RLEACCEL), 
slouken@0
   560
 * 'key' will be the transparent pixel in the source image of a blit.
slouken@0
   561
 * SDL_RLEACCEL requests RLE acceleration for the surface if present,
slouken@0
   562
 * and removes RLE acceleration if absent.
slouken@0
   563
 * If 'flag' is 0, this function clears any current color key.
slouken@0
   564
 * This function returns 0, or -1 if there was an error.
slouken@0
   565
 */
slouken@337
   566
extern DECLSPEC int SDLCALL SDL_SetColorKey
slouken@0
   567
			(SDL_Surface *surface, Uint32 flag, Uint32 key);
slouken@0
   568
slouken@0
   569
/*
slouken@0
   570
 * This function sets the alpha value for the entire surface, as opposed to
slouken@0
   571
 * using the alpha component of each pixel. This value measures the range
slouken@0
   572
 * of transparency of the surface, 0 being completely transparent to 255
slouken@0
   573
 * being completely opaque. An 'alpha' value of 255 causes blits to be
slouken@0
   574
 * opaque, the source pixels copied to the destination (the default). Note
slouken@0
   575
 * that per-surface alpha can be combined with colorkey transparency.
slouken@0
   576
 *
slouken@0
   577
 * If 'flag' is 0, alpha blending is disabled for the surface.
slouken@0
   578
 * If 'flag' is SDL_SRCALPHA, alpha blending is enabled for the surface.
slouken@0
   579
 * OR:ing the flag with SDL_RLEACCEL requests RLE acceleration for the
slouken@0
   580
 * surface; if SDL_RLEACCEL is not specified, the RLE accel will be removed.
slouken@0
   581
 */
slouken@337
   582
extern DECLSPEC int SDLCALL SDL_SetAlpha(SDL_Surface *surface, Uint32 flag, Uint8 alpha);
slouken@0
   583
slouken@0
   584
/*
slouken@0
   585
 * Sets the clipping rectangle for the destination surface in a blit.
slouken@0
   586
 *
slouken@0
   587
 * If the clip rectangle is NULL, clipping will be disabled.
slouken@0
   588
 * If the clip rectangle doesn't intersect the surface, the function will
slouken@0
   589
 * return SDL_FALSE and blits will be completely clipped.  Otherwise the
slouken@0
   590
 * function returns SDL_TRUE and blits to the surface will be clipped to
slouken@0
   591
 * the intersection of the surface area and the clipping rectangle.
slouken@0
   592
 *
slouken@0
   593
 * Note that blits are automatically clipped to the edges of the source
slouken@0
   594
 * and destination surfaces.
slouken@0
   595
 */
slouken@337
   596
extern DECLSPEC SDL_bool SDLCALL SDL_SetClipRect(SDL_Surface *surface, const SDL_Rect *rect);
slouken@0
   597
slouken@0
   598
/*
slouken@0
   599
 * Gets the clipping rectangle for the destination surface in a blit.
slouken@0
   600
 * 'rect' must be a pointer to a valid rectangle which will be filled
slouken@0
   601
 * with the correct values.
slouken@0
   602
 */
slouken@337
   603
extern DECLSPEC void SDLCALL SDL_GetClipRect(SDL_Surface *surface, SDL_Rect *rect);
slouken@0
   604
slouken@0
   605
/*
slouken@0
   606
 * Creates a new surface of the specified format, and then copies and maps 
slouken@0
   607
 * the given surface to it so the blit of the converted surface will be as 
slouken@0
   608
 * fast as possible.  If this function fails, it returns NULL.
slouken@0
   609
 *
slouken@0
   610
 * The 'flags' parameter is passed to SDL_CreateRGBSurface() and has those 
slouken@0
   611
 * semantics.  You can also pass SDL_RLEACCEL in the flags parameter and
slouken@0
   612
 * SDL will try to RLE accelerate colorkey and alpha blits in the resulting
slouken@0
   613
 * surface.
slouken@0
   614
 *
slouken@0
   615
 * This function is used internally by SDL_DisplayFormat().
slouken@0
   616
 */
slouken@337
   617
extern DECLSPEC SDL_Surface * SDLCALL SDL_ConvertSurface
slouken@0
   618
			(SDL_Surface *src, SDL_PixelFormat *fmt, Uint32 flags);
slouken@0
   619
slouken@0
   620
/*
slouken@0
   621
 * This performs a fast blit from the source surface to the destination
slouken@0
   622
 * surface.  It assumes that the source and destination rectangles are
slouken@0
   623
 * the same size.  If either 'srcrect' or 'dstrect' are NULL, the entire
slouken@0
   624
 * surface (src or dst) is copied.  The final blit rectangles are saved
slouken@0
   625
 * in 'srcrect' and 'dstrect' after all clipping is performed.
slouken@0
   626
 * If the blit is successful, it returns 0, otherwise it returns -1.
slouken@0
   627
 *
slouken@0
   628
 * The blit function should not be called on a locked surface.
slouken@0
   629
 *
slouken@0
   630
 * The blit semantics for surfaces with and without alpha and colorkey
slouken@0
   631
 * are defined as follows:
slouken@0
   632
 *
slouken@0
   633
 * RGBA->RGB:
slouken@0
   634
 *     SDL_SRCALPHA set:
slouken@0
   635
 * 	alpha-blend (using alpha-channel).
slouken@0
   636
 * 	SDL_SRCCOLORKEY ignored.
slouken@0
   637
 *     SDL_SRCALPHA not set:
slouken@0
   638
 * 	copy RGB.
slouken@0
   639
 * 	if SDL_SRCCOLORKEY set, only copy the pixels matching the
slouken@0
   640
 * 	RGB values of the source colour key, ignoring alpha in the
slouken@0
   641
 * 	comparison.
slouken@0
   642
 * 
slouken@0
   643
 * RGB->RGBA:
slouken@0
   644
 *     SDL_SRCALPHA set:
slouken@0
   645
 * 	alpha-blend (using the source per-surface alpha value);
slouken@0
   646
 * 	set destination alpha to opaque.
slouken@0
   647
 *     SDL_SRCALPHA not set:
slouken@0
   648
 * 	copy RGB, set destination alpha to opaque.
slouken@0
   649
 *     both:
slouken@0
   650
 * 	if SDL_SRCCOLORKEY set, only copy the pixels matching the
slouken@0
   651
 * 	source colour key.
slouken@0
   652
 * 
slouken@0
   653
 * RGBA->RGBA:
slouken@0
   654
 *     SDL_SRCALPHA set:
slouken@0
   655
 * 	alpha-blend (using the source alpha channel) the RGB values;
slouken@0
   656
 * 	leave destination alpha untouched. [Note: is this correct?]
slouken@0
   657
 * 	SDL_SRCCOLORKEY ignored.
slouken@0
   658
 *     SDL_SRCALPHA not set:
slouken@0
   659
 * 	copy all of RGBA to the destination.
slouken@0
   660
 * 	if SDL_SRCCOLORKEY set, only copy the pixels matching the
slouken@0
   661
 * 	RGB values of the source colour key, ignoring alpha in the
slouken@0
   662
 * 	comparison.
slouken@0
   663
 * 
slouken@0
   664
 * RGB->RGB: 
slouken@0
   665
 *     SDL_SRCALPHA set:
slouken@0
   666
 * 	alpha-blend (using the source per-surface alpha value).
slouken@0
   667
 *     SDL_SRCALPHA not set:
slouken@0
   668
 * 	copy RGB.
slouken@0
   669
 *     both:
slouken@0
   670
 * 	if SDL_SRCCOLORKEY set, only copy the pixels matching the
slouken@0
   671
 * 	source colour key.
slouken@0
   672
 *
slouken@0
   673
 * If either of the surfaces were in video memory, and the blit returns -2,
slouken@0
   674
 * the video memory was lost, so it should be reloaded with artwork and 
slouken@0
   675
 * re-blitted:
slouken@0
   676
	while ( SDL_BlitSurface(image, imgrect, screen, dstrect) == -2 ) {
slouken@0
   677
		while ( SDL_LockSurface(image) < 0 )
slouken@0
   678
			Sleep(10);
slouken@0
   679
		-- Write image pixels to image->pixels --
slouken@0
   680
		SDL_UnlockSurface(image);
slouken@0
   681
	}
slouken@0
   682
 * This happens under DirectX 5.0 when the system switches away from your
slouken@0
   683
 * fullscreen application.  The lock will also fail until you have access
slouken@0
   684
 * to the video memory again.
slouken@0
   685
 */
slouken@0
   686
/* You should call SDL_BlitSurface() unless you know exactly how SDL
slouken@0
   687
   blitting works internally and how to use the other blit functions.
slouken@0
   688
*/
slouken@0
   689
#define SDL_BlitSurface SDL_UpperBlit
slouken@0
   690
slouken@0
   691
/* This is the public blit function, SDL_BlitSurface(), and it performs
slouken@0
   692
   rectangle validation and clipping before passing it to SDL_LowerBlit()
slouken@0
   693
*/
slouken@337
   694
extern DECLSPEC int SDLCALL SDL_UpperBlit
slouken@0
   695
			(SDL_Surface *src, SDL_Rect *srcrect,
slouken@0
   696
			 SDL_Surface *dst, SDL_Rect *dstrect);
slouken@0
   697
/* This is a semi-private blit function and it performs low-level surface
slouken@0
   698
   blitting only.
slouken@0
   699
*/
slouken@337
   700
extern DECLSPEC int SDLCALL SDL_LowerBlit
slouken@0
   701
			(SDL_Surface *src, SDL_Rect *srcrect,
slouken@0
   702
			 SDL_Surface *dst, SDL_Rect *dstrect);
slouken@0
   703
slouken@0
   704
/*
slouken@0
   705
 * This function performs a fast fill of the given rectangle with 'color'
slouken@0
   706
 * The given rectangle is clipped to the destination surface clip area
slouken@0
   707
 * and the final fill rectangle is saved in the passed in pointer.
slouken@0
   708
 * If 'dstrect' is NULL, the whole surface will be filled with 'color'
slouken@0
   709
 * The color should be a pixel of the format used by the surface, and 
slouken@0
   710
 * can be generated by the SDL_MapRGB() function.
slouken@0
   711
 * This function returns 0 on success, or -1 on error.
slouken@0
   712
 */
slouken@337
   713
extern DECLSPEC int SDLCALL SDL_FillRect
slouken@0
   714
		(SDL_Surface *dst, SDL_Rect *dstrect, Uint32 color);
slouken@0
   715
slouken@0
   716
/* 
slouken@0
   717
 * This function takes a surface and copies it to a new surface of the
slouken@0
   718
 * pixel format and colors of the video framebuffer, suitable for fast
slouken@0
   719
 * blitting onto the display surface.  It calls SDL_ConvertSurface()
slouken@0
   720
 *
slouken@0
   721
 * If you want to take advantage of hardware colorkey or alpha blit
slouken@0
   722
 * acceleration, you should set the colorkey and alpha value before
slouken@0
   723
 * calling this function.
slouken@0
   724
 *
slouken@0
   725
 * If the conversion fails or runs out of memory, it returns NULL
slouken@0
   726
 */
slouken@337
   727
extern DECLSPEC SDL_Surface * SDLCALL SDL_DisplayFormat(SDL_Surface *surface);
slouken@0
   728
slouken@0
   729
/* 
slouken@0
   730
 * This function takes a surface and copies it to a new surface of the
slouken@0
   731
 * pixel format and colors of the video framebuffer (if possible),
slouken@0
   732
 * suitable for fast alpha blitting onto the display surface.
slouken@0
   733
 * The new surface will always have an alpha channel.
slouken@0
   734
 *
slouken@0
   735
 * If you want to take advantage of hardware colorkey or alpha blit
slouken@0
   736
 * acceleration, you should set the colorkey and alpha value before
slouken@0
   737
 * calling this function.
slouken@0
   738
 *
slouken@0
   739
 * If the conversion fails or runs out of memory, it returns NULL
slouken@0
   740
 */
slouken@337
   741
extern DECLSPEC SDL_Surface * SDLCALL SDL_DisplayFormatAlpha(SDL_Surface *surface);
slouken@0
   742
slouken@0
   743
slouken@0
   744
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
slouken@0
   745
/* YUV video surface overlay functions                                       */
slouken@0
   746
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
slouken@0
   747
slouken@0
   748
/* This function creates a video output overlay
slouken@0
   749
   Calling the returned surface an overlay is something of a misnomer because
slouken@0
   750
   the contents of the display surface underneath the area where the overlay
slouken@0
   751
   is shown is undefined - it may be overwritten with the converted YUV data.
slouken@0
   752
*/
slouken@337
   753
extern DECLSPEC SDL_Overlay * SDLCALL SDL_CreateYUVOverlay(int width, int height,
slouken@0
   754
				Uint32 format, SDL_Surface *display);
slouken@0
   755
slouken@0
   756
/* Lock an overlay for direct access, and unlock it when you are done */
slouken@337
   757
extern DECLSPEC int SDLCALL SDL_LockYUVOverlay(SDL_Overlay *overlay);
slouken@337
   758
extern DECLSPEC void SDLCALL SDL_UnlockYUVOverlay(SDL_Overlay *overlay);
slouken@0
   759
slouken@0
   760
/* Blit a video overlay to the display surface.
slouken@0
   761
   The contents of the video surface underneath the blit destination are
slouken@0
   762
   not defined.  
slouken@0
   763
   The width and height of the destination rectangle may be different from
slouken@0
   764
   that of the overlay, but currently only 2x scaling is supported.
slouken@0
   765
*/
slouken@337
   766
extern DECLSPEC int SDLCALL SDL_DisplayYUVOverlay(SDL_Overlay *overlay, SDL_Rect *dstrect);
slouken@0
   767
slouken@0
   768
/* Free a video overlay */
slouken@337
   769
extern DECLSPEC void SDLCALL SDL_FreeYUVOverlay(SDL_Overlay *overlay);
slouken@0
   770
slouken@0
   771
slouken@0
   772
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
slouken@0
   773
/* OpenGL support functions.                                                 */
slouken@0
   774
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
slouken@0
   775
slouken@0
   776
/*
slouken@0
   777
 * Dynamically load a GL driver, if SDL is built with dynamic GL.
slouken@0
   778
 *
slouken@0
   779
 * SDL links normally with the OpenGL library on your system by default,
slouken@0
   780
 * but you can compile it to dynamically load the GL driver at runtime.
slouken@0
   781
 * If you do this, you need to retrieve all of the GL functions used in
slouken@0
   782
 * your program from the dynamic library using SDL_GL_GetProcAddress().
slouken@0
   783
 *
slouken@0
   784
 * This is disabled in default builds of SDL.
slouken@0
   785
 */
slouken@337
   786
extern DECLSPEC int SDLCALL SDL_GL_LoadLibrary(const char *path);
slouken@0
   787
slouken@0
   788
/*
slouken@0
   789
 * Get the address of a GL function (for extension functions)
slouken@0
   790
 */
slouken@337
   791
extern DECLSPEC void * SDLCALL SDL_GL_GetProcAddress(const char* proc);
slouken@0
   792
slouken@0
   793
/*
slouken@0
   794
 * Set an attribute of the OpenGL subsystem before intialization.
slouken@0
   795
 */
slouken@337
   796
extern DECLSPEC int SDLCALL SDL_GL_SetAttribute(SDL_GLattr attr, int value);
slouken@0
   797
slouken@0
   798
/*
slouken@0
   799
 * Get an attribute of the OpenGL subsystem from the windowing
slouken@0
   800
 * interface, such as glX. This is of course different from getting
slouken@0
   801
 * the values from SDL's internal OpenGL subsystem, which only
slouken@0
   802
 * stores the values you request before initialization.
slouken@0
   803
 *
slouken@0
   804
 * Developers should track the values they pass into SDL_GL_SetAttribute
slouken@0
   805
 * themselves if they want to retrieve these values.
slouken@0
   806
 */
slouken@337
   807
extern DECLSPEC int SDLCALL SDL_GL_GetAttribute(SDL_GLattr attr, int* value);
slouken@0
   808
slouken@0
   809
/*
slouken@0
   810
 * Swap the OpenGL buffers, if double-buffering is supported.
slouken@0
   811
 */
slouken@337
   812
extern DECLSPEC void SDLCALL SDL_GL_SwapBuffers(void);
slouken@0
   813
slouken@0
   814
/*
slouken@0
   815
 * Internal functions that should not be called unless you have read
slouken@0
   816
 * and understood the source code for these functions.
slouken@0
   817
 */
slouken@337
   818
extern DECLSPEC void SDLCALL SDL_GL_UpdateRects(int numrects, SDL_Rect* rects);
slouken@337
   819
extern DECLSPEC void SDLCALL SDL_GL_Lock(void);
slouken@337
   820
extern DECLSPEC void SDLCALL SDL_GL_Unlock(void);
slouken@0
   821
slouken@0
   822
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
slouken@0
   823
/* These functions allow interaction with the window manager, if any.        */
slouken@0
   824
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
slouken@0
   825
slouken@0
   826
/*
slouken@0
   827
 * Sets/Gets the title and icon text of the display window
slouken@0
   828
 */
slouken@337
   829
extern DECLSPEC void SDLCALL SDL_WM_SetCaption(const char *title, const char *icon);
slouken@337
   830
extern DECLSPEC void SDLCALL SDL_WM_GetCaption(char **title, char **icon);
slouken@0
   831
slouken@0
   832
/*
slouken@0
   833
 * Sets the icon for the display window.
slouken@0
   834
 * This function must be called before the first call to SDL_SetVideoMode().
slouken@0
   835
 * It takes an icon surface, and a mask in MSB format.
slouken@0
   836
 * If 'mask' is NULL, the entire icon surface will be used as the icon.
slouken@0
   837
 */
slouken@337
   838
extern DECLSPEC void SDLCALL SDL_WM_SetIcon(SDL_Surface *icon, Uint8 *mask);
slouken@0
   839
slouken@0
   840
/*
slouken@0
   841
 * This function iconifies the window, and returns 1 if it succeeded.
slouken@0
   842
 * If the function succeeds, it generates an SDL_APPACTIVE loss event.
slouken@0
   843
 * This function is a noop and returns 0 in non-windowed environments.
slouken@0
   844
 */
slouken@337
   845
extern DECLSPEC int SDLCALL SDL_WM_IconifyWindow(void);
slouken@0
   846
slouken@0
   847
/*
slouken@0
   848
 * Toggle fullscreen mode without changing the contents of the screen.
slouken@0
   849
 * If the display surface does not require locking before accessing
slouken@0
   850
 * the pixel information, then the memory pointers will not change.
slouken@0
   851
 *
slouken@0
   852
 * If this function was able to toggle fullscreen mode (change from 
slouken@0
   853
 * running in a window to fullscreen, or vice-versa), it will return 1.
slouken@0
   854
 * If it is not implemented, or fails, it returns 0.
slouken@0
   855
 *
slouken@0
   856
 * The next call to SDL_SetVideoMode() will set the mode fullscreen
slouken@0
   857
 * attribute based on the flags parameter - if SDL_FULLSCREEN is not
slouken@0
   858
 * set, then the display will be windowed by default where supported.
slouken@0
   859
 *
slouken@0
   860
 * This is currently only implemented in the X11 video driver.
slouken@0
   861
 */
slouken@337
   862
extern DECLSPEC int SDLCALL SDL_WM_ToggleFullScreen(SDL_Surface *surface);
slouken@0
   863
slouken@0
   864
/*
slouken@0
   865
 * This function allows you to set and query the input grab state of
slouken@0
   866
 * the application.  It returns the new input grab state.
slouken@0
   867
 */
slouken@0
   868
typedef enum {
slouken@0
   869
	SDL_GRAB_QUERY = -1,
slouken@0
   870
	SDL_GRAB_OFF = 0,
slouken@0
   871
	SDL_GRAB_ON = 1,
slouken@0
   872
	SDL_GRAB_FULLSCREEN	/* Used internally */
slouken@0
   873
} SDL_GrabMode;
slouken@0
   874
/*
slouken@0
   875
 * Grabbing means that the mouse is confined to the application window,
slouken@0
   876
 * and nearly all keyboard input is passed directly to the application,
slouken@0
   877
 * and not interpreted by a window manager, if any.
slouken@0
   878
 */
slouken@337
   879
extern DECLSPEC SDL_GrabMode SDLCALL SDL_WM_GrabInput(SDL_GrabMode mode);
slouken@0
   880
slouken@47
   881
/* Not in public API at the moment - do not use! */
slouken@337
   882
extern DECLSPEC int SDLCALL SDL_SoftStretch(SDL_Surface *src, SDL_Rect *srcrect,
slouken@47
   883
                                    SDL_Surface *dst, SDL_Rect *dstrect);
slouken@47
   884
                    
slouken@0
   885
/* Ends C function definitions when using C++ */
slouken@0
   886
#ifdef __cplusplus
slouken@0
   887
}
slouken@0
   888
#endif
slouken@0
   889
#include "close_code.h"
slouken@0
   890
slouken@0
   891
#endif /* _SDL_video_h */