SDL  2.0
SDL_surface.h
Go to the documentation of this file.
1 /*
2  Simple DirectMedia Layer
3  Copyright (C) 1997-2020 Sam Lantinga <slouken@libsdl.org>
4 
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.
8 
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:
12 
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.
20 */
21 
22 /**
23  * \file SDL_surface.h
24  *
25  * Header file for ::SDL_Surface definition and management functions.
26  */
27 
28 #ifndef SDL_surface_h_
29 #define SDL_surface_h_
30 
31 #include "SDL_stdinc.h"
32 #include "SDL_pixels.h"
33 #include "SDL_rect.h"
34 #include "SDL_blendmode.h"
35 #include "SDL_rwops.h"
36 
37 #include "begin_code.h"
38 /* Set up for C function definitions, even when using C++ */
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42 
43 /**
44  * \name Surface flags
45  *
46  * These are the currently supported flags for the ::SDL_Surface.
47  *
48  * \internal
49  * Used internally (read-only).
50  */
51 /* @{ */
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 #define SDL_SIMD_ALIGNED 0x00000008 /**< Surface uses aligned memory */
57 /* @} *//* Surface flags */
58 
59 /**
60  * Evaluates to true if the surface needs to be locked before access.
61  */
62 #define SDL_MUSTLOCK(S) (((S)->flags & SDL_RLEACCEL) != 0)
63 
64 /**
65  * \brief A collection of pixels used in software blitting.
66  *
67  * \note This structure should be treated as read-only, except for \c pixels,
68  * which, if not NULL, contains the raw pixel data for the surface.
69  */
70 typedef struct SDL_Surface
71 {
72  Uint32 flags; /**< Read-only */
73  SDL_PixelFormat *format; /**< Read-only */
74  int w, h; /**< Read-only */
75  int pitch; /**< Read-only */
76  void *pixels; /**< Read-write */
77 
78  /** Application data associated with the surface */
79  void *userdata; /**< Read-write */
80 
81  /** information needed for surfaces requiring locks */
82  int locked; /**< Read-only */
83 
84  /** list of BlitMap that hold a reference to this surface */
85  void *list_blitmap; /**< Private */
86 
87  /** clipping information */
88  SDL_Rect clip_rect; /**< Read-only */
89 
90  /** info for fast blit mapping to other surfaces */
91  struct SDL_BlitMap *map; /**< Private */
92 
93  /** Reference count -- used when freeing surface */
94  int refcount; /**< Read-mostly */
95 } SDL_Surface;
96 
97 /**
98  * \brief The type of function used for surface blitting functions.
99  */
100 typedef int (SDLCALL *SDL_blit) (struct SDL_Surface * src, SDL_Rect * srcrect,
101  struct SDL_Surface * dst, SDL_Rect * dstrect);
102 
103 /**
104  * \brief The formula used for converting between YUV and RGB
105  */
106 typedef enum
107 {
108  SDL_YUV_CONVERSION_JPEG, /**< Full range JPEG */
109  SDL_YUV_CONVERSION_BT601, /**< BT.601 (the default) */
110  SDL_YUV_CONVERSION_BT709, /**< BT.709 */
111  SDL_YUV_CONVERSION_AUTOMATIC /**< BT.601 for SD content, BT.709 for HD content */
113 
114 /**
115  * Allocate and free an RGB surface.
116  *
117  * If the depth is 4 or 8 bits, an empty palette is allocated for the surface.
118  * If the depth is greater than 8 bits, the pixel format is set using the
119  * flags '[RGB]mask'.
120  *
121  * If the function runs out of memory, it will return NULL.
122  *
123  * \param flags The \c flags are obsolete and should be set to 0.
124  * \param width The width in pixels of the surface to create.
125  * \param height The height in pixels of the surface to create.
126  * \param depth The depth in bits of the surface to create.
127  * \param Rmask The red mask of the surface to create.
128  * \param Gmask The green mask of the surface to create.
129  * \param Bmask The blue mask of the surface to create.
130  * \param Amask The alpha mask of the surface to create.
131  */
132 extern DECLSPEC SDL_Surface *SDLCALL SDL_CreateRGBSurface
133  (Uint32 flags, int width, int height, int depth,
134  Uint32 Rmask, Uint32 Gmask, Uint32 Bmask, Uint32 Amask);
135 
136 /* !!! FIXME for 2.1: why does this ask for depth? Format provides that. */
137 extern DECLSPEC SDL_Surface *SDLCALL SDL_CreateRGBSurfaceWithFormat
138  (Uint32 flags, int width, int height, int depth, Uint32 format);
139 
140 extern DECLSPEC SDL_Surface *SDLCALL SDL_CreateRGBSurfaceFrom(void *pixels,
141  int width,
142  int height,
143  int depth,
144  int pitch,
145  Uint32 Rmask,
146  Uint32 Gmask,
147  Uint32 Bmask,
148  Uint32 Amask);
149 extern DECLSPEC SDL_Surface *SDLCALL SDL_CreateRGBSurfaceWithFormatFrom
150  (void *pixels, int width, int height, int depth, int pitch, Uint32 format);
151 extern DECLSPEC void SDLCALL SDL_FreeSurface(SDL_Surface * surface);
152 
153 /**
154  * \brief Set the palette used by a surface.
155  *
156  * \return 0, or -1 if the surface format doesn't use a palette.
157  *
158  * \note A single palette can be shared with many surfaces.
159  */
160 extern DECLSPEC int SDLCALL SDL_SetSurfacePalette(SDL_Surface * surface,
161  SDL_Palette * palette);
162 
163 /**
164  * \brief Sets up a surface for directly accessing the pixels.
165  *
166  * Between calls to SDL_LockSurface() / SDL_UnlockSurface(), you can write
167  * to and read from \c surface->pixels, using the pixel format stored in
168  * \c surface->format. Once you are done accessing the surface, you should
169  * use SDL_UnlockSurface() to release it.
170  *
171  * Not all surfaces require locking. If SDL_MUSTLOCK(surface) evaluates
172  * to 0, then you can read and write to the surface at any time, and the
173  * pixel format of the surface will not change.
174  *
175  * No operating system or library calls should be made between lock/unlock
176  * pairs, as critical system locks may be held during this time.
177  *
178  * SDL_LockSurface() returns 0, or -1 if the surface couldn't be locked.
179  *
180  * \sa SDL_UnlockSurface()
181  */
182 extern DECLSPEC int SDLCALL SDL_LockSurface(SDL_Surface * surface);
183 /** \sa SDL_LockSurface() */
184 extern DECLSPEC void SDLCALL SDL_UnlockSurface(SDL_Surface * surface);
185 
186 /**
187  * Load a surface from a seekable SDL data stream (memory or file).
188  *
189  * If \c freesrc is non-zero, the stream will be closed after being read.
190  *
191  * The new surface should be freed with SDL_FreeSurface().
192  *
193  * \return the new surface, or NULL if there was an error.
194  */
195 extern DECLSPEC SDL_Surface *SDLCALL SDL_LoadBMP_RW(SDL_RWops * src,
196  int freesrc);
197 
198 /**
199  * Load a surface from a file.
200  *
201  * Convenience macro.
202  */
203 #define SDL_LoadBMP(file) SDL_LoadBMP_RW(SDL_RWFromFile(file, "rb"), 1)
204 
205 /**
206  * Save a surface to a seekable SDL data stream (memory or file).
207  *
208  * Surfaces with a 24-bit, 32-bit and paletted 8-bit format get saved in the
209  * BMP directly. Other RGB formats with 8-bit or higher get converted to a
210  * 24-bit surface or, if they have an alpha mask or a colorkey, to a 32-bit
211  * surface before they are saved. YUV and paletted 1-bit and 4-bit formats are
212  * not supported.
213  *
214  * If \c freedst is non-zero, the stream will be closed after being written.
215  *
216  * \return 0 if successful or -1 if there was an error.
217  */
218 extern DECLSPEC int SDLCALL SDL_SaveBMP_RW
219  (SDL_Surface * surface, SDL_RWops * dst, int freedst);
220 
221 /**
222  * Save a surface to a file.
223  *
224  * Convenience macro.
225  */
226 #define SDL_SaveBMP(surface, file) \
227  SDL_SaveBMP_RW(surface, SDL_RWFromFile(file, "wb"), 1)
228 
229 /**
230  * \brief Sets the RLE acceleration hint for a surface.
231  *
232  * \return 0 on success, or -1 if the surface is not valid
233  *
234  * \note If RLE is enabled, colorkey and alpha blending blits are much faster,
235  * but the surface must be locked before directly accessing the pixels.
236  */
237 extern DECLSPEC int SDLCALL SDL_SetSurfaceRLE(SDL_Surface * surface,
238  int flag);
239 
240 /**
241  * \brief Returns whether the surface is RLE enabled
242  *
243  * \return SDL_TRUE if the surface is RLE enabled, or SDL_FALSE if the surface is NULL or not RLE enabled
244  */
245 extern DECLSPEC SDL_bool SDLCALL SDL_HasSurfaceRLE(SDL_Surface * surface);
246 
247 /**
248  * \brief Sets the color key (transparent pixel) in a blittable surface.
249  *
250  * \param surface The surface to update
251  * \param flag Non-zero to enable colorkey and 0 to disable colorkey
252  * \param key The transparent pixel in the native surface format
253  *
254  * \return 0 on success, or -1 if the surface is not valid
255  *
256  * You can pass SDL_RLEACCEL to enable RLE accelerated blits.
257  */
258 extern DECLSPEC int SDLCALL SDL_SetColorKey(SDL_Surface * surface,
259  int flag, Uint32 key);
260 
261 /**
262  * \brief Returns whether the surface has a color key
263  *
264  * \return SDL_TRUE if the surface has a color key, or SDL_FALSE if the surface is NULL or has no color key
265  */
266 extern DECLSPEC SDL_bool SDLCALL SDL_HasColorKey(SDL_Surface * surface);
267 
268 /**
269  * \brief Gets the color key (transparent pixel) in a blittable surface.
270  *
271  * \param surface The surface to update
272  * \param key A pointer filled in with the transparent pixel in the native
273  * surface format
274  *
275  * \return 0 on success, or -1 if the surface is not valid or colorkey is not
276  * enabled.
277  */
278 extern DECLSPEC int SDLCALL SDL_GetColorKey(SDL_Surface * surface,
279  Uint32 * key);
280 
281 /**
282  * \brief Set an additional color value used in blit operations.
283  *
284  * \param surface The surface to update.
285  * \param r The red color value multiplied into blit operations.
286  * \param g The green color value multiplied into blit operations.
287  * \param b The blue color value multiplied into blit operations.
288  *
289  * \return 0 on success, or -1 if the surface is not valid.
290  *
291  * \sa SDL_GetSurfaceColorMod()
292  */
293 extern DECLSPEC int SDLCALL SDL_SetSurfaceColorMod(SDL_Surface * surface,
294  Uint8 r, Uint8 g, Uint8 b);
295 
296 
297 /**
298  * \brief Get the additional color value used in blit operations.
299  *
300  * \param surface The surface to query.
301  * \param r A pointer filled in with the current red color value.
302  * \param g A pointer filled in with the current green color value.
303  * \param b A pointer filled in with the current blue color value.
304  *
305  * \return 0 on success, or -1 if the surface is not valid.
306  *
307  * \sa SDL_SetSurfaceColorMod()
308  */
309 extern DECLSPEC int SDLCALL SDL_GetSurfaceColorMod(SDL_Surface * surface,
310  Uint8 * r, Uint8 * g,
311  Uint8 * b);
312 
313 /**
314  * \brief Set an additional alpha value used in blit operations.
315  *
316  * \param surface The surface to update.
317  * \param alpha The alpha value multiplied into blit operations.
318  *
319  * \return 0 on success, or -1 if the surface is not valid.
320  *
321  * \sa SDL_GetSurfaceAlphaMod()
322  */
323 extern DECLSPEC int SDLCALL SDL_SetSurfaceAlphaMod(SDL_Surface * surface,
324  Uint8 alpha);
325 
326 /**
327  * \brief Get the additional alpha value used in blit operations.
328  *
329  * \param surface The surface to query.
330  * \param alpha A pointer filled in with the current alpha value.
331  *
332  * \return 0 on success, or -1 if the surface is not valid.
333  *
334  * \sa SDL_SetSurfaceAlphaMod()
335  */
336 extern DECLSPEC int SDLCALL SDL_GetSurfaceAlphaMod(SDL_Surface * surface,
337  Uint8 * alpha);
338 
339 /**
340  * \brief Set the blend mode used for blit operations.
341  *
342  * \param surface The surface to update.
343  * \param blendMode ::SDL_BlendMode to use for blit blending.
344  *
345  * \return 0 on success, or -1 if the parameters are not valid.
346  *
347  * \sa SDL_GetSurfaceBlendMode()
348  */
349 extern DECLSPEC int SDLCALL SDL_SetSurfaceBlendMode(SDL_Surface * surface,
350  SDL_BlendMode blendMode);
351 
352 /**
353  * \brief Get the blend mode used for blit operations.
354  *
355  * \param surface The surface to query.
356  * \param blendMode A pointer filled in with the current blend mode.
357  *
358  * \return 0 on success, or -1 if the surface is not valid.
359  *
360  * \sa SDL_SetSurfaceBlendMode()
361  */
362 extern DECLSPEC int SDLCALL SDL_GetSurfaceBlendMode(SDL_Surface * surface,
363  SDL_BlendMode *blendMode);
364 
365 /**
366  * Sets the clipping rectangle for the destination surface in a blit.
367  *
368  * If the clip rectangle is NULL, clipping will be disabled.
369  *
370  * If the clip rectangle doesn't intersect the surface, the function will
371  * return SDL_FALSE and blits will be completely clipped. Otherwise the
372  * function returns SDL_TRUE and blits to the surface will be clipped to
373  * the intersection of the surface area and the clipping rectangle.
374  *
375  * Note that blits are automatically clipped to the edges of the source
376  * and destination surfaces.
377  */
378 extern DECLSPEC SDL_bool SDLCALL SDL_SetClipRect(SDL_Surface * surface,
379  const SDL_Rect * rect);
380 
381 /**
382  * Gets the clipping rectangle for the destination surface in a blit.
383  *
384  * \c rect must be a pointer to a valid rectangle which will be filled
385  * with the correct values.
386  */
387 extern DECLSPEC void SDLCALL SDL_GetClipRect(SDL_Surface * surface,
388  SDL_Rect * rect);
389 
390 /*
391  * Creates a new surface identical to the existing surface
392  */
393 extern DECLSPEC SDL_Surface *SDLCALL SDL_DuplicateSurface(SDL_Surface * surface);
394 
395 /**
396  * Creates a new surface of the specified format, and then copies and maps
397  * the given surface to it so the blit of the converted surface will be as
398  * fast as possible. If this function fails, it returns NULL.
399  *
400  * The \c flags parameter is passed to SDL_CreateRGBSurface() and has those
401  * semantics. You can also pass ::SDL_RLEACCEL in the flags parameter and
402  * SDL will try to RLE accelerate colorkey and alpha blits in the resulting
403  * surface.
404  */
405 extern DECLSPEC SDL_Surface *SDLCALL SDL_ConvertSurface
406  (SDL_Surface * src, const SDL_PixelFormat * fmt, Uint32 flags);
407 extern DECLSPEC SDL_Surface *SDLCALL SDL_ConvertSurfaceFormat
408  (SDL_Surface * src, Uint32 pixel_format, Uint32 flags);
409 
410 /**
411  * \brief Copy a block of pixels of one format to another format
412  *
413  * \return 0 on success, or -1 if there was an error
414  */
415 extern DECLSPEC int SDLCALL SDL_ConvertPixels(int width, int height,
416  Uint32 src_format,
417  const void * src, int src_pitch,
418  Uint32 dst_format,
419  void * dst, int dst_pitch);
420 
421 /**
422  * Performs a fast fill of the given rectangle with \c color.
423  *
424  * If \c rect is NULL, the whole surface will be filled with \c color.
425  *
426  * The color should be a pixel of the format used by the surface, and
427  * can be generated by the SDL_MapRGB() function.
428  *
429  * \return 0 on success, or -1 on error.
430  */
431 extern DECLSPEC int SDLCALL SDL_FillRect
432  (SDL_Surface * dst, const SDL_Rect * rect, Uint32 color);
433 extern DECLSPEC int SDLCALL SDL_FillRects
434  (SDL_Surface * dst, const SDL_Rect * rects, int count, Uint32 color);
435 
436 /**
437  * Performs a fast blit from the source surface to the destination surface.
438  *
439  * This assumes that the source and destination rectangles are
440  * the same size. If either \c srcrect or \c dstrect are NULL, the entire
441  * surface (\c src or \c dst) is copied. The final blit rectangles are saved
442  * in \c srcrect and \c dstrect after all clipping is performed.
443  *
444  * \return If the blit is successful, it returns 0, otherwise it returns -1.
445  *
446  * The blit function should not be called on a locked surface.
447  *
448  * The blit semantics for surfaces with and without blending and colorkey
449  * are defined as follows:
450  * \verbatim
451  RGBA->RGB:
452  Source surface blend mode set to SDL_BLENDMODE_BLEND:
453  alpha-blend (using the source alpha-channel and per-surface alpha)
454  SDL_SRCCOLORKEY ignored.
455  Source surface blend mode set to SDL_BLENDMODE_NONE:
456  copy RGB.
457  if SDL_SRCCOLORKEY set, only copy the pixels matching the
458  RGB values of the source color key, ignoring alpha in the
459  comparison.
460 
461  RGB->RGBA:
462  Source surface blend mode set to SDL_BLENDMODE_BLEND:
463  alpha-blend (using the source per-surface alpha)
464  Source surface blend mode set to SDL_BLENDMODE_NONE:
465  copy RGB, set destination alpha to source per-surface alpha value.
466  both:
467  if SDL_SRCCOLORKEY set, only copy the pixels matching the
468  source color key.
469 
470  RGBA->RGBA:
471  Source surface blend mode set to SDL_BLENDMODE_BLEND:
472  alpha-blend (using the source alpha-channel and per-surface alpha)
473  SDL_SRCCOLORKEY ignored.
474  Source surface blend mode set to SDL_BLENDMODE_NONE:
475  copy all of RGBA to the destination.
476  if SDL_SRCCOLORKEY set, only copy the pixels matching the
477  RGB values of the source color key, ignoring alpha in the
478  comparison.
479 
480  RGB->RGB:
481  Source surface blend mode set to SDL_BLENDMODE_BLEND:
482  alpha-blend (using the source per-surface alpha)
483  Source surface blend mode set to SDL_BLENDMODE_NONE:
484  copy RGB.
485  both:
486  if SDL_SRCCOLORKEY set, only copy the pixels matching the
487  source color key.
488  \endverbatim
489  *
490  * You should call SDL_BlitSurface() unless you know exactly how SDL
491  * blitting works internally and how to use the other blit functions.
492  */
493 #define SDL_BlitSurface SDL_UpperBlit
494 
495 /**
496  * This is the public blit function, SDL_BlitSurface(), and it performs
497  * rectangle validation and clipping before passing it to SDL_LowerBlit()
498  */
499 extern DECLSPEC int SDLCALL SDL_UpperBlit
500  (SDL_Surface * src, const SDL_Rect * srcrect,
501  SDL_Surface * dst, SDL_Rect * dstrect);
502 
503 /**
504  * This is a semi-private blit function and it performs low-level surface
505  * blitting only.
506  */
507 extern DECLSPEC int SDLCALL SDL_LowerBlit
508  (SDL_Surface * src, SDL_Rect * srcrect,
509  SDL_Surface * dst, SDL_Rect * dstrect);
510 
511 /**
512  * \brief Perform a fast, low quality, stretch blit between two surfaces of the
513  * same pixel format.
514  *
515  * \note This function uses a static buffer, and is not thread-safe.
516  */
517 extern DECLSPEC int SDLCALL SDL_SoftStretch(SDL_Surface * src,
518  const SDL_Rect * srcrect,
519  SDL_Surface * dst,
520  const SDL_Rect * dstrect);
521 
522 #define SDL_BlitScaled SDL_UpperBlitScaled
523 
524 /**
525  * This is the public scaled blit function, SDL_BlitScaled(), and it performs
526  * rectangle validation and clipping before passing it to SDL_LowerBlitScaled()
527  */
528 extern DECLSPEC int SDLCALL SDL_UpperBlitScaled
529  (SDL_Surface * src, const SDL_Rect * srcrect,
530  SDL_Surface * dst, SDL_Rect * dstrect);
531 
532 /**
533  * This is a semi-private blit function and it performs low-level surface
534  * scaled blitting only.
535  */
536 extern DECLSPEC int SDLCALL SDL_LowerBlitScaled
537  (SDL_Surface * src, SDL_Rect * srcrect,
538  SDL_Surface * dst, SDL_Rect * dstrect);
539 
540 /**
541  * \brief Set the YUV conversion mode
542  */
543 extern DECLSPEC void SDLCALL SDL_SetYUVConversionMode(SDL_YUV_CONVERSION_MODE mode);
544 
545 /**
546  * \brief Get the YUV conversion mode
547  */
548 extern DECLSPEC SDL_YUV_CONVERSION_MODE SDLCALL SDL_GetYUVConversionMode(void);
549 
550 /**
551  * \brief Get the YUV conversion mode, returning the correct mode for the resolution when the current conversion mode is SDL_YUV_CONVERSION_AUTOMATIC
552  */
553 extern DECLSPEC SDL_YUV_CONVERSION_MODE SDLCALL SDL_GetYUVConversionModeForResolution(int width, int height);
554 
555 /* Ends C function definitions when using C++ */
556 #ifdef __cplusplus
557 }
558 #endif
559 #include "close_code.h"
560 
561 #endif /* SDL_surface_h_ */
562 
563 /* vi: set ts=4 sw=4 expandtab: */
SDL_Surface * SDL_CreateRGBSurfaceWithFormatFrom(void *pixels, int width, int height, int depth, int pitch, Uint32 format)
int SDL_GetSurfaceColorMod(SDL_Surface *surface, Uint8 *r, Uint8 *g, Uint8 *b)
Get the additional color value used in blit operations.
void SDL_FreeSurface(SDL_Surface *surface)
int SDL_LockSurface(SDL_Surface *surface)
Sets up a surface for directly accessing the pixels.
SDL_Surface * SDL_CreateRGBSurfaceFrom(void *pixels, int width, int height, int depth, int pitch, Uint32 Rmask, Uint32 Gmask, Uint32 Bmask, Uint32 Amask)
SDL_YUV_CONVERSION_MODE
The formula used for converting between YUV and RGB.
Definition: SDL_surface.h:106
SDL_BlendMode
The blend mode used in SDL_RenderCopy() and drawing operations.
Definition: SDL_blendmode.h:40
SDL_bool
Definition: SDL_stdinc.h:167
int SDL_SetSurfaceRLE(SDL_Surface *surface, int flag)
Sets the RLE acceleration hint for a surface.
int(* SDL_blit)(struct SDL_Surface *src, SDL_Rect *srcrect, struct SDL_Surface *dst, SDL_Rect *dstrect)
The type of function used for surface blitting functions.
Definition: SDL_surface.h:100
int SDL_UpperBlit(SDL_Surface *src, const SDL_Rect *srcrect, SDL_Surface *dst, SDL_Rect *dstrect)
SDL_Surface * SDL_CreateRGBSurfaceWithFormat(Uint32 flags, int width, int height, int depth, Uint32 format)
A collection of pixels used in software blitting.
Definition: SDL_surface.h:70
int SDL_SaveBMP_RW(SDL_Surface *surface, SDL_RWops *dst, int freedst)
uint32_t Uint32
Definition: SDL_stdinc.h:209
int SDL_ConvertPixels(int width, int height, Uint32 src_format, const void *src, int src_pitch, Uint32 dst_format, void *dst, int dst_pitch)
Copy a block of pixels of one format to another format.
int SDL_SoftStretch(SDL_Surface *src, const SDL_Rect *srcrect, SDL_Surface *dst, const SDL_Rect *dstrect)
Perform a fast, low quality, stretch blit between two surfaces of the same pixel format.
SDL_bool SDL_HasSurfaceRLE(SDL_Surface *surface)
Returns whether the surface is RLE enabled.
int SDL_GetSurfaceAlphaMod(SDL_Surface *surface, Uint8 *alpha)
Get the additional alpha value used in blit operations.
Uint32 flags
Definition: SDL_surface.h:72
int SDL_SetSurfaceColorMod(SDL_Surface *surface, Uint8 r, Uint8 g, Uint8 b)
Set an additional color value used in blit operations.
struct SDL_BlitMap * map
Definition: SDL_surface.h:91
SDL_bool SDL_SetClipRect(SDL_Surface *surface, const SDL_Rect *rect)
SDL_Surface * SDL_CreateRGBSurface(Uint32 flags, int width, int height, int depth, Uint32 Rmask, Uint32 Gmask, Uint32 Bmask, Uint32 Amask)
void * pixels
Definition: SDL_surface.h:76
void * list_blitmap
Definition: SDL_surface.h:85
void SDL_GetClipRect(SDL_Surface *surface, SDL_Rect *rect)
int SDL_LowerBlit(SDL_Surface *src, SDL_Rect *srcrect, SDL_Surface *dst, SDL_Rect *dstrect)
int SDL_SetColorKey(SDL_Surface *surface, int flag, Uint32 key)
Sets the color key (transparent pixel) in a blittable surface.
int SDL_SetSurfacePalette(SDL_Surface *surface, SDL_Palette *palette)
Set the palette used by a surface.
int SDL_GetSurfaceBlendMode(SDL_Surface *surface, SDL_BlendMode *blendMode)
Get the blend mode used for blit operations.
int SDL_LowerBlitScaled(SDL_Surface *src, SDL_Rect *srcrect, SDL_Surface *dst, SDL_Rect *dstrect)
SDL_bool SDL_HasColorKey(SDL_Surface *surface)
Returns whether the surface has a color key.
int SDL_FillRect(SDL_Surface *dst, const SDL_Rect *rect, Uint32 color)
SDL_YUV_CONVERSION_MODE SDL_GetYUVConversionMode(void)
Get the YUV conversion mode.
SDL_Rect clip_rect
Definition: SDL_surface.h:88
SDL_PixelFormat * format
Definition: SDL_surface.h:73
void SDL_SetYUVConversionMode(SDL_YUV_CONVERSION_MODE mode)
Set the YUV conversion mode.
int SDL_FillRects(SDL_Surface *dst, const SDL_Rect *rects, int count, Uint32 color)
SDL_YUV_CONVERSION_MODE SDL_GetYUVConversionModeForResolution(int width, int height)
Get the YUV conversion mode, returning the correct mode for the resolution when the current conversio...
int SDL_SetSurfaceAlphaMod(SDL_Surface *surface, Uint8 alpha)
Set an additional alpha value used in blit operations.
int SDL_UpperBlitScaled(SDL_Surface *src, const SDL_Rect *srcrect, SDL_Surface *dst, SDL_Rect *dstrect)
void SDL_UnlockSurface(SDL_Surface *surface)
SDL_Surface * SDL_DuplicateSurface(SDL_Surface *surface)
int SDL_GetColorKey(SDL_Surface *surface, Uint32 *key)
Gets the color key (transparent pixel) in a blittable surface.
SDL_Surface * SDL_ConvertSurfaceFormat(SDL_Surface *src, Uint32 pixel_format, Uint32 flags)
SDL_Surface * SDL_LoadBMP_RW(SDL_RWops *src, int freesrc)
uint8_t Uint8
Definition: SDL_stdinc.h:185
void * userdata
Definition: SDL_surface.h:79
SDL_Surface * SDL_ConvertSurface(SDL_Surface *src, const SDL_PixelFormat *fmt, Uint32 flags)
A rectangle, with the origin at the upper left (integer).
Definition: SDL_rect.h:77
int SDL_SetSurfaceBlendMode(SDL_Surface *surface, SDL_BlendMode blendMode)
Set the blend mode used for blit operations.