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

annotate include/SDL_surface.h @ 5282:8e421890cdb8

Fixed bug #1117 There's a new event that's always sent when the window changes size, and that event is what the renderers listen for to determine if they need to rebind their context.

author	Sam Lantinga <slouken@libsdl.org>
date	Sat, 12 Feb 2011 19:02:14 -0800
parents	b530ef003506
children

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
5267 b530ef003506 Happy 2011! :) Sam Lantinga <slouken@libsdl.org> parents: 5246 diff changeset	3 Copyright (C) 1997-2011 Sam Lantinga
2275 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 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	24 * \file SDL_surface.h
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	25 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	26 * Header file for ::SDL_surface definition and management functions.
2275 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"
4929 aa8888658021 Use the enumerated type for blend and scale mode instead of int Sam Lantinga <slouken@libsdl.org> parents: 4424 diff changeset	35 #include "SDL_blendmode.h"
2275 12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	36 #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	37
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	38 #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	39 /* 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	40 #ifdef __cplusplus
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	41 /* INDENT-OFF */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	42 extern "C" {
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	43 /* INDENT-ON */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	44 #endif
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	45
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	46 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	47 * \name Surface flags
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	48 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	49 * These are the currently supported flags for the ::SDL_surface.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	50 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	51 * \internal
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	52 * Used internally (read-only).
3341 710139a1692d Fixed bug #826 Sam Lantinga <slouken@libsdl.org> parents: 3103 diff changeset	53 */
710139a1692d Fixed bug #826 Sam Lantinga <slouken@libsdl.org> parents: 3103 diff changeset	54 /@{/
710139a1692d Fixed bug #826 Sam Lantinga <slouken@libsdl.org> parents: 3103 diff changeset	55 #define SDL_PREALLOC 0x00000001 /*< Surface uses preallocated memory /
710139a1692d Fixed bug #826 Sam Lantinga <slouken@libsdl.org> parents: 3103 diff changeset	56 #define SDL_RLEACCEL 0x00000002 /*< Surface is RLE encoded /
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	57 /@}//Surface flags/
2275 12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	58
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	59 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	60 * Evaluates to true if the surface needs to be locked before access.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	61 */
2275 12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	62 #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	63
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	64 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	65 * \brief A collection of pixels used in software blitting.
2275 12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	66 *
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	67 * \note This structure should be treated as read-only, except for \c pixels,
2275 12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	68 * 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	69 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	70 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	71 {
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	72 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	73 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	74 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	75 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	76 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	77
3708 d3f7cf8b0db0 Fixed typo in the comment Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	78 /** Application data associated with the surface */
2275 12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	79 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	80
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	81 /** information needed for surfaces requiring locks */
2275 12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	82 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	83 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	84
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	85 /** clipping information */
2275 12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	86 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	87
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	88 /** info for fast blit mapping to other surfaces */
2275 12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	89 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	90
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	91 /** format version, bumped at every change to invalidate blit maps */
4929 aa8888658021 Use the enumerated type for blend and scale mode instead of int Sam Lantinga <slouken@libsdl.org> parents: 4424 diff changeset	92 int format_version; /*< Private /
2275 12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	93
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	94 /** Reference count -- used when freeing surface */
2275 12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	95 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	96 } SDL_Surface;
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 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	99 * \brief The type of function used for surface blitting functions.
2275 12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	100 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	101 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	102 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	103
3341 710139a1692d Fixed bug #826 Sam Lantinga <slouken@libsdl.org> parents: 3103 diff changeset	104 /**
4424 274743af0430 Removed reference to compatibility function Sam Lantinga <slouken@libsdl.org> parents: 3709 diff changeset	105 * Allocate and free an RGB surface.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	106 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	107 * If the depth is 4 or 8 bits, an empty palette is allocated for the surface.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	108 * If the depth is greater than 8 bits, the pixel format is set using the
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	109 * flags '[RGB]mask'.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	110 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	111 * If the function runs out of memory, it will return NULL.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	112 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	113 * \param flags The \c flags are obsolete and should be set to 0.
2275 12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	114 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	115 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	116 (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	117 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	118 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	119 int width,
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	120 int height,
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	121 int depth,
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	122 int pitch,
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	123 Uint32 Rmask,
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	124 Uint32 Gmask,
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	125 Uint32 Bmask,
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	126 Uint32 Amask);
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	127 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	128
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	129 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	130 * \brief Set the palette used by a surface.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	131 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	132 * \return 0, or -1 if the surface format doesn't use a palette.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	133 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	134 * \note A single palette can be shared with many surfaces.
2275 12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	135 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	136 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	137 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	138
3341 710139a1692d Fixed bug #826 Sam Lantinga <slouken@libsdl.org> parents: 3103 diff changeset	139 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	140 * \brief Sets up a surface for directly accessing the pixels.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	141 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	142 * Between calls to SDL_LockSurface() / SDL_UnlockSurface(), you can write
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	143 * to and read from \c surface->pixels, using the pixel format stored in
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	144 * \c surface->format. Once you are done accessing the surface, you should
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	145 * use SDL_UnlockSurface() to release it.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	146 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	147 * Not all surfaces require locking. If SDL_MUSTLOCK(surface) evaluates
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	148 * to 0, then you can read and write to the surface at any time, and the
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	149 * pixel format of the surface will not change.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	150 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	151 * No operating system or library calls should be made between lock/unlock
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	152 * pairs, as critical system locks may be held during this time.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	153 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	154 * SDL_LockSurface() returns 0, or -1 if the surface couldn't be locked.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	155 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	156 * \sa SDL_UnlockSurface()
2275 12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	157 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	158 extern DECLSPEC int SDLCALL SDL_LockSurface(SDL_Surface * surface);
3341 710139a1692d Fixed bug #826 Sam Lantinga <slouken@libsdl.org> parents: 3103 diff changeset	159 /** \sa SDL_LockSurface() */
2275 12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	160 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	161
3341 710139a1692d Fixed bug #826 Sam Lantinga <slouken@libsdl.org> parents: 3103 diff changeset	162 /**
4971 158bb5752974 Updated headers to match wiki documentation Sam Lantinga <slouken@libsdl.org> parents: 4949 diff changeset	163 * Load a surface from a seekable SDL data stream (memory or file).
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	164 *
4971 158bb5752974 Updated headers to match wiki documentation Sam Lantinga <slouken@libsdl.org> parents: 4949 diff changeset	165 * If \c freesrc is non-zero, the stream will be closed after being read.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	166 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	167 * The new surface should be freed with SDL_FreeSurface().
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	168 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	169 * \return the new surface, or NULL if there was an error.
2275 12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	170 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	171 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	172 int freesrc);
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	173
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	174 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	175 * Load a surface from a file.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	176 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	177 * Convenience macro.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	178 */
2275 12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	179 #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	180
3341 710139a1692d Fixed bug #826 Sam Lantinga <slouken@libsdl.org> parents: 3103 diff changeset	181 /**
4971 158bb5752974 Updated headers to match wiki documentation Sam Lantinga <slouken@libsdl.org> parents: 4949 diff changeset	182 * Save a surface to a seekable SDL data stream (memory or file).
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	183 *
4971 158bb5752974 Updated headers to match wiki documentation Sam Lantinga <slouken@libsdl.org> parents: 4949 diff changeset	184 * If \c freedst is non-zero, the stream will be closed after being written.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	185 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	186 * \return 0 if successful or -1 if there was an error.
2275 12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	187 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	188 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	189 (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	190
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	191 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	192 * Save a surface to a file.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	193 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	194 * Convenience macro.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	195 */
2275 12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	196 #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	197 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	198
3341 710139a1692d Fixed bug #826 Sam Lantinga <slouken@libsdl.org> parents: 3103 diff changeset	199 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	200 * \brief Sets the RLE acceleration hint for a surface.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	201 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	202 * \return 0 on success, or -1 if the surface is not valid
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	203 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	204 * \note If RLE is enabled, colorkey and alpha blending blits are much faster,
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	205 * but the surface must be locked before directly accessing the pixels.
2275 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 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	208 int flag);
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	209
3341 710139a1692d Fixed bug #826 Sam Lantinga <slouken@libsdl.org> parents: 3103 diff changeset	210 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	211 * \brief Sets the color key (transparent pixel) in a blittable surface.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	212 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	213 * \param surface The surface to update
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	214 * \param flag Non-zero to enable colorkey and 0 to disable colorkey
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	215 * \param key The transparent pixel in the native surface format
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	216 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	217 * \return 0 on success, or -1 if the surface is not valid
2275 12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	218 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	219 extern DECLSPEC int SDLCALL SDL_SetColorKey(SDL_Surface * surface,
3560 5543db4239e6 The SDL 1.3 tests have been cleaned up not to include any 1.2 compatibility code. Sam Lantinga <slouken@libsdl.org> parents: 3550 diff changeset	220 int flag, Uint32 key);
2275 12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	221
3341 710139a1692d Fixed bug #826 Sam Lantinga <slouken@libsdl.org> parents: 3103 diff changeset	222 /**
3550 6b69c5def097 Minor documentation fix Sam Lantinga <slouken@libsdl.org> parents: 3536 diff changeset	223 * \brief Gets the color key (transparent pixel) in a blittable surface.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	224 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	225 * \param surface The surface to update
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	226 * \param key A pointer filled in with the transparent pixel in the native
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	227 * surface format
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	228 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	229 * \return 0 on success, or -1 if the surface is not valid or colorkey is not
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	230 * enabled.
3103 7be21a78777e Added SDL_GetColorKey() Sam Lantinga <slouken@libsdl.org> parents: 3026 diff changeset	231 */
7be21a78777e Added SDL_GetColorKey() Sam Lantinga <slouken@libsdl.org> parents: 3026 diff changeset	232 extern DECLSPEC int SDLCALL SDL_GetColorKey(SDL_Surface * surface,
7be21a78777e Added SDL_GetColorKey() Sam Lantinga <slouken@libsdl.org> parents: 3026 diff changeset	233 Uint32 * key);
7be21a78777e Added SDL_GetColorKey() Sam Lantinga <slouken@libsdl.org> parents: 3026 diff changeset	234
2275 12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	235 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	236 * \brief Set an additional color value used in blit operations.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	237 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	238 * \param surface The surface to update.
4971 158bb5752974 Updated headers to match wiki documentation Sam Lantinga <slouken@libsdl.org> parents: 4949 diff changeset	239 * \param r The red color value multiplied into blit operations.
158bb5752974 Updated headers to match wiki documentation Sam Lantinga <slouken@libsdl.org> parents: 4949 diff changeset	240 * \param g The green color value multiplied into blit operations.
158bb5752974 Updated headers to match wiki documentation Sam Lantinga <slouken@libsdl.org> parents: 4949 diff changeset	241 * \param b The blue color value multiplied into blit operations.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	242 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	243 * \return 0 on success, or -1 if the surface is not valid.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	244 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	245 * \sa SDL_GetSurfaceColorMod()
2275 12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	246 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	247 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	248 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	249
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	250
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	251 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	252 * \brief Get the additional color value used in blit operations.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	253 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	254 * \param surface The surface to query.
4971 158bb5752974 Updated headers to match wiki documentation Sam Lantinga <slouken@libsdl.org> parents: 4949 diff changeset	255 * \param r A pointer filled in with the current red color value.
158bb5752974 Updated headers to match wiki documentation Sam Lantinga <slouken@libsdl.org> parents: 4949 diff changeset	256 * \param g A pointer filled in with the current green color value.
158bb5752974 Updated headers to match wiki documentation Sam Lantinga <slouken@libsdl.org> parents: 4949 diff changeset	257 * \param b A pointer filled in with the current blue color value.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	258 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	259 * \return 0 on success, or -1 if the surface is not valid.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	260 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	261 * \sa SDL_SetSurfaceColorMod()
2275 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 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	264 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	265 Uint8 * b);
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 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	268 * \brief Set an additional alpha value used in blit operations.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	269 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	270 * \param surface The surface to update.
4971 158bb5752974 Updated headers to match wiki documentation Sam Lantinga <slouken@libsdl.org> parents: 4949 diff changeset	271 * \param alpha The alpha value multiplied into blit operations.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	272 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	273 * \return 0 on success, or -1 if the surface is not valid.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	274 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	275 * \sa SDL_GetSurfaceAlphaMod()
2275 12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	276 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	277 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	278 Uint8 alpha);
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 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	281 * \brief Get the additional alpha value used in blit operations.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	282 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	283 * \param surface The surface to query.
4971 158bb5752974 Updated headers to match wiki documentation Sam Lantinga <slouken@libsdl.org> parents: 4949 diff changeset	284 * \param alpha A pointer filled in with the current alpha value.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	285 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	286 * \return 0 on success, or -1 if the surface is not valid.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	287 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	288 * \sa SDL_SetSurfaceAlphaMod()
2275 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 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	291 Uint8 * alpha);
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 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	294 * \brief Set the blend mode used for blit operations.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	295 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	296 * \param surface The surface to update.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	297 * \param blendMode ::SDL_BlendMode to use for blit blending.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	298 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	299 * \return 0 on success, or -1 if the parameters are not valid.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	300 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	301 * \sa SDL_GetSurfaceBlendMode()
2275 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 extern DECLSPEC int SDLCALL SDL_SetSurfaceBlendMode(SDL_Surface * surface,
4929 aa8888658021 Use the enumerated type for blend and scale mode instead of int Sam Lantinga <slouken@libsdl.org> parents: 4424 diff changeset	304 SDL_BlendMode blendMode);
2275 12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	305
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	306 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	307 * \brief Get the blend mode used for blit operations.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	308 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	309 * \param surface The surface to query.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	310 * \param blendMode A pointer filled in with the current blend mode.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	311 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	312 * \return 0 on success, or -1 if the surface is not valid.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	313 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	314 * \sa SDL_SetSurfaceBlendMode()
2275 12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	315 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	316 extern DECLSPEC int SDLCALL SDL_GetSurfaceBlendMode(SDL_Surface * surface,
4929 aa8888658021 Use the enumerated type for blend and scale mode instead of int Sam Lantinga <slouken@libsdl.org> parents: 4424 diff changeset	317 SDL_BlendMode *blendMode);
2275 12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	318
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	319 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	320 * Sets the clipping rectangle for the destination surface in a blit.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	321 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	322 * If the clip rectangle is NULL, clipping will be disabled.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	323 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	324 * If the clip rectangle doesn't intersect the surface, the function will
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	325 * return SDL_FALSE and blits will be completely clipped. Otherwise the
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	326 * function returns SDL_TRUE and blits to the surface will be clipped to
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	327 * the intersection of the surface area and the clipping rectangle.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	328 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	329 * Note that blits are automatically clipped to the edges of the source
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	330 * and destination surfaces.
2275 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 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	333 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	334
3341 710139a1692d Fixed bug #826 Sam Lantinga <slouken@libsdl.org> parents: 3103 diff changeset	335 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	336 * Gets the clipping rectangle for the destination surface in a blit.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	337 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	338 * \c rect must be a pointer to a valid rectangle which will be filled
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	339 * with the correct values.
2275 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 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	342 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	343
3341 710139a1692d Fixed bug #826 Sam Lantinga <slouken@libsdl.org> parents: 3103 diff changeset	344 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	345 * Creates a new surface of the specified format, and then copies and maps
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	346 * the given surface to it so the blit of the converted surface will be as
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	347 * fast as possible. If this function fails, it returns NULL.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	348 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	349 * The \c flags parameter is passed to SDL_CreateRGBSurface() and has those
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	350 * semantics. You can also pass ::SDL_RLEACCEL in the flags parameter and
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	351 * SDL will try to RLE accelerate colorkey and alpha blits in the resulting
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	352 * surface.
2275 12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	353 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	354 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	355 (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	356
3341 710139a1692d Fixed bug #826 Sam Lantinga <slouken@libsdl.org> parents: 3103 diff changeset	357 /**
3434 147d6ef5be03 Added a utility function to convert blocks of pixels Sam Lantinga <slouken@libsdl.org> parents: 3407 diff changeset	358 * \brief Copy a block of pixels of one format to another format
147d6ef5be03 Added a utility function to convert blocks of pixels Sam Lantinga <slouken@libsdl.org> parents: 3407 diff changeset	359 */
147d6ef5be03 Added a utility function to convert blocks of pixels Sam Lantinga <slouken@libsdl.org> parents: 3407 diff changeset	360 extern DECLSPEC int SDLCALL SDL_ConvertPixels(int width, int height,
147d6ef5be03 Added a utility function to convert blocks of pixels Sam Lantinga <slouken@libsdl.org> parents: 3407 diff changeset	361 Uint32 src_format,
147d6ef5be03 Added a utility function to convert blocks of pixels Sam Lantinga <slouken@libsdl.org> parents: 3407 diff changeset	362 const void * src, int src_pitch,
147d6ef5be03 Added a utility function to convert blocks of pixels Sam Lantinga <slouken@libsdl.org> parents: 3407 diff changeset	363 Uint32 dst_format,
147d6ef5be03 Added a utility function to convert blocks of pixels Sam Lantinga <slouken@libsdl.org> parents: 3407 diff changeset	364 void * dst, int dst_pitch);
147d6ef5be03 Added a utility function to convert blocks of pixels Sam Lantinga <slouken@libsdl.org> parents: 3407 diff changeset	365
147d6ef5be03 Added a utility function to convert blocks of pixels Sam Lantinga <slouken@libsdl.org> parents: 3407 diff changeset	366 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	367 * Performs a fast fill of the given rectangle with \c color.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	368 *
3536 0267b8b1595c Added interfaces for batch drawing of points, lines and rects: Sam Lantinga <slouken@libsdl.org> parents: 3434 diff changeset	369 * If \c rect is NULL, the whole surface will be filled with \c color.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	370 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	371 * The color should be a pixel of the format used by the surface, and
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	372 * can be generated by the SDL_MapRGB() function.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	373 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	374 * \return 0 on success, or -1 on error.
2275 12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	375 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	376 extern DECLSPEC int SDLCALL SDL_FillRect
3536 0267b8b1595c Added interfaces for batch drawing of points, lines and rects: Sam Lantinga <slouken@libsdl.org> parents: 3434 diff changeset	377 (SDL_Surface * dst, const SDL_Rect * rect, Uint32 color);
0267b8b1595c Added interfaces for batch drawing of points, lines and rects: Sam Lantinga <slouken@libsdl.org> parents: 3434 diff changeset	378 extern DECLSPEC int SDLCALL SDL_FillRects
0267b8b1595c Added interfaces for batch drawing of points, lines and rects: Sam Lantinga <slouken@libsdl.org> parents: 3434 diff changeset	379 (SDL_Surface * dst, const SDL_Rect ** rects, int count, Uint32 color);
2275 12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	380
3341 710139a1692d Fixed bug #826 Sam Lantinga <slouken@libsdl.org> parents: 3103 diff changeset	381 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	382 * Performs a fast blit from the source surface to the destination surface.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	383 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	384 * This assumes that the source and destination rectangles are
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	385 * the same size. If either \c srcrect or \c dstrect are NULL, the entire
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	386 * surface (\c src or \c dst) is copied. The final blit rectangles are saved
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	387 * in \c srcrect and \c dstrect after all clipping is performed.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	388 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	389 * \return If the blit is successful, it returns 0, otherwise it returns -1.
2275 12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	390 *
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	391 * The blit function should not be called on a locked surface.
2275 12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	392 *
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	393 * The blit semantics for surfaces with and without alpha and colorkey
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	394 * are defined as follows:
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	395 * \verbatim
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	396 RGBA->RGB:
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	397 SDL_SRCALPHA set:
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	398 alpha-blend (using alpha-channel).
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	399 SDL_SRCCOLORKEY ignored.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	400 SDL_SRCALPHA not set:
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	401 copy RGB.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	402 if SDL_SRCCOLORKEY set, only copy the pixels matching the
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	403 RGB values of the source colour key, ignoring alpha in the
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	404 comparison.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	405
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	406 RGB->RGBA:
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	407 SDL_SRCALPHA set:
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	408 alpha-blend (using the source per-surface alpha value);
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	409 set destination alpha to opaque.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	410 SDL_SRCALPHA not set:
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	411 copy RGB, set destination alpha to source per-surface alpha value.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	412 both:
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	413 if SDL_SRCCOLORKEY set, only copy the pixels matching the
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	414 source colour key.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	415
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	416 RGBA->RGBA:
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	417 SDL_SRCALPHA set:
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	418 alpha-blend (using the source alpha channel) the RGB values;
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	419 leave destination alpha untouched. [Note: is this correct?]
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	420 SDL_SRCCOLORKEY ignored.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	421 SDL_SRCALPHA not set:
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	422 copy all of RGBA to the destination.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	423 if SDL_SRCCOLORKEY set, only copy the pixels matching the
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	424 RGB values of the source colour key, ignoring alpha in the
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	425 comparison.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	426
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	427 RGB->RGB:
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	428 SDL_SRCALPHA set:
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	429 alpha-blend (using the source per-surface alpha value).
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	430 SDL_SRCALPHA not set:
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	431 copy RGB.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	432 both:
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	433 if SDL_SRCCOLORKEY set, only copy the pixels matching the
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	434 source colour key.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	435 \endverbatim
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	436 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	437 * You should call SDL_BlitSurface() unless you know exactly how SDL
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	438 * blitting works internally and how to use the other blit functions.
2275 12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	439 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	440 #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	441
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	442 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	443 * This is the public blit function, SDL_BlitSurface(), and it performs
3341 710139a1692d Fixed bug #826 Sam Lantinga <slouken@libsdl.org> parents: 3103 diff changeset	444 * rectangle validation and clipping before passing it to SDL_LowerBlit()
710139a1692d Fixed bug #826 Sam Lantinga <slouken@libsdl.org> parents: 3103 diff changeset	445 */
2275 12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	446 extern DECLSPEC int SDLCALL SDL_UpperBlit
4949 68da5a234bba The source rectangle isn't modified in SDL_UpperBlit Sam Lantinga <slouken@libsdl.org> parents: 4929 diff changeset	447 (SDL_Surface * src, const SDL_Rect * srcrect,
2275 12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	448 SDL_Surface * dst, SDL_Rect * dstrect);
3341 710139a1692d Fixed bug #826 Sam Lantinga <slouken@libsdl.org> parents: 3103 diff changeset	449
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	450 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	451 * This is a semi-private blit function and it performs low-level surface
3341 710139a1692d Fixed bug #826 Sam Lantinga <slouken@libsdl.org> parents: 3103 diff changeset	452 * blitting only.
710139a1692d Fixed bug #826 Sam Lantinga <slouken@libsdl.org> parents: 3103 diff changeset	453 */
2275 12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	454 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	455 (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	456 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	457
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	458 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	459 * \brief Perform a fast, low quality, stretch blit between two surfaces of the
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	460 * same pixel format.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	461 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	462 * \note This function uses a static buffer, and is not thread-safe.
2275 12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	463 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	464 extern DECLSPEC int SDLCALL SDL_SoftStretch(SDL_Surface * src,
2828 7e5ff6cd05bf Added very slow software scaling to the X11 renderer Sam Lantinga <slouken@libsdl.org> parents: 2807 diff changeset	465 const SDL_Rect * srcrect,
2275 12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	466 SDL_Surface * dst,
2828 7e5ff6cd05bf Added very slow software scaling to the X11 renderer Sam Lantinga <slouken@libsdl.org> parents: 2807 diff changeset	467 const SDL_Rect * dstrect);
2275 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 /* 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	470 #ifdef __cplusplus
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	471 /* INDENT-OFF */
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 /* INDENT-ON */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	474 #endif
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	475 #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	476
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	477 #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	478
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	479 /* vi: set ts=4 sw=4 expandtab: */

Mercurial > sdl-ios-xcode

annotate include/SDL_surface.h @ 5282:8e421890cdb8