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