2 Simple DirectMedia Layer
5 This software is provided 'as-is', without any express or implied
6 warranty. In no event will the authors be held liable for any damages
7 arising from the use of this software.
9 Permission is granted to anyone to use this software for any purpose,
10 including commercial applications, and to alter it and redistribute it
11 freely, subject to the following restrictions:
13 1. The origin of this software must not be misrepresented; you must not
14 claim that you wrote the original software. If you use this software
15 in a product, an acknowledgment in the product documentation would be
16 appreciated but is not required.
17 2. Altered source versions must be plainly marked as such, and must not be
18 misrepresented as being the original software.
19 3. This notice may not be removed or altered from any source distribution.
25 * Header file for ::SDL_Surface definition and management functions.
28 #ifndef _SDL_surface_h
29 #define _SDL_surface_h
31 #include "SDL_stdinc.h"
32 #include "SDL_pixels.h"
34 #include "SDL_blendmode.h"
35 #include "SDL_rwops.h"
37 #include "begin_code.h"
38 /* Set up for C function definitions, even when using C++ */
46 * These are the currently supported flags for the ::SDL_Surface.
49 * Used internally (read-only).
52 #define SDL_SWSURFACE 0 /**< Just here for compatibility */
53 #define SDL_PREALLOC 0x00000001 /**< Surface uses preallocated memory */
54 #define SDL_RLEACCEL 0x00000002 /**< Surface is RLE encoded */
55 #define SDL_DONTFREE 0x00000004 /**< Surface is referenced internally */
56 /* @} *//* Surface flags */
59 * Evaluates to true if the surface needs to be locked before access.
61 #define SDL_MUSTLOCK(S) (((S)->flags & SDL_RLEACCEL) != 0)
64 * \brief A collection of pixels used in software blitting.
66 * \note This structure should be treated as read-only, except for \c pixels,
67 * which, if not NULL, contains the raw pixel data for the surface.
69 typedef struct SDL_Surface
71 Uint32 flags; /**< Read-only */
72 SDL_PixelFormat *format; /**< Read-only */
73 int w, h; /**< Read-only */
74 int pitch; /**< Read-only */
75 void *pixels; /**< Read-write */
77 /** Application data associated with the surface */
78 void *userdata; /**< Read-write */
80 /** information needed for surfaces requiring locks */
81 int locked; /**< Read-only */
82 void *lock_data; /**< Read-only */
84 /** clipping information */
85 SDL_Rect clip_rect; /**< Read-only */
87 /** info for fast blit mapping to other surfaces */
88 struct SDL_BlitMap *map; /**< Private */
90 /** Reference count -- used when freeing surface */
91 int refcount; /**< Read-mostly */
95 * \brief The type of function used for surface blitting functions.
97 typedef int (*SDL_blit) (struct SDL_Surface * src, SDL_Rect * srcrect,
98 struct SDL_Surface * dst, SDL_Rect * dstrect);
101 * Allocate and free an RGB surface.
103 * If the depth is 4 or 8 bits, an empty palette is allocated for the surface.
104 * If the depth is greater than 8 bits, the pixel format is set using the
107 * If the function runs out of memory, it will return NULL.
109 * \param flags The \c flags are obsolete and should be set to 0.
110 * \param width The width in pixels of the surface to create.
111 * \param height The height in pixels of the surface to create.
112 * \param depth The depth in bits of the surface to create.
113 * \param Rmask The red mask of the surface to create.
114 * \param Gmask The green mask of the surface to create.
115 * \param Bmask The blue mask of the surface to create.
116 * \param Amask The alpha mask of the surface to create.
118 extern DECLSPEC SDL_Surface *SDLCALL SDL_CreateRGBSurface
119 (Uint32 flags, int width, int height, int depth,
120 Uint32 Rmask, Uint32 Gmask, Uint32 Bmask, Uint32 Amask);
121 extern DECLSPEC SDL_Surface *SDLCALL SDL_CreateRGBSurfaceFrom(void *pixels,
130 extern DECLSPEC void SDLCALL SDL_FreeSurface(SDL_Surface * surface);
133 * \brief Set the palette used by a surface.
135 * \return 0, or -1 if the surface format doesn't use a palette.
137 * \note A single palette can be shared with many surfaces.
139 extern DECLSPEC int SDLCALL SDL_SetSurfacePalette(SDL_Surface * surface,
140 SDL_Palette * palette);
143 * \brief Sets up a surface for directly accessing the pixels.
145 * Between calls to SDL_LockSurface() / SDL_UnlockSurface(), you can write
146 * to and read from \c surface->pixels, using the pixel format stored in
147 * \c surface->format. Once you are done accessing the surface, you should
148 * use SDL_UnlockSurface() to release it.
150 * Not all surfaces require locking. If SDL_MUSTLOCK(surface) evaluates
151 * to 0, then you can read and write to the surface at any time, and the
152 * pixel format of the surface will not change.
154 * No operating system or library calls should be made between lock/unlock
155 * pairs, as critical system locks may be held during this time.
157 * SDL_LockSurface() returns 0, or -1 if the surface couldn't be locked.
159 * \sa SDL_UnlockSurface()
161 extern DECLSPEC int SDLCALL SDL_LockSurface(SDL_Surface * surface);
162 /** \sa SDL_LockSurface() */
163 extern DECLSPEC void SDLCALL SDL_UnlockSurface(SDL_Surface * surface);
166 * Load a surface from a seekable SDL data stream (memory or file).
168 * If \c freesrc is non-zero, the stream will be closed after being read.
170 * The new surface should be freed with SDL_FreeSurface().
172 * \return the new surface, or NULL if there was an error.
174 extern DECLSPEC SDL_Surface *SDLCALL SDL_LoadBMP_RW(SDL_RWops * src,
178 * Load a surface from a file.
182 #define SDL_LoadBMP(file) SDL_LoadBMP_RW(SDL_RWFromFile(file, "rb"), 1)
185 * Save a surface to a seekable SDL data stream (memory or file).
187 * If \c freedst is non-zero, the stream will be closed after being written.
189 * \return 0 if successful or -1 if there was an error.
191 extern DECLSPEC int SDLCALL SDL_SaveBMP_RW
192 (SDL_Surface * surface, SDL_RWops * dst, int freedst);
195 * Save a surface to a file.
199 #define SDL_SaveBMP(surface, file) \
200 SDL_SaveBMP_RW(surface, SDL_RWFromFile(file, "wb"), 1)
203 * \brief Sets the RLE acceleration hint for a surface.
205 * \return 0 on success, or -1 if the surface is not valid
207 * \note If RLE is enabled, colorkey and alpha blending blits are much faster,
208 * but the surface must be locked before directly accessing the pixels.
210 extern DECLSPEC int SDLCALL SDL_SetSurfaceRLE(SDL_Surface * surface,
214 * \brief Sets the color key (transparent pixel) in a blittable surface.
216 * \param surface The surface to update
217 * \param flag Non-zero to enable colorkey and 0 to disable colorkey
218 * \param key The transparent pixel in the native surface format
220 * \return 0 on success, or -1 if the surface is not valid
222 * You can pass SDL_RLEACCEL to enable RLE accelerated blits.
224 extern DECLSPEC int SDLCALL SDL_SetColorKey(SDL_Surface * surface,
225 int flag, Uint32 key);
228 * \brief Gets the color key (transparent pixel) in a blittable surface.
230 * \param surface The surface to update
231 * \param key A pointer filled in with the transparent pixel in the native
234 * \return 0 on success, or -1 if the surface is not valid or colorkey is not
237 extern DECLSPEC int SDLCALL SDL_GetColorKey(SDL_Surface * surface,
241 * \brief Set an additional color value used in blit operations.
243 * \param surface The surface to update.
244 * \param r The red color value multiplied into blit operations.
245 * \param g The green color value multiplied into blit operations.
246 * \param b The blue color value multiplied into blit operations.
248 * \return 0 on success, or -1 if the surface is not valid.
250 * \sa SDL_GetSurfaceColorMod()
252 extern DECLSPEC int SDLCALL SDL_SetSurfaceColorMod(SDL_Surface * surface,
253 Uint8 r, Uint8 g, Uint8 b);
257 * \brief Get the additional color value used in blit operations.
259 * \param surface The surface to query.
260 * \param r A pointer filled in with the current red color value.
261 * \param g A pointer filled in with the current green color value.
262 * \param b A pointer filled in with the current blue color value.
264 * \return 0 on success, or -1 if the surface is not valid.
266 * \sa SDL_SetSurfaceColorMod()
268 extern DECLSPEC int SDLCALL SDL_GetSurfaceColorMod(SDL_Surface * surface,
269 Uint8 * r, Uint8 * g,
273 * \brief Set an additional alpha value used in blit operations.
275 * \param surface The surface to update.
276 * \param alpha The alpha value multiplied into blit operations.
278 * \return 0 on success, or -1 if the surface is not valid.
280 * \sa SDL_GetSurfaceAlphaMod()
282 extern DECLSPEC int SDLCALL SDL_SetSurfaceAlphaMod(SDL_Surface * surface,
286 * \brief Get the additional alpha value used in blit operations.
288 * \param surface The surface to query.
289 * \param alpha A pointer filled in with the current alpha value.
291 * \return 0 on success, or -1 if the surface is not valid.
293 * \sa SDL_SetSurfaceAlphaMod()
295 extern DECLSPEC int SDLCALL SDL_GetSurfaceAlphaMod(SDL_Surface * surface,
299 * \brief Set the blend mode used for blit operations.
301 * \param surface The surface to update.
302 * \param blendMode ::SDL_BlendMode to use for blit blending.
304 * \return 0 on success, or -1 if the parameters are not valid.
306 * \sa SDL_GetSurfaceBlendMode()
308 extern DECLSPEC int SDLCALL SDL_SetSurfaceBlendMode(SDL_Surface * surface,
309 SDL_BlendMode blendMode);
312 * \brief Get the blend mode used for blit operations.
314 * \param surface The surface to query.
315 * \param blendMode A pointer filled in with the current blend mode.
317 * \return 0 on success, or -1 if the surface is not valid.
319 * \sa SDL_SetSurfaceBlendMode()
321 extern DECLSPEC int SDLCALL SDL_GetSurfaceBlendMode(SDL_Surface * surface,
322 SDL_BlendMode *blendMode);
325 * Sets the clipping rectangle for the destination surface in a blit.
327 * If the clip rectangle is NULL, clipping will be disabled.
329 * If the clip rectangle doesn't intersect the surface, the function will
330 * return SDL_FALSE and blits will be completely clipped. Otherwise the
331 * function returns SDL_TRUE and blits to the surface will be clipped to
332 * the intersection of the surface area and the clipping rectangle.
334 * Note that blits are automatically clipped to the edges of the source
335 * and destination surfaces.
337 extern DECLSPEC SDL_bool SDLCALL SDL_SetClipRect(SDL_Surface * surface,
338 const SDL_Rect * rect);
341 * Gets the clipping rectangle for the destination surface in a blit.
343 * \c rect must be a pointer to a valid rectangle which will be filled
344 * with the correct values.
346 extern DECLSPEC void SDLCALL SDL_GetClipRect(SDL_Surface * surface,
350 * Creates a new surface of the specified format, and then copies and maps
351 * the given surface to it so the blit of the converted surface will be as
352 * fast as possible. If this function fails, it returns NULL.
354 * The \c flags parameter is passed to SDL_CreateRGBSurface() and has those
355 * semantics. You can also pass ::SDL_RLEACCEL in the flags parameter and
356 * SDL will try to RLE accelerate colorkey and alpha blits in the resulting
359 extern DECLSPEC SDL_Surface *SDLCALL SDL_ConvertSurface
360 (SDL_Surface * src, const SDL_PixelFormat * fmt, Uint32 flags);
361 extern DECLSPEC SDL_Surface *SDLCALL SDL_ConvertSurfaceFormat
362 (SDL_Surface * src, Uint32 pixel_format, Uint32 flags);
365 * \brief Copy a block of pixels of one format to another format
367 * \return 0 on success, or -1 if there was an error
369 extern DECLSPEC int SDLCALL SDL_ConvertPixels(int width, int height,
371 const void * src, int src_pitch,
373 void * dst, int dst_pitch);
376 * Performs a fast fill of the given rectangle with \c color.
378 * If \c rect is NULL, the whole surface will be filled with \c color.
380 * The color should be a pixel of the format used by the surface, and
381 * can be generated by the SDL_MapRGB() function.
383 * \return 0 on success, or -1 on error.
385 extern DECLSPEC int SDLCALL SDL_FillRect
386 (SDL_Surface * dst, const SDL_Rect * rect, Uint32 color);
387 extern DECLSPEC int SDLCALL SDL_FillRects
388 (SDL_Surface * dst, const SDL_Rect * rects, int count, Uint32 color);
391 * Performs a fast blit from the source surface to the destination surface.
393 * This assumes that the source and destination rectangles are
394 * the same size. If either \c srcrect or \c dstrect are NULL, the entire
395 * surface (\c src or \c dst) is copied. The final blit rectangles are saved
396 * in \c srcrect and \c dstrect after all clipping is performed.
398 * \return If the blit is successful, it returns 0, otherwise it returns -1.
400 * The blit function should not be called on a locked surface.
402 * The blit semantics for surfaces with and without blending and colorkey
403 * are defined as follows:
406 Source surface blend mode set to SDL_BLENDMODE_BLEND:
407 alpha-blend (using the source alpha-channel and per-surface alpha)
408 SDL_SRCCOLORKEY ignored.
409 Source surface blend mode set to SDL_BLENDMODE_NONE:
411 if SDL_SRCCOLORKEY set, only copy the pixels matching the
412 RGB values of the source color key, ignoring alpha in the
416 Source surface blend mode set to SDL_BLENDMODE_BLEND:
417 alpha-blend (using the source per-surface alpha)
418 Source surface blend mode set to SDL_BLENDMODE_NONE:
419 copy RGB, set destination alpha to source per-surface alpha value.
421 if SDL_SRCCOLORKEY set, only copy the pixels matching the
425 Source surface blend mode set to SDL_BLENDMODE_BLEND:
426 alpha-blend (using the source alpha-channel and per-surface alpha)
427 SDL_SRCCOLORKEY ignored.
428 Source surface blend mode set to SDL_BLENDMODE_NONE:
429 copy all of RGBA to the destination.
430 if SDL_SRCCOLORKEY set, only copy the pixels matching the
431 RGB values of the source color key, ignoring alpha in the
435 Source surface blend mode set to SDL_BLENDMODE_BLEND:
436 alpha-blend (using the source per-surface alpha)
437 Source surface blend mode set to SDL_BLENDMODE_NONE:
440 if SDL_SRCCOLORKEY set, only copy the pixels matching the
444 * You should call SDL_BlitSurface() unless you know exactly how SDL
445 * blitting works internally and how to use the other blit functions.
447 #define SDL_BlitSurface SDL_UpperBlit
450 * This is the public blit function, SDL_BlitSurface(), and it performs
451 * rectangle validation and clipping before passing it to SDL_LowerBlit()
453 extern DECLSPEC int SDLCALL SDL_UpperBlit
454 (SDL_Surface * src, const SDL_Rect * srcrect,
455 SDL_Surface * dst, SDL_Rect * dstrect);
458 * This is a semi-private blit function and it performs low-level surface
461 extern DECLSPEC int SDLCALL SDL_LowerBlit
462 (SDL_Surface * src, SDL_Rect * srcrect,
463 SDL_Surface * dst, SDL_Rect * dstrect);
466 * \brief Perform a fast, low quality, stretch blit between two surfaces of the
469 * \note This function uses a static buffer, and is not thread-safe.
471 extern DECLSPEC int SDLCALL SDL_SoftStretch(SDL_Surface * src,
472 const SDL_Rect * srcrect,
474 const SDL_Rect * dstrect);
476 #define SDL_BlitScaled SDL_UpperBlitScaled
479 * This is the public scaled blit function, SDL_BlitScaled(), and it performs
480 * rectangle validation and clipping before passing it to SDL_LowerBlitScaled()
482 extern DECLSPEC int SDLCALL SDL_UpperBlitScaled
483 (SDL_Surface * src, const SDL_Rect * srcrect,
484 SDL_Surface * dst, SDL_Rect * dstrect);
487 * This is a semi-private blit function and it performs low-level surface
488 * scaled blitting only.
490 extern DECLSPEC int SDLCALL SDL_LowerBlitScaled
491 (SDL_Surface * src, SDL_Rect * srcrect,
492 SDL_Surface * dst, SDL_Rect * dstrect);
495 /* Ends C function definitions when using C++ */
499 #include "close_code.h"
501 #endif /* _SDL_surface_h */
503 /* vi: set ts=4 sw=4 expandtab: */