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

annotate include/SDL_surface.h @ 5135:5f09cb749d75

Added vim spacing hints

author	Sam Lantinga <slouken@libsdl.org>
date	Tue, 01 Feb 2011 09:00:47 -0800
parents	158bb5752974
children	da10636e5eca

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
3697 f7b03b6838cb Fixed bug #926 Sam Lantinga <slouken@libsdl.org> parents: 3596 diff changeset	3 Copyright (C) 1997-2010 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"
aa8888658021 Use the enumerated type for blend and scale mode instead of int Sam Lantinga <slouken@libsdl.org> parents: 4424 diff changeset	36 #include "SDL_scalemode.h"
2275 12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	37 #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	38
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	39 #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	40 /* 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	41 #ifdef __cplusplus
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	42 /* INDENT-OFF */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	43 extern "C" {
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	44 /* INDENT-ON */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	45 #endif
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	46
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	47 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	48 * \name Surface flags
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	49 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	50 * 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	51 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	52 * \internal
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	53 * Used internally (read-only).
3341 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 /@{/
710139a1692d Fixed bug #826 Sam Lantinga <slouken@libsdl.org> parents: 3103 diff changeset	56 #define SDL_PREALLOC 0x00000001 /*< Surface uses preallocated memory /
710139a1692d Fixed bug #826 Sam Lantinga <slouken@libsdl.org> parents: 3103 diff changeset	57 #define SDL_RLEACCEL 0x00000002 /*< Surface is RLE encoded /
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	58 /@}//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	59
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	60 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	61 * 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	62 */
2275 12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	63 #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	64
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	65 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	66 * \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	67 *
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	68 * \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	69 * 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	70 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	71 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	72 {
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	73 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	74 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	75 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	76 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	77 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	78
3708 d3f7cf8b0db0 Fixed typo in the comment Sam Lantinga <slouken@libsdl.org> parents: 3697 diff changeset	79 /** 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	80 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	81
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	82 /** 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	83 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	84 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	85
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	86 /** 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	87 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	88
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	89 /** 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	90 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	91
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	92 /** 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	93 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	94
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	95 /** 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	96 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	97 } SDL_Surface;
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	98
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	99 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	100 * \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	101 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	102 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	103 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	104
3341 710139a1692d Fixed bug #826 Sam Lantinga <slouken@libsdl.org> parents: 3103 diff changeset	105 /**
4424 274743af0430 Removed reference to compatibility function Sam Lantinga <slouken@libsdl.org> parents: 3709 diff changeset	106 * Allocate and free an RGB surface.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	107 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	108 * 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	109 * 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	110 * flags '[RGB]mask'.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	111 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	112 * 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	113 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	114 * \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	115 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	116 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	117 (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	118 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	119 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	120 int width,
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	121 int height,
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	122 int depth,
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	123 int pitch,
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	124 Uint32 Rmask,
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	125 Uint32 Gmask,
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	126 Uint32 Bmask,
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	127 Uint32 Amask);
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	128 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	129
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	130 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	131 * \brief Set the palette used by a surface.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	132 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	133 * \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	134 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	135 * \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	136 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	137 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	138 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	139
3341 710139a1692d Fixed bug #826 Sam Lantinga <slouken@libsdl.org> parents: 3103 diff changeset	140 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	141 * \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	142 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	143 * 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	144 * 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	145 * \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	146 * use SDL_UnlockSurface() to release it.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	147 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	148 * 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	149 * 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	150 * pixel format of the surface will not change.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	151 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	152 * 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	153 * 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	154 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	155 * 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	156 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	157 * \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	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 int SDLCALL SDL_LockSurface(SDL_Surface * surface);
3341 710139a1692d Fixed bug #826 Sam Lantinga <slouken@libsdl.org> parents: 3103 diff changeset	160 /** \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	161 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	162
3341 710139a1692d Fixed bug #826 Sam Lantinga <slouken@libsdl.org> parents: 3103 diff changeset	163 /**
4971 158bb5752974 Updated headers to match wiki documentation Sam Lantinga <slouken@libsdl.org> parents: 4949 diff changeset	164 * 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	165 *
4971 158bb5752974 Updated headers to match wiki documentation Sam Lantinga <slouken@libsdl.org> parents: 4949 diff changeset	166 * 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	167 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	168 * The new surface should be freed with SDL_FreeSurface().
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	169 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	170 * \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	171 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	172 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	173 int freesrc);
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	174
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	175 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	176 * Load a surface from a file.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	177 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	178 * Convenience macro.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	179 */
2275 12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	180 #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	181
3341 710139a1692d Fixed bug #826 Sam Lantinga <slouken@libsdl.org> parents: 3103 diff changeset	182 /**
4971 158bb5752974 Updated headers to match wiki documentation Sam Lantinga <slouken@libsdl.org> parents: 4949 diff changeset	183 * 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	184 *
4971 158bb5752974 Updated headers to match wiki documentation Sam Lantinga <slouken@libsdl.org> parents: 4949 diff changeset	185 * 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	186 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	187 * \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	188 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	189 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	190 (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	191
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	192 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	193 * Save a surface to a file.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	194 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	195 * Convenience macro.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	196 */
2275 12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	197 #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	198 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	199
3341 710139a1692d Fixed bug #826 Sam Lantinga <slouken@libsdl.org> parents: 3103 diff changeset	200 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	201 * \brief Sets the RLE acceleration hint for a surface.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	202 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	203 * \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	204 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	205 * \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	206 * 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	207 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	208 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	209 int flag);
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	210
3341 710139a1692d Fixed bug #826 Sam Lantinga <slouken@libsdl.org> parents: 3103 diff changeset	211 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	212 * \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	213 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	214 * \param surface The surface to update
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	215 * \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	216 * \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	217 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	218 * \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	219 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	220 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	221 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	222
3341 710139a1692d Fixed bug #826 Sam Lantinga <slouken@libsdl.org> parents: 3103 diff changeset	223 /**
3550 6b69c5def097 Minor documentation fix Sam Lantinga <slouken@libsdl.org> parents: 3536 diff changeset	224 * \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	225 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	226 * \param surface The surface to update
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	227 * \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	228 * surface format
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	229 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	230 * \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	231 * enabled.
3103 7be21a78777e Added SDL_GetColorKey() Sam Lantinga <slouken@libsdl.org> parents: 3026 diff changeset	232 */
7be21a78777e Added SDL_GetColorKey() Sam Lantinga <slouken@libsdl.org> parents: 3026 diff changeset	233 extern DECLSPEC int SDLCALL SDL_GetColorKey(SDL_Surface * surface,
7be21a78777e Added SDL_GetColorKey() Sam Lantinga <slouken@libsdl.org> parents: 3026 diff changeset	234 Uint32 * key);
7be21a78777e Added SDL_GetColorKey() Sam Lantinga <slouken@libsdl.org> parents: 3026 diff changeset	235
2275 12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	236 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	237 * \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	238 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	239 * \param surface The surface to update.
4971 158bb5752974 Updated headers to match wiki documentation Sam Lantinga <slouken@libsdl.org> parents: 4949 diff changeset	240 * \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	241 * \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	242 * \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	243 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	244 * \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	245 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	246 * \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	247 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	248 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	249 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	250
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 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	253 * \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	254 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	255 * \param surface The surface to query.
4971 158bb5752974 Updated headers to match wiki documentation Sam Lantinga <slouken@libsdl.org> parents: 4949 diff changeset	256 * \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	257 * \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	258 * \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	259 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	260 * \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	261 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	262 * \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	263 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	264 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	265 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	266 Uint8 * b);
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	267
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	268 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	269 * \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	270 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	271 * \param surface The surface to update.
4971 158bb5752974 Updated headers to match wiki documentation Sam Lantinga <slouken@libsdl.org> parents: 4949 diff changeset	272 * \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	273 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	274 * \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	275 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	276 * \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	277 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	278 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	279 Uint8 alpha);
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	280
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	281 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	282 * \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	283 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	284 * \param surface The surface to query.
4971 158bb5752974 Updated headers to match wiki documentation Sam Lantinga <slouken@libsdl.org> parents: 4949 diff changeset	285 * \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	286 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	287 * \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	288 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	289 * \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	290 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	291 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	292 Uint8 * alpha);
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	293
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	294 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	295 * \brief Set the blend mode used for blit operations.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	296 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	297 * \param surface The surface to update.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	298 * \param blendMode ::SDL_BlendMode to use for blit blending.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	299 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	300 * \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	301 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	302 * \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	303 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	304 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	305 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	306
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	307 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	308 * \brief Get the blend mode used for blit operations.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	309 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	310 * \param surface The surface to query.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	311 * \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	312 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	313 * \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	314 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	315 * \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	316 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	317 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	318 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	319
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	320 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	321 * \brief Set the scale mode used for blit operations.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	322 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	323 * \param surface The surface to update.
4929 aa8888658021 Use the enumerated type for blend and scale mode instead of int Sam Lantinga <slouken@libsdl.org> parents: 4424 diff changeset	324 * \param scaleMode ::SDL_ScaleMode to use for blit scaling.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	325 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	326 * \return 0 on success, or -1 if the surface is not valid or the scale mode is
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	327 * not supported.
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 If the scale mode is not supported, the closest supported mode is
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	330 * chosen. Currently only ::SDL_TEXTURESCALEMODE_FAST is supported on
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	331 * surfaces.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	332 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	333 * \sa SDL_GetSurfaceScaleMode()
2275 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 extern DECLSPEC int SDLCALL SDL_SetSurfaceScaleMode(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	336 SDL_ScaleMode scaleMode);
2275 12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	337
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	338 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	339 * \brief Get the scale mode used for blit operations.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	340 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	341 * \param surface The surface to query.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	342 * \param scaleMode A pointer filled in with the current scale mode.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	343 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	344 * \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	345 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	346 * \sa SDL_SetSurfaceScaleMode()
2275 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 extern DECLSPEC int SDLCALL SDL_GetSurfaceScaleMode(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	349 SDL_ScaleMode *scaleMode);
2275 12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	350
3341 710139a1692d Fixed bug #826 Sam Lantinga <slouken@libsdl.org> parents: 3103 diff changeset	351 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	352 * 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	353 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	354 * 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	355 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	356 * 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	357 * 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	358 * 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	359 * 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	360 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	361 * 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	362 * 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	363 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	364 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	365 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	366
3341 710139a1692d Fixed bug #826 Sam Lantinga <slouken@libsdl.org> parents: 3103 diff changeset	367 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	368 * 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	369 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	370 * \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	371 * 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	372 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	373 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	374 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	375
3341 710139a1692d Fixed bug #826 Sam Lantinga <slouken@libsdl.org> parents: 3103 diff changeset	376 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	377 * 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	378 * 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	379 * 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	380 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	381 * 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	382 * 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	383 * 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	384 * surface.
2275 12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	385 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	386 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	387 (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	388
3341 710139a1692d Fixed bug #826 Sam Lantinga <slouken@libsdl.org> parents: 3103 diff changeset	389 /**
3434 147d6ef5be03 Added a utility function to convert blocks of pixels Sam Lantinga <slouken@libsdl.org> parents: 3407 diff changeset	390 * \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	391 */
147d6ef5be03 Added a utility function to convert blocks of pixels Sam Lantinga <slouken@libsdl.org> parents: 3407 diff changeset	392 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	393 Uint32 src_format,
147d6ef5be03 Added a utility function to convert blocks of pixels Sam Lantinga <slouken@libsdl.org> parents: 3407 diff changeset	394 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	395 Uint32 dst_format,
147d6ef5be03 Added a utility function to convert blocks of pixels Sam Lantinga <slouken@libsdl.org> parents: 3407 diff changeset	396 void * dst, int dst_pitch);
147d6ef5be03 Added a utility function to convert blocks of pixels Sam Lantinga <slouken@libsdl.org> parents: 3407 diff changeset	397
147d6ef5be03 Added a utility function to convert blocks of pixels Sam Lantinga <slouken@libsdl.org> parents: 3407 diff changeset	398 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	399 * Draws a point with \c color.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	400 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	401 * 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	402 * can be generated by the SDL_MapRGB() function.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	403 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	404 * \return 0 on success, or -1 on error.
2901 133601e3b255 Added RenderPiont() API Sam Lantinga <slouken@libsdl.org> parents: 2888 diff changeset	405 */
133601e3b255 Added RenderPiont() API Sam Lantinga <slouken@libsdl.org> parents: 2888 diff changeset	406 extern DECLSPEC int SDLCALL SDL_DrawPoint
133601e3b255 Added RenderPiont() API Sam Lantinga <slouken@libsdl.org> parents: 2888 diff changeset	407 (SDL_Surface * dst, int x, int y, Uint32 color);
3536 0267b8b1595c Added interfaces for batch drawing of points, lines and rects: Sam Lantinga <slouken@libsdl.org> parents: 3434 diff changeset	408 extern DECLSPEC int SDLCALL SDL_DrawPoints
0267b8b1595c Added interfaces for batch drawing of points, lines and rects: Sam Lantinga <slouken@libsdl.org> parents: 3434 diff changeset	409 (SDL_Surface * dst, const SDL_Point * points, int count, Uint32 color);
2901 133601e3b255 Added RenderPiont() API Sam Lantinga <slouken@libsdl.org> parents: 2888 diff changeset	410
3341 710139a1692d Fixed bug #826 Sam Lantinga <slouken@libsdl.org> parents: 3103 diff changeset	411 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	412 * Blends a point with an RGBA value.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	413 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	414 * \return 0 on success, or -1 on error.
2901 133601e3b255 Added RenderPiont() API Sam Lantinga <slouken@libsdl.org> parents: 2888 diff changeset	415 */
3596 f638ded38b8a Added SDL_RenderClear() as a fast method of clearing the screen to the drawing color. Sam Lantinga <slouken@libsdl.org> parents: 3593 diff changeset	416 extern DECLSPEC int SDLCALL SDL_BlendPoint
3536 0267b8b1595c Added interfaces for batch drawing of points, lines and rects: Sam Lantinga <slouken@libsdl.org> parents: 3434 diff changeset	417 (SDL_Surface * dst, int x, int y,
4929 aa8888658021 Use the enumerated type for blend and scale mode instead of int Sam Lantinga <slouken@libsdl.org> parents: 4424 diff changeset	418 SDL_BlendMode blendMode, Uint8 r, Uint8 g, Uint8 b, Uint8 a);
3536 0267b8b1595c Added interfaces for batch drawing of points, lines and rects: Sam Lantinga <slouken@libsdl.org> parents: 3434 diff changeset	419 extern DECLSPEC int SDLCALL SDL_BlendPoints
0267b8b1595c Added interfaces for batch drawing of points, lines and rects: Sam Lantinga <slouken@libsdl.org> parents: 3434 diff changeset	420 (SDL_Surface * dst, const SDL_Point * points, int count,
4929 aa8888658021 Use the enumerated type for blend and scale mode instead of int Sam Lantinga <slouken@libsdl.org> parents: 4424 diff changeset	421 SDL_BlendMode blendMode, Uint8 r, Uint8 g, Uint8 b, Uint8 a);
2901 133601e3b255 Added RenderPiont() API Sam Lantinga <slouken@libsdl.org> parents: 2888 diff changeset	422
3341 710139a1692d Fixed bug #826 Sam Lantinga <slouken@libsdl.org> parents: 3103 diff changeset	423 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	424 * Draws a line with \c color.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	425 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	426 * 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	427 * can be generated by the SDL_MapRGB() function.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	428 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	429 * \return 0 on success, or -1 on error.
2888 32e8bbba1e94 Added stubs for software implementations of blending fills and line drawing Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	430 */
32e8bbba1e94 Added stubs for software implementations of blending fills and line drawing Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	431 extern DECLSPEC int SDLCALL SDL_DrawLine
32e8bbba1e94 Added stubs for software implementations of blending fills and line drawing Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	432 (SDL_Surface * dst, int x1, int y1, int x2, int y2, Uint32 color);
3536 0267b8b1595c Added interfaces for batch drawing of points, lines and rects: Sam Lantinga <slouken@libsdl.org> parents: 3434 diff changeset	433 extern DECLSPEC int SDLCALL SDL_DrawLines
0267b8b1595c Added interfaces for batch drawing of points, lines and rects: Sam Lantinga <slouken@libsdl.org> parents: 3434 diff changeset	434 (SDL_Surface * dst, const SDL_Point * points, int count, Uint32 color);
2888 32e8bbba1e94 Added stubs for software implementations of blending fills and line drawing Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	435
3341 710139a1692d Fixed bug #826 Sam Lantinga <slouken@libsdl.org> parents: 3103 diff changeset	436 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	437 * Blends an RGBA value along a line.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	438 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	439 * \return 0 on success, or -1 on error.
2888 32e8bbba1e94 Added stubs for software implementations of blending fills and line drawing Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	440 */
32e8bbba1e94 Added stubs for software implementations of blending fills and line drawing Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	441 extern DECLSPEC int SDLCALL SDL_BlendLine
3536 0267b8b1595c Added interfaces for batch drawing of points, lines and rects: Sam Lantinga <slouken@libsdl.org> parents: 3434 diff changeset	442 (SDL_Surface * dst, int x1, int y1, int x2, int y2,
4929 aa8888658021 Use the enumerated type for blend and scale mode instead of int Sam Lantinga <slouken@libsdl.org> parents: 4424 diff changeset	443 SDL_BlendMode blendMode, Uint8 r, Uint8 g, Uint8 b, Uint8 a);
3536 0267b8b1595c Added interfaces for batch drawing of points, lines and rects: Sam Lantinga <slouken@libsdl.org> parents: 3434 diff changeset	444 extern DECLSPEC int SDLCALL SDL_BlendLines
0267b8b1595c Added interfaces for batch drawing of points, lines and rects: Sam Lantinga <slouken@libsdl.org> parents: 3434 diff changeset	445 (SDL_Surface * dst, const SDL_Point * points, int count,
4929 aa8888658021 Use the enumerated type for blend and scale mode instead of int Sam Lantinga <slouken@libsdl.org> parents: 4424 diff changeset	446 SDL_BlendMode blendMode, Uint8 r, Uint8 g, Uint8 b, Uint8 a);
2888 32e8bbba1e94 Added stubs for software implementations of blending fills and line drawing Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	447
3341 710139a1692d Fixed bug #826 Sam Lantinga <slouken@libsdl.org> parents: 3103 diff changeset	448 /**
3593 b931bcfd94a0 In the process of adding rectangle drawing Sam Lantinga <slouken@libsdl.org> parents: 3560 diff changeset	449 * Draws the given rectangle with \c color.
b931bcfd94a0 In the process of adding rectangle drawing Sam Lantinga <slouken@libsdl.org> parents: 3560 diff changeset	450 *
b931bcfd94a0 In the process of adding rectangle drawing Sam Lantinga <slouken@libsdl.org> parents: 3560 diff changeset	451 * If \c rect is NULL, the whole surface will be outlined with \c color.
b931bcfd94a0 In the process of adding rectangle drawing Sam Lantinga <slouken@libsdl.org> parents: 3560 diff changeset	452 *
b931bcfd94a0 In the process of adding rectangle drawing Sam Lantinga <slouken@libsdl.org> parents: 3560 diff changeset	453 * The color should be a pixel of the format used by the surface, and
b931bcfd94a0 In the process of adding rectangle drawing Sam Lantinga <slouken@libsdl.org> parents: 3560 diff changeset	454 * can be generated by the SDL_MapRGB() function.
b931bcfd94a0 In the process of adding rectangle drawing Sam Lantinga <slouken@libsdl.org> parents: 3560 diff changeset	455 *
b931bcfd94a0 In the process of adding rectangle drawing Sam Lantinga <slouken@libsdl.org> parents: 3560 diff changeset	456 * \return 0 on success, or -1 on error.
b931bcfd94a0 In the process of adding rectangle drawing Sam Lantinga <slouken@libsdl.org> parents: 3560 diff changeset	457 */
b931bcfd94a0 In the process of adding rectangle drawing Sam Lantinga <slouken@libsdl.org> parents: 3560 diff changeset	458 extern DECLSPEC int SDLCALL SDL_DrawRect
b931bcfd94a0 In the process of adding rectangle drawing Sam Lantinga <slouken@libsdl.org> parents: 3560 diff changeset	459 (SDL_Surface * dst, const SDL_Rect * rect, Uint32 color);
b931bcfd94a0 In the process of adding rectangle drawing Sam Lantinga <slouken@libsdl.org> parents: 3560 diff changeset	460 extern DECLSPEC int SDLCALL SDL_DrawRects
b931bcfd94a0 In the process of adding rectangle drawing Sam Lantinga <slouken@libsdl.org> parents: 3560 diff changeset	461 (SDL_Surface * dst, const SDL_Rect ** rects, int count, Uint32 color);
b931bcfd94a0 In the process of adding rectangle drawing Sam Lantinga <slouken@libsdl.org> parents: 3560 diff changeset	462
b931bcfd94a0 In the process of adding rectangle drawing Sam Lantinga <slouken@libsdl.org> parents: 3560 diff changeset	463 /**
3596 f638ded38b8a Added SDL_RenderClear() as a fast method of clearing the screen to the drawing color. Sam Lantinga <slouken@libsdl.org> parents: 3593 diff changeset	464 * Blends an RGBA value into the outline of the given rectangle.
3593 b931bcfd94a0 In the process of adding rectangle drawing Sam Lantinga <slouken@libsdl.org> parents: 3560 diff changeset	465 *
3596 f638ded38b8a Added SDL_RenderClear() as a fast method of clearing the screen to the drawing color. Sam Lantinga <slouken@libsdl.org> parents: 3593 diff changeset	466 * If \c rect is NULL, the whole surface will have a blended outline.
3593 b931bcfd94a0 In the process of adding rectangle drawing Sam Lantinga <slouken@libsdl.org> parents: 3560 diff changeset	467 *
b931bcfd94a0 In the process of adding rectangle drawing Sam Lantinga <slouken@libsdl.org> parents: 3560 diff changeset	468 * \return 0 on success, or -1 on error.
b931bcfd94a0 In the process of adding rectangle drawing Sam Lantinga <slouken@libsdl.org> parents: 3560 diff changeset	469 */
b931bcfd94a0 In the process of adding rectangle drawing Sam Lantinga <slouken@libsdl.org> parents: 3560 diff changeset	470 extern DECLSPEC int SDLCALL SDL_BlendRect
b931bcfd94a0 In the process of adding rectangle drawing Sam Lantinga <slouken@libsdl.org> parents: 3560 diff changeset	471 (SDL_Surface * dst, const SDL_Rect * rect,
4929 aa8888658021 Use the enumerated type for blend and scale mode instead of int Sam Lantinga <slouken@libsdl.org> parents: 4424 diff changeset	472 SDL_BlendMode blendMode, Uint8 r, Uint8 g, Uint8 b, Uint8 a);
3593 b931bcfd94a0 In the process of adding rectangle drawing Sam Lantinga <slouken@libsdl.org> parents: 3560 diff changeset	473 extern DECLSPEC int SDLCALL SDL_BlendRects
b931bcfd94a0 In the process of adding rectangle drawing Sam Lantinga <slouken@libsdl.org> parents: 3560 diff changeset	474 (SDL_Surface * dst, const SDL_Rect ** rects, int count,
4929 aa8888658021 Use the enumerated type for blend and scale mode instead of int Sam Lantinga <slouken@libsdl.org> parents: 4424 diff changeset	475 SDL_BlendMode blendMode, Uint8 r, Uint8 g, Uint8 b, Uint8 a);
3593 b931bcfd94a0 In the process of adding rectangle drawing Sam Lantinga <slouken@libsdl.org> parents: 3560 diff changeset	476
b931bcfd94a0 In the process of adding rectangle drawing Sam Lantinga <slouken@libsdl.org> parents: 3560 diff changeset	477 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	478 * 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	479 *
3536 0267b8b1595c Added interfaces for batch drawing of points, lines and rects: Sam Lantinga <slouken@libsdl.org> parents: 3434 diff changeset	480 * 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	481 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	482 * 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	483 * can be generated by the SDL_MapRGB() function.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	484 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	485 * \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	486 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	487 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	488 (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	489 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	490 (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	491
3341 710139a1692d Fixed bug #826 Sam Lantinga <slouken@libsdl.org> parents: 3103 diff changeset	492 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	493 * Blends an RGBA value into the given rectangle.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	494 *
3596 f638ded38b8a Added SDL_RenderClear() as a fast method of clearing the screen to the drawing color. Sam Lantinga <slouken@libsdl.org> parents: 3593 diff changeset	495 * If \c rect is NULL, the whole surface will be blended with the color.
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	496 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	497 * \return This function returns 0 on success, or -1 on error.
2888 32e8bbba1e94 Added stubs for software implementations of blending fills and line drawing Sam Lantinga <slouken@libsdl.org> parents: 2859 diff changeset	498 */
3593 b931bcfd94a0 In the process of adding rectangle drawing Sam Lantinga <slouken@libsdl.org> parents: 3560 diff changeset	499 extern DECLSPEC int SDLCALL SDL_BlendFillRect
3536 0267b8b1595c Added interfaces for batch drawing of points, lines and rects: Sam Lantinga <slouken@libsdl.org> parents: 3434 diff changeset	500 (SDL_Surface * dst, const SDL_Rect * rect,
4929 aa8888658021 Use the enumerated type for blend and scale mode instead of int Sam Lantinga <slouken@libsdl.org> parents: 4424 diff changeset	501 SDL_BlendMode blendMode, Uint8 r, Uint8 g, Uint8 b, Uint8 a);
3593 b931bcfd94a0 In the process of adding rectangle drawing Sam Lantinga <slouken@libsdl.org> parents: 3560 diff changeset	502 extern DECLSPEC int SDLCALL SDL_BlendFillRects
3536 0267b8b1595c Added interfaces for batch drawing of points, lines and rects: Sam Lantinga <slouken@libsdl.org> parents: 3434 diff changeset	503 (SDL_Surface * dst, const SDL_Rect ** rects, int count,
4929 aa8888658021 Use the enumerated type for blend and scale mode instead of int Sam Lantinga <slouken@libsdl.org> parents: 4424 diff changeset	504 SDL_BlendMode blendMode, Uint8 r, Uint8 g, Uint8 b, Uint8 a);
3596 f638ded38b8a Added SDL_RenderClear() as a fast method of clearing the screen to the drawing color. Sam Lantinga <slouken@libsdl.org> parents: 3593 diff changeset	505
3341 710139a1692d Fixed bug #826 Sam Lantinga <slouken@libsdl.org> parents: 3103 diff changeset	506 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	507 * 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	508 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	509 * This assumes that the source and destination rectangles are
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	510 * 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	511 * 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	512 * 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	513 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	514 * \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	515 *
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	516 * 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	517 *
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	518 * 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	519 * are defined as follows:
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	520 * \verbatim
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	521 RGBA->RGB:
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	522 SDL_SRCALPHA set:
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	523 alpha-blend (using alpha-channel).
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	524 SDL_SRCCOLORKEY ignored.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	525 SDL_SRCALPHA not set:
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	526 copy RGB.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	527 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	528 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	529 comparison.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	530
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	531 RGB->RGBA:
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	532 SDL_SRCALPHA set:
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	533 alpha-blend (using the source per-surface alpha value);
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	534 set destination alpha to opaque.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	535 SDL_SRCALPHA not set:
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	536 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	537 both:
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	538 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	539 source colour key.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	540
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	541 RGBA->RGBA:
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	542 SDL_SRCALPHA set:
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	543 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	544 leave destination alpha untouched. [Note: is this correct?]
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	545 SDL_SRCCOLORKEY ignored.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	546 SDL_SRCALPHA not set:
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	547 copy all of RGBA to the destination.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	548 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	549 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	550 comparison.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	551
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	552 RGB->RGB:
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	553 SDL_SRCALPHA set:
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	554 alpha-blend (using the source per-surface alpha value).
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	555 SDL_SRCALPHA not set:
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	556 copy RGB.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	557 both:
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	558 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	559 source colour key.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	560 \endverbatim
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	561 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	562 * If either of the surfaces were in video memory, and the blit returns -2,
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	563 * the video memory was lost, so it should be reloaded with artwork and
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	564 * re-blitted:
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	565 * @code
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	566 * while ( SDL_BlitSurface(image, imgrect, screen, dstrect) == -2 ) {
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	567 * while ( SDL_LockSurface(image) < 0 )
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	568 * Sleep(10);
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	569 * -- Write image pixels to image->pixels --
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	570 * SDL_UnlockSurface(image);
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	571 * }
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	572 * @endcode
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	573 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	574 * This happens under DirectX 5.0 when the system switches away from your
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	575 * fullscreen application. The lock will also fail until you have access
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	576 * to the video memory again.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	577 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	578 * 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	579 * 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	580 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	581 #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	582
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	583 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	584 * 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	585 * rectangle validation and clipping before passing it to SDL_LowerBlit()
710139a1692d Fixed bug #826 Sam Lantinga <slouken@libsdl.org> parents: 3103 diff changeset	586 */
2275 12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	587 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	588 (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	589 SDL_Surface * dst, SDL_Rect * dstrect);
3341 710139a1692d Fixed bug #826 Sam Lantinga <slouken@libsdl.org> parents: 3103 diff changeset	590
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	591 /**
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	592 * 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	593 * blitting only.
710139a1692d Fixed bug #826 Sam Lantinga <slouken@libsdl.org> parents: 3103 diff changeset	594 */
2275 12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	595 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	596 (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	597 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	598
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	599 /**
3407 d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	600 * \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	601 * same pixel format.
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	602 *
d3baf5ac4e37 Partial fix for bug #859 Sam Lantinga <slouken@libsdl.org> parents: 3341 diff changeset	603 * \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	604 */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	605 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	606 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	607 SDL_Surface * dst,
2828 7e5ff6cd05bf Added very slow software scaling to the X11 renderer Sam Lantinga <slouken@libsdl.org> parents: 2807 diff changeset	608 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	609
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	610 /* 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	611 #ifdef __cplusplus
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	612 /* INDENT-OFF */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	613 }
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	614 /* INDENT-ON */
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	615 #endif
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	616 #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	617
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	618 #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	619
12ea0fdc0df2 Split out the SDL_rect and SDL_surface functions into their own headers. Sam Lantinga <slouken@libsdl.org> parents: diff changeset	620 /* vi: set ts=4 sw=4 expandtab: */

Mercurial > sdl-ios-xcode

annotate include/SDL_surface.h @ 5135:5f09cb749d75