sdl-ios-xcode: include/SDL_surface.h annotate

annotate include/SDL_surface.h @ 2427:32b9909db651 gsoc2008_iphone

changed macro MAX_G_FORCE to SDL_IPHONE_MAX_GFORCE and moved it to the SDL_config_iphoneos.h file. This should allow users to convert between the Sint16 returned by polling the joystick and units of g-force, which better describe what is going on with the iPhone (and are what the iPhone OS actually gives you). This conversion wouldn't be necessary except that we'd need floating point to store everything as g-force.

author	Holmes Futrell <hfutrell@umail.ucsb.edu>
date	Fri, 15 Aug 2008 00:46:58 +0000
parents	12ea0fdc0df2
children	365fe1a2aad5

rev	line source
2275 12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	1 /*
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	2 SDL - Simple DirectMedia Layer
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	3 Copyright (C) 1997-2006 Sam Lantinga
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	4
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	5 This library is free software; you can redistribute it and/or
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	6 modify it under the terms of the GNU Lesser General Public
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	7 License as published by the Free Software Foundation; either
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	8 version 2.1 of the License, or (at your option) any later version.
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	9
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	10 This library is distributed in the hope that it will be useful,
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	13 Lesser General Public License for more details.
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	14
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	15 You should have received a copy of the GNU Lesser General Public
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	16 License along with this library; if not, write to the Free Software
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	17 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	18
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	19 Sam Lantinga
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	20 slouken@libsdl.org
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	21 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	22
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	23 /**
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	24 * \file SDL_surface.h
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	25 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	26 * Header file for SDL_surface definition and management functions
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	27 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	28
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	29 #ifndef _SDL_surface_h
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	30 #define _SDL_surface_h
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	31
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	32 #include "SDL_stdinc.h"
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	33 #include "SDL_pixels.h"
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	34 #include "SDL_rect.h"
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	35 #include "SDL_rwops.h"
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	36
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	37 #include "begin_code.h"
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	38 /* Set up for C function definitions, even when using C++ */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	39 #ifdef __cplusplus
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	40 /* INDENT-OFF */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	41 extern "C" {
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	42 /* INDENT-ON */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	43 #endif
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	44
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	45 /* These are the currently supported flags for the SDL_surface */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	46 /* Used internally (read-only) */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	47 #define SDL_PREALLOC 0x00000001 /* Surface uses preallocated memory */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	48 #define SDL_RLEACCEL 0x00000002 /* Surface is RLE encoded */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	49
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	50 /* Evaluates to true if the surface needs to be locked before access */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	51 #define SDL_MUSTLOCK(S) (((S)->flags & SDL_RLEACCEL) != 0)
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	52
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	53 /**
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	54 * \struct SDL_Surface
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	55 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	56 * \brief A collection of pixels used in software blitting
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	57 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	58 * \note This structure should be treated as read-only, except for 'pixels',
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	59 * which, if not NULL, contains the raw pixel data for the surface.
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	60 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	61 typedef struct SDL_Surface
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	62 {
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	63 Uint32 flags; /*< Read-only /
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	64 SDL_PixelFormat format; /< Read-only /
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	65 int w, h; /*< Read-only /
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	66 int pitch; /*< Read-only /
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	67 void pixels; /< Read-write /
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	68
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	69 /* Application data associated with the surfade */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	70 void userdata; /< Read-write /
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	71
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	72 /* information needed for surfaces requiring locks */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	73 int locked; /*< Read-only /
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	74 void lock_data; /< Read-only /
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	75
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	76 /* clipping information */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	77 SDL_Rect clip_rect; /*< Read-only /
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	78
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	79 /* info for fast blit mapping to other surfaces */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	80 struct SDL_BlitMap map; /< Private /
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	81
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	82 /* format version, bumped at every change to invalidate blit maps */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	83 unsigned int format_version; /*< Private /
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	84
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	85 /* Reference count -- used when freeing surface */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	86 int refcount; /*< Read-mostly /
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	87 } SDL_Surface;
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	88
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	89 /**
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	90 * \typedef SDL_blit
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	91 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	92 * \brief The type of function used for surface blitting functions
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	93 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	94 typedef int (SDL_blit) (struct SDL_Surface src, SDL_Rect * srcrect,
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	95 struct SDL_Surface * dst, SDL_Rect * dstrect);
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	96
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	97 /*
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	98 * Allocate and free an RGB surface (must be called after SDL_SetVideoMode)
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	99 * If the depth is 4 or 8 bits, an empty palette is allocated for the surface.
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	100 * If the depth is greater than 8 bits, the pixel format is set using the
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	101 * flags '[RGB]mask'.
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	102 * If the function runs out of memory, it will return NULL.
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	103 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	104 * The 'flags' tell what kind of surface to create.
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	105 * SDL_SRCCOLORKEY indicates that the surface will be used for colorkey blits.
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	106 * SDL_SRCALPHA means that the surface will be used for alpha blits.
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	107 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	108 extern DECLSPEC SDL_Surface *SDLCALL SDL_CreateRGBSurface
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	109 (Uint32 flags, int width, int height, int depth,
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	110 Uint32 Rmask, Uint32 Gmask, Uint32 Bmask, Uint32 Amask);
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	111 extern DECLSPEC SDL_Surface SDLCALL SDL_CreateRGBSurfaceFrom(void pixels,
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	112 int width,
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	113 int height,
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	114 int depth,
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	115 int pitch,
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	116 Uint32 Rmask,
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	117 Uint32 Gmask,
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	118 Uint32 Bmask,
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	119 Uint32 Amask);
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	120 extern DECLSPEC void SDLCALL SDL_FreeSurface(SDL_Surface * surface);
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	121
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	122 /**
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	123 * \fn int SDL_SetSurfacePalette(SDL_Surface surface, SDL_Palette palette)
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	124 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	125 * \brief Set the palette used by a surface.
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	126 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	127 * \return 0, or -1 if the surface format doesn't use a palette.
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	128 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	129 * \note A single palette can be shared with many surfaces.
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	130 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	131 extern DECLSPEC int SDLCALL SDL_SetSurfacePalette(SDL_Surface * surface,
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	132 SDL_Palette * palette);
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	133
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	134 /*
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	135 * SDL_LockSurface() sets up a surface for directly accessing the pixels.
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	136 * Between calls to SDL_LockSurface()/SDL_UnlockSurface(), you can write
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	137 * to and read from 'surface->pixels', using the pixel format stored in
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	138 * 'surface->format'. Once you are done accessing the surface, you should
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	139 * use SDL_UnlockSurface() to release it.
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	140 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	141 * Not all surfaces require locking. If SDL_MUSTLOCK(surface) evaluates
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	142 * to 0, then you can read and write to the surface at any time, and the
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	143 * pixel format of the surface will not change.
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	144 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	145 * No operating system or library calls should be made between lock/unlock
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	146 * pairs, as critical system locks may be held during this time.
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	147 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	148 * SDL_LockSurface() returns 0, or -1 if the surface couldn't be locked.
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	149 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	150 extern DECLSPEC int SDLCALL SDL_LockSurface(SDL_Surface * surface);
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	151 extern DECLSPEC void SDLCALL SDL_UnlockSurface(SDL_Surface * surface);
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	152
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	153 /*
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	154 * Load a surface from a seekable SDL data source (memory or file.)
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	155 * If 'freesrc' is non-zero, the source will be closed after being read.
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	156 * Returns the new surface, or NULL if there was an error.
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	157 * The new surface should be freed with SDL_FreeSurface().
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	158 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	159 extern DECLSPEC SDL_Surface SDLCALL SDL_LoadBMP_RW(SDL_RWops src,
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	160 int freesrc);
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	161
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	162 /* Convenience macro -- load a surface from a file */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	163 #define SDL_LoadBMP(file) SDL_LoadBMP_RW(SDL_RWFromFile(file, "rb"), 1)
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	164
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	165 /*
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	166 * Save a surface to a seekable SDL data source (memory or file.)
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	167 * If 'freedst' is non-zero, the source will be closed after being written.
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	168 * Returns 0 if successful or -1 if there was an error.
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	169 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	170 extern DECLSPEC int SDLCALL SDL_SaveBMP_RW
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	171 (SDL_Surface * surface, SDL_RWops * dst, int freedst);
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	172
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	173 /* Convenience macro -- save a surface to a file */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	174 #define SDL_SaveBMP(surface, file) \
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	175 SDL_SaveBMP_RW(surface, SDL_RWFromFile(file, "wb"), 1)
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	176
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	177 /*
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	178 * \fn int SDL_SetSurfaceRLE(SDL_Surface *surface, int flag)
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	179 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	180 * \brief Sets the RLE acceleration hint for a surface.
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	181 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	182 * \return 0 on success, or -1 if the surface is not valid
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	183 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	184 * \note If RLE is enabled, colorkey and alpha blending blits are much faster,
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	185 * but the surface must be locked before directly accessing the pixels.
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	186 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	187 extern DECLSPEC int SDLCALL SDL_SetSurfaceRLE(SDL_Surface * surface,
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	188 int flag);
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	189
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	190 /*
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	191 * \fn int SDL_SetColorKey(SDL_Surface *surface, Uint32 flag, Uint32 key)
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	192 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	193 * \brief Sets the color key (transparent pixel) in a blittable surface.
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	194 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	195 * \param surface The surface to update
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	196 * \param flag Non-zero to enable colorkey and 0 to disable colorkey
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	197 * \param key The transparent pixel in the native surface format
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	198 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	199 * \return 0 on success, or -1 if the surface is not valid
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	200 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	201 extern DECLSPEC int SDLCALL SDL_SetColorKey(SDL_Surface * surface,
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	202 Uint32 flag, Uint32 key);
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	203
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	204 /**
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	205 * \fn int SDL_SetSurfaceColorMod(SDL_Surface *surface, Uint8 r, Uint8 g, Uint8 b)
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	206 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	207 * \brief Set an additional color value used in blit operations
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	208 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	209 * \param surface The surface to update
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	210 * \param r The red source color value multiplied into blit operations
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	211 * \param g The green source color value multiplied into blit operations
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	212 * \param b The blue source color value multiplied into blit operations
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	213 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	214 * \return 0 on success, or -1 if the surface is not valid
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	215 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	216 * \sa SDL_GetSurfaceColorMod()
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	217 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	218 extern DECLSPEC int SDLCALL SDL_SetSurfaceColorMod(SDL_Surface * surface,
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	219 Uint8 r, Uint8 g, Uint8 b);
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	220
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	221
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	222 /**
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	223 * \fn int SDL_GetSurfaceColorMod(SDL_Surface surface, Uint8 r, Uint8 g, Uint8 b)
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	224 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	225 * \brief Get the additional color value used in blit operations
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	226 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	227 * \param surface The surface to query
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	228 * \param r A pointer filled in with the source red color value
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	229 * \param g A pointer filled in with the source green color value
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	230 * \param b A pointer filled in with the source blue color value
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	231 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	232 * \return 0 on success, or -1 if the surface is not valid
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	233 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	234 * \sa SDL_SetSurfaceColorMod()
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	235 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	236 extern DECLSPEC int SDLCALL SDL_GetSurfaceColorMod(SDL_Surface * surface,
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	237 Uint8 * r, Uint8 * g,
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	238 Uint8 * b);
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	239
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	240 /**
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	241 * \fn int SDL_SetSurfaceAlphaMod(SDL_Surface *surface, Uint8 alpha)
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	242 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	243 * \brief Set an additional alpha value used in blit operations
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	244 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	245 * \param surface The surface to update
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	246 * \param alpha The source alpha value multiplied into blit operations.
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	247 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	248 * \return 0 on success, or -1 if the surface is not valid
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	249 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	250 * \sa SDL_GetSurfaceAlphaMod()
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	251 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	252 extern DECLSPEC int SDLCALL SDL_SetSurfaceAlphaMod(SDL_Surface * surface,
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	253 Uint8 alpha);
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	254
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	255 /**
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	256 * \fn int SDL_GetSurfaceAlphaMod(SDL_Surface surface, Uint8 alpha)
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	257 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	258 * \brief Get the additional alpha value used in blit operations
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	259 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	260 * \param surface The surface to query
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	261 * \param alpha A pointer filled in with the source alpha value
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	262 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	263 * \return 0 on success, or -1 if the surface is not valid
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	264 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	265 * \sa SDL_SetSurfaceAlphaMod()
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	266 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	267 extern DECLSPEC int SDLCALL SDL_GetSurfaceAlphaMod(SDL_Surface * surface,
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	268 Uint8 * alpha);
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	269
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	270 /**
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	271 * \fn int SDL_SetSurfaceBlendMode(SDL_Surface *surface, int blendMode)
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	272 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	273 * \brief Set the blend mode used for blit operations
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	274 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	275 * \param surface The surface to update
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	276 * \param blendMode SDL_TextureBlendMode to use for blit blending
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	277 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	278 * \return 0 on success, or -1 if the parameters are not valid
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	279 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	280 * \sa SDL_GetSurfaceBlendMode()
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	281 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	282 extern DECLSPEC int SDLCALL SDL_SetSurfaceBlendMode(SDL_Surface * surface,
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	283 int blendMode);
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	284
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	285 /**
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	286 * \fn int SDL_GetSurfaceBlendMode(SDL_Surface surface, int blendMode)
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	287 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	288 * \brief Get the blend mode used for blit operations
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	289 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	290 * \param surface The surface to query
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	291 * \param blendMode A pointer filled in with the current blend mode
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	292 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	293 * \return 0 on success, or -1 if the surface is not valid
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	294 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	295 * \sa SDL_SetSurfaceBlendMode()
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	296 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	297 extern DECLSPEC int SDLCALL SDL_GetSurfaceBlendMode(SDL_Surface * surface,
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	298 int *blendMode);
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	299
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	300 /**
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	301 * \fn int SDL_SetSurfaceScaleMode(SDL_Surface *surface, int scaleMode)
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	302 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	303 * \brief Set the scale mode used for blit operations
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	304 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	305 * \param surface The surface to update
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	306 * \param scaleMode SDL_TextureScaleMode to use for blit scaling
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	307 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	308 * \return 0 on success, or -1 if the surface is not valid or the scale mode is not supported
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	309 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	310 * \note If the scale mode is not supported, the closest supported mode is chosen. Currently only SDL_TEXTURESCALEMODE_FAST is supported on surfaces.
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	311 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	312 * \sa SDL_GetSurfaceScaleMode()
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	313 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	314 extern DECLSPEC int SDLCALL SDL_SetSurfaceScaleMode(SDL_Surface * surface,
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	315 int scaleMode);
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	316
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	317 /**
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	318 * \fn int SDL_GetSurfaceScaleMode(SDL_Surface surface, int scaleMode)
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	319 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	320 * \brief Get the scale mode used for blit operations
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	321 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	322 * \param surface The surface to query
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	323 * \param scaleMode A pointer filled in with the current scale mode
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	324 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	325 * \return 0 on success, or -1 if the surface is not valid
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	326 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	327 * \sa SDL_SetSurfaceScaleMode()
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	328 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	329 extern DECLSPEC int SDLCALL SDL_GetSurfaceScaleMode(SDL_Surface * surface,
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	330 int *scaleMode);
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	331
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	332 /*
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	333 * Sets the clipping rectangle for the destination surface in a blit.
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	334 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	335 * If the clip rectangle is NULL, clipping will be disabled.
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	336 * If the clip rectangle doesn't intersect the surface, the function will
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	337 * return SDL_FALSE and blits will be completely clipped. Otherwise the
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	338 * function returns SDL_TRUE and blits to the surface will be clipped to
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	339 * the intersection of the surface area and the clipping rectangle.
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	340 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	341 * Note that blits are automatically clipped to the edges of the source
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	342 * and destination surfaces.
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	343 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	344 extern DECLSPEC SDL_bool SDLCALL SDL_SetClipRect(SDL_Surface * surface,
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	345 const SDL_Rect * rect);
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	346
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	347 /*
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	348 * Gets the clipping rectangle for the destination surface in a blit.
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	349 * 'rect' must be a pointer to a valid rectangle which will be filled
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	350 * with the correct values.
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	351 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	352 extern DECLSPEC void SDLCALL SDL_GetClipRect(SDL_Surface * surface,
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	353 SDL_Rect * rect);
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	354
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	355 /*
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	356 * Creates a new surface of the specified format, and then copies and maps
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	357 * the given surface to it so the blit of the converted surface will be as
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	358 * fast as possible. If this function fails, it returns NULL.
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	359 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	360 * The 'flags' parameter is passed to SDL_CreateRGBSurface() and has those
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	361 * semantics. You can also pass SDL_RLEACCEL in the flags parameter and
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	362 * SDL will try to RLE accelerate colorkey and alpha blits in the resulting
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	363 * surface.
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	364 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	365 * This function is used internally by SDL_DisplayFormat().
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	366 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	367 extern DECLSPEC SDL_Surface *SDLCALL SDL_ConvertSurface
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	368 (SDL_Surface * src, SDL_PixelFormat * fmt, Uint32 flags);
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	369
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	370 /*
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	371 * This function performs a fast fill of the given rectangle with 'color'
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	372 * The given rectangle is clipped to the destination surface clip area
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	373 * and the final fill rectangle is saved in the passed in pointer.
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	374 * If 'dstrect' is NULL, the whole surface will be filled with 'color'
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	375 * The color should be a pixel of the format used by the surface, and
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	376 * can be generated by the SDL_MapRGB() function.
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	377 * This function returns 0 on success, or -1 on error.
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	378 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	379 extern DECLSPEC int SDLCALL SDL_FillRect
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	380 (SDL_Surface * dst, SDL_Rect * dstrect, Uint32 color);
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	381
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	382 /*
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	383 * This performs a fast blit from the source surface to the destination
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	384 * surface. It assumes that the source and destination rectangles are
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	385 * the same size. If either 'srcrect' or 'dstrect' are NULL, the entire
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	386 * surface (src or dst) is copied. The final blit rectangles are saved
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	387 * in 'srcrect' and 'dstrect' after all clipping is performed.
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	388 * If the blit is successful, it returns 0, otherwise it returns -1.
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	389 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	390 * The blit function should not be called on a locked surface.
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	391 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	392 * The blit semantics for surfaces with and without alpha and colorkey
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	393 * are defined as follows:
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	394 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	395 * RGBA->RGB:
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	396 * SDL_SRCALPHA set:
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	397 * alpha-blend (using alpha-channel).
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	398 * SDL_SRCCOLORKEY ignored.
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	399 * SDL_SRCALPHA not set:
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	400 * copy RGB.
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	401 * if SDL_SRCCOLORKEY set, only copy the pixels matching the
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	402 * RGB values of the source colour key, ignoring alpha in the
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	403 * comparison.
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	404 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	405 * RGB->RGBA:
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	406 * SDL_SRCALPHA set:
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	407 * alpha-blend (using the source per-surface alpha value);
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	408 * set destination alpha to opaque.
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	409 * SDL_SRCALPHA not set:
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	410 * copy RGB, set destination alpha to source per-surface alpha value.
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	411 * both:
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	412 * if SDL_SRCCOLORKEY set, only copy the pixels matching the
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	413 * source colour key.
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	414 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	415 * RGBA->RGBA:
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	416 * SDL_SRCALPHA set:
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	417 * alpha-blend (using the source alpha channel) the RGB values;
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	418 * leave destination alpha untouched. [Note: is this correct?]
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	419 * SDL_SRCCOLORKEY ignored.
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	420 * SDL_SRCALPHA not set:
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	421 * copy all of RGBA to the destination.
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	422 * if SDL_SRCCOLORKEY set, only copy the pixels matching the
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	423 * RGB values of the source colour key, ignoring alpha in the
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	424 * comparison.
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	425 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	426 * RGB->RGB:
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	427 * SDL_SRCALPHA set:
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	428 * alpha-blend (using the source per-surface alpha value).
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	429 * SDL_SRCALPHA not set:
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	430 * copy RGB.
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	431 * both:
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	432 * if SDL_SRCCOLORKEY set, only copy the pixels matching the
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	433 * source colour key.
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	434 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	435 * If either of the surfaces were in video memory, and the blit returns -2,
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	436 * the video memory was lost, so it should be reloaded with artwork and
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	437 * re-blitted:
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	438 while ( SDL_BlitSurface(image, imgrect, screen, dstrect) == -2 ) {
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	439 while ( SDL_LockSurface(image) < 0 )
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	440 Sleep(10);
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	441 -- Write image pixels to image->pixels --
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	442 SDL_UnlockSurface(image);
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	443 }
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	444 * This happens under DirectX 5.0 when the system switches away from your
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	445 * fullscreen application. The lock will also fail until you have access
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	446 * to the video memory again.
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	447 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	448 /* You should call SDL_BlitSurface() unless you know exactly how SDL
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	449 blitting works internally and how to use the other blit functions.
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	450 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	451 #define SDL_BlitSurface SDL_UpperBlit
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	452
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	453 /* This is the public blit function, SDL_BlitSurface(), and it performs
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	454 rectangle validation and clipping before passing it to SDL_LowerBlit()
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	455 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	456 extern DECLSPEC int SDLCALL SDL_UpperBlit
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	457 (SDL_Surface * src, SDL_Rect * srcrect,
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	458 SDL_Surface * dst, SDL_Rect * dstrect);
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	459 /* This is a semi-private blit function and it performs low-level surface
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	460 blitting only.
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	461 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	462 extern DECLSPEC int SDLCALL SDL_LowerBlit
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	463 (SDL_Surface * src, SDL_Rect * srcrect,
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	464 SDL_Surface * dst, SDL_Rect * dstrect);
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	465
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	466 /**
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	467 * \fn int SDL_SoftStretch(SDL_Surface * src, SDL_Rect * srcrect, SDL_Surface * dst, SDL_Rect * dstrect)
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	468 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	469 * \brief Perform a fast, low quality, stretch blit between two surfaces of the same pixel format.
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	470 *
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	471 * \note This function uses a static buffer, and is not thread-safe.
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	472 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	473 extern DECLSPEC int SDLCALL SDL_SoftStretch(SDL_Surface * src,
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	474 SDL_Rect * srcrect,
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	475 SDL_Surface * dst,
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	476 SDL_Rect * dstrect);
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	477
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	478 /* Ends C function definitions when using C++ */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	479 #ifdef __cplusplus
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	480 /* INDENT-OFF */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	481 }
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	482 /* INDENT-ON */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	483 #endif
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	484 #include "close_code.h"
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	485
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	486 #endif /* _SDL_surface_h */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	487
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	488 /* vi: set ts=4 sw=4 expandtab: */

Mercurial > sdl-ios-xcode

annotate include/SDL_surface.h @ 2427:32b9909db651 gsoc2008_iphone