My Project
|
#include "SDL_stdinc.h"
#include "SDL_pixels.h"
#include "SDL_rect.h"
#include "SDL_blendmode.h"
#include "SDL_rwops.h"
#include "begin_code.h"
#include "close_code.h"
Go to the source code of this file.
Classes | |
struct | SDL_Surface |
A collection of pixels used in software blitting. More... | |
Macros | |
#define | SDL_MUSTLOCK(S) (((S)->flags & SDL_RLEACCEL) != 0) |
#define | SDL_LoadBMP(file) SDL_LoadBMP_RW(SDL_RWFromFile(file, "rb"), 1) |
#define | SDL_SaveBMP(surface, file) SDL_SaveBMP_RW(surface, SDL_RWFromFile(file, "wb"), 1) |
#define | SDL_BlitSurface SDL_UpperBlit |
#define | SDL_BlitScaled SDL_UpperBlitScaled |
Surface flags | |
These are the currently supported flags for the SDL_Surface. | |
#define | SDL_SWSURFACE 0 |
#define | SDL_PREALLOC 0x00000001 |
#define | SDL_RLEACCEL 0x00000002 |
#define | SDL_DONTFREE 0x00000004 |
Typedefs | |
typedef struct SDL_Surface | SDL_Surface |
A collection of pixels used in software blitting. More... | |
typedef int(SDLCALL * | 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. | |
Enumerations | |
enum | SDL_YUV_CONVERSION_MODE { SDL_YUV_CONVERSION_JPEG, SDL_YUV_CONVERSION_BT601, SDL_YUV_CONVERSION_BT709, SDL_YUV_CONVERSION_AUTOMATIC } |
The formula used for converting between YUV and RGB. More... | |
Functions | |
DECLSPEC SDL_Surface *SDLCALL | SDL_CreateRGBSurface (Uint32 flags, int width, int height, int depth, Uint32 Rmask, Uint32 Gmask, Uint32 Bmask, Uint32 Amask) |
DECLSPEC SDL_Surface *SDLCALL | SDL_CreateRGBSurfaceWithFormat (Uint32 flags, int width, int height, int depth, Uint32 format) |
DECLSPEC SDL_Surface *SDLCALL | SDL_CreateRGBSurfaceFrom (void *pixels, int width, int height, int depth, int pitch, Uint32 Rmask, Uint32 Gmask, Uint32 Bmask, Uint32 Amask) |
DECLSPEC SDL_Surface *SDLCALL | SDL_CreateRGBSurfaceWithFormatFrom (void *pixels, int width, int height, int depth, int pitch, Uint32 format) |
DECLSPEC void SDLCALL | SDL_FreeSurface (SDL_Surface *surface) |
DECLSPEC int SDLCALL | SDL_SetSurfacePalette (SDL_Surface *surface, SDL_Palette *palette) |
Set the palette used by a surface. More... | |
DECLSPEC int SDLCALL | SDL_LockSurface (SDL_Surface *surface) |
Sets up a surface for directly accessing the pixels. More... | |
DECLSPEC void SDLCALL | SDL_UnlockSurface (SDL_Surface *surface) |
DECLSPEC SDL_Surface *SDLCALL | SDL_LoadBMP_RW (SDL_RWops *src, int freesrc) |
DECLSPEC int SDLCALL | SDL_SaveBMP_RW (SDL_Surface *surface, SDL_RWops *dst, int freedst) |
DECLSPEC int SDLCALL | SDL_SetSurfaceRLE (SDL_Surface *surface, int flag) |
Sets the RLE acceleration hint for a surface. More... | |
DECLSPEC int SDLCALL | SDL_SetColorKey (SDL_Surface *surface, int flag, Uint32 key) |
Sets the color key (transparent pixel) in a blittable surface. More... | |
DECLSPEC SDL_bool SDLCALL | SDL_HasColorKey (SDL_Surface *surface) |
Returns whether the surface has a color key. More... | |
DECLSPEC int SDLCALL | SDL_GetColorKey (SDL_Surface *surface, Uint32 *key) |
Gets the color key (transparent pixel) in a blittable surface. More... | |
DECLSPEC int SDLCALL | SDL_SetSurfaceColorMod (SDL_Surface *surface, Uint8 r, Uint8 g, Uint8 b) |
Set an additional color value used in blit operations. More... | |
DECLSPEC int SDLCALL | SDL_GetSurfaceColorMod (SDL_Surface *surface, Uint8 *r, Uint8 *g, Uint8 *b) |
Get the additional color value used in blit operations. More... | |
DECLSPEC int SDLCALL | SDL_SetSurfaceAlphaMod (SDL_Surface *surface, Uint8 alpha) |
Set an additional alpha value used in blit operations. More... | |
DECLSPEC int SDLCALL | SDL_GetSurfaceAlphaMod (SDL_Surface *surface, Uint8 *alpha) |
Get the additional alpha value used in blit operations. More... | |
DECLSPEC int SDLCALL | SDL_SetSurfaceBlendMode (SDL_Surface *surface, SDL_BlendMode blendMode) |
Set the blend mode used for blit operations. More... | |
DECLSPEC int SDLCALL | SDL_GetSurfaceBlendMode (SDL_Surface *surface, SDL_BlendMode *blendMode) |
Get the blend mode used for blit operations. More... | |
DECLSPEC SDL_bool SDLCALL | SDL_SetClipRect (SDL_Surface *surface, const SDL_Rect *rect) |
DECLSPEC void SDLCALL | SDL_GetClipRect (SDL_Surface *surface, SDL_Rect *rect) |
DECLSPEC SDL_Surface *SDLCALL | SDL_DuplicateSurface (SDL_Surface *surface) |
DECLSPEC SDL_Surface *SDLCALL | SDL_ConvertSurface (SDL_Surface *src, const SDL_PixelFormat *fmt, Uint32 flags) |
DECLSPEC SDL_Surface *SDLCALL | SDL_ConvertSurfaceFormat (SDL_Surface *src, Uint32 pixel_format, Uint32 flags) |
DECLSPEC int SDLCALL | 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. More... | |
DECLSPEC int SDLCALL | SDL_FillRect (SDL_Surface *dst, const SDL_Rect *rect, Uint32 color) |
DECLSPEC int SDLCALL | SDL_FillRects (SDL_Surface *dst, const SDL_Rect *rects, int count, Uint32 color) |
DECLSPEC int SDLCALL | SDL_UpperBlit (SDL_Surface *src, const SDL_Rect *srcrect, SDL_Surface *dst, SDL_Rect *dstrect) |
DECLSPEC int SDLCALL | SDL_LowerBlit (SDL_Surface *src, SDL_Rect *srcrect, SDL_Surface *dst, SDL_Rect *dstrect) |
DECLSPEC int SDLCALL | 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. More... | |
DECLSPEC int SDLCALL | SDL_UpperBlitScaled (SDL_Surface *src, const SDL_Rect *srcrect, SDL_Surface *dst, SDL_Rect *dstrect) |
DECLSPEC int SDLCALL | SDL_LowerBlitScaled (SDL_Surface *src, SDL_Rect *srcrect, SDL_Surface *dst, SDL_Rect *dstrect) |
DECLSPEC void SDLCALL | SDL_SetYUVConversionMode (SDL_YUV_CONVERSION_MODE mode) |
Set the YUV conversion mode. | |
DECLSPEC SDL_YUV_CONVERSION_MODE SDLCALL | SDL_GetYUVConversionMode (void) |
Get the YUV conversion mode. | |
DECLSPEC SDL_YUV_CONVERSION_MODE SDLCALL | SDL_GetYUVConversionModeForResolution (int width, int height) |
Get the YUV conversion mode, returning the correct mode for the resolution when the current conversion mode is SDL_YUV_CONVERSION_AUTOMATIC. | |
Header file for SDL_Surface definition and management functions.
#define SDL_BlitSurface SDL_UpperBlit |
Performs a fast blit from the source surface to the destination surface.
This assumes that the source and destination rectangles are the same size. If either srcrect
or dstrect
are NULL, the entire surface (src
or dst
) is copied. The final blit rectangles are saved in srcrect
and dstrect
after all clipping is performed.
The blit function should not be called on a locked surface.
The blit semantics for surfaces with and without blending and colorkey are defined as follows:
RGBA->RGB: Source surface blend mode set to SDL_BLENDMODE_BLEND: alpha-blend (using the source alpha-channel and per-surface alpha) SDL_SRCCOLORKEY ignored. Source surface blend mode set to SDL_BLENDMODE_NONE: copy RGB. if SDL_SRCCOLORKEY set, only copy the pixels matching the RGB values of the source color key, ignoring alpha in the comparison. RGB->RGBA: Source surface blend mode set to SDL_BLENDMODE_BLEND: alpha-blend (using the source per-surface alpha) Source surface blend mode set to SDL_BLENDMODE_NONE: copy RGB, set destination alpha to source per-surface alpha value. both: if SDL_SRCCOLORKEY set, only copy the pixels matching the source color key. RGBA->RGBA: Source surface blend mode set to SDL_BLENDMODE_BLEND: alpha-blend (using the source alpha-channel and per-surface alpha) SDL_SRCCOLORKEY ignored. Source surface blend mode set to SDL_BLENDMODE_NONE: copy all of RGBA to the destination. if SDL_SRCCOLORKEY set, only copy the pixels matching the RGB values of the source color key, ignoring alpha in the comparison. RGB->RGB: Source surface blend mode set to SDL_BLENDMODE_BLEND: alpha-blend (using the source per-surface alpha) Source surface blend mode set to SDL_BLENDMODE_NONE: copy RGB. both: if SDL_SRCCOLORKEY set, only copy the pixels matching the source color key.
You should call SDL_BlitSurface() unless you know exactly how SDL blitting works internally and how to use the other blit functions.
#define SDL_DONTFREE 0x00000004 |
Surface is referenced internally
#define SDL_LoadBMP | ( | file | ) | SDL_LoadBMP_RW(SDL_RWFromFile(file, "rb"), 1) |
Load a surface from a file.
Convenience macro.
#define SDL_MUSTLOCK | ( | S | ) | (((S)->flags & SDL_RLEACCEL) != 0) |
Evaluates to true if the surface needs to be locked before access.
#define SDL_PREALLOC 0x00000001 |
Surface uses preallocated memory
#define SDL_RLEACCEL 0x00000002 |
Surface is RLE encoded
#define SDL_SaveBMP | ( | surface, | |
file | |||
) | SDL_SaveBMP_RW(surface, SDL_RWFromFile(file, "wb"), 1) |
Save a surface to a file.
Convenience macro.
#define SDL_SWSURFACE 0 |
Just here for compatibility
typedef struct SDL_Surface SDL_Surface |
A collection of pixels used in software blitting.
pixels
, which, if not NULL, contains the raw pixel data for the surface. DECLSPEC int SDLCALL 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.
DECLSPEC SDL_Surface* SDLCALL SDL_ConvertSurface | ( | SDL_Surface * | src, |
const SDL_PixelFormat * | fmt, | ||
Uint32 | flags | ||
) |
Creates a new surface of the specified format, and then copies and maps the given surface to it so the blit of the converted surface will be as fast as possible. If this function fails, it returns NULL.
The flags
parameter is passed to SDL_CreateRGBSurface() and has those semantics. You can also pass SDL_RLEACCEL in the flags parameter and SDL will try to RLE accelerate colorkey and alpha blits in the resulting surface.
DECLSPEC SDL_Surface* SDLCALL SDL_CreateRGBSurface | ( | Uint32 | flags, |
int | width, | ||
int | height, | ||
int | depth, | ||
Uint32 | Rmask, | ||
Uint32 | Gmask, | ||
Uint32 | Bmask, | ||
Uint32 | Amask | ||
) |
Allocate and free an RGB surface.
If the depth is 4 or 8 bits, an empty palette is allocated for the surface. If the depth is greater than 8 bits, the pixel format is set using the flags '[RGB]mask'.
If the function runs out of memory, it will return NULL.
flags | The flags are obsolete and should be set to 0. |
width | The width in pixels of the surface to create. |
height | The height in pixels of the surface to create. |
depth | The depth in bits of the surface to create. |
Rmask | The red mask of the surface to create. |
Gmask | The green mask of the surface to create. |
Bmask | The blue mask of the surface to create. |
Amask | The alpha mask of the surface to create. |
DECLSPEC int SDLCALL SDL_FillRect | ( | SDL_Surface * | dst, |
const SDL_Rect * | rect, | ||
Uint32 | color | ||
) |
Performs a fast fill of the given rectangle with color
.
If rect
is NULL, the whole surface will be filled with color
.
The color should be a pixel of the format used by the surface, and can be generated by the SDL_MapRGB() function.
DECLSPEC void SDLCALL SDL_GetClipRect | ( | SDL_Surface * | surface, |
SDL_Rect * | rect | ||
) |
Gets the clipping rectangle for the destination surface in a blit.
rect
must be a pointer to a valid rectangle which will be filled with the correct values.
DECLSPEC int SDLCALL SDL_GetColorKey | ( | SDL_Surface * | surface, |
Uint32 * | key | ||
) |
Gets the color key (transparent pixel) in a blittable surface.
surface | The surface to update |
key | A pointer filled in with the transparent pixel in the native surface format |
DECLSPEC int SDLCALL SDL_GetSurfaceAlphaMod | ( | SDL_Surface * | surface, |
Uint8 * | alpha | ||
) |
Get the additional alpha value used in blit operations.
surface | The surface to query. |
alpha | A pointer filled in with the current alpha value. |
DECLSPEC int SDLCALL SDL_GetSurfaceBlendMode | ( | SDL_Surface * | surface, |
SDL_BlendMode * | blendMode | ||
) |
Get the blend mode used for blit operations.
surface | The surface to query. |
blendMode | A pointer filled in with the current blend mode. |
DECLSPEC int SDLCALL SDL_GetSurfaceColorMod | ( | SDL_Surface * | surface, |
Uint8 * | r, | ||
Uint8 * | g, | ||
Uint8 * | b | ||
) |
Get the additional color value used in blit operations.
surface | The surface to query. |
r | A pointer filled in with the current red color value. |
g | A pointer filled in with the current green color value. |
b | A pointer filled in with the current blue color value. |
DECLSPEC SDL_bool SDLCALL SDL_HasColorKey | ( | SDL_Surface * | surface | ) |
Returns whether the surface has a color key.
DECLSPEC SDL_Surface* SDLCALL SDL_LoadBMP_RW | ( | SDL_RWops * | src, |
int | freesrc | ||
) |
Load a surface from a seekable SDL data stream (memory or file).
If freesrc
is non-zero, the stream will be closed after being read.
The new surface should be freed with SDL_FreeSurface().
DECLSPEC int SDLCALL SDL_LockSurface | ( | SDL_Surface * | surface | ) |
Sets up a surface for directly accessing the pixels.
Between calls to SDL_LockSurface() / SDL_UnlockSurface(), you can write to and read from surface->pixels
, using the pixel format stored in surface->format
. Once you are done accessing the surface, you should use SDL_UnlockSurface() to release it.
Not all surfaces require locking. If SDL_MUSTLOCK(surface) evaluates to 0, then you can read and write to the surface at any time, and the pixel format of the surface will not change.
No operating system or library calls should be made between lock/unlock pairs, as critical system locks may be held during this time.
SDL_LockSurface() returns 0, or -1 if the surface couldn't be locked.
DECLSPEC int SDLCALL SDL_LowerBlit | ( | SDL_Surface * | src, |
SDL_Rect * | srcrect, | ||
SDL_Surface * | dst, | ||
SDL_Rect * | dstrect | ||
) |
This is a semi-private blit function and it performs low-level surface blitting only.
DECLSPEC int SDLCALL SDL_LowerBlitScaled | ( | SDL_Surface * | src, |
SDL_Rect * | srcrect, | ||
SDL_Surface * | dst, | ||
SDL_Rect * | dstrect | ||
) |
This is a semi-private blit function and it performs low-level surface scaled blitting only.
DECLSPEC int SDLCALL SDL_SaveBMP_RW | ( | SDL_Surface * | surface, |
SDL_RWops * | dst, | ||
int | freedst | ||
) |
Save a surface to a seekable SDL data stream (memory or file).
Surfaces with a 24-bit, 32-bit and paletted 8-bit format get saved in the BMP directly. Other RGB formats with 8-bit or higher get converted to a 24-bit surface or, if they have an alpha mask or a colorkey, to a 32-bit surface before they are saved. YUV and paletted 1-bit and 4-bit formats are not supported.
If freedst
is non-zero, the stream will be closed after being written.
DECLSPEC SDL_bool SDLCALL SDL_SetClipRect | ( | SDL_Surface * | surface, |
const SDL_Rect * | rect | ||
) |
Sets the clipping rectangle for the destination surface in a blit.
If the clip rectangle is NULL, clipping will be disabled.
If the clip rectangle doesn't intersect the surface, the function will return SDL_FALSE and blits will be completely clipped. Otherwise the function returns SDL_TRUE and blits to the surface will be clipped to the intersection of the surface area and the clipping rectangle.
Note that blits are automatically clipped to the edges of the source and destination surfaces.
DECLSPEC int SDLCALL SDL_SetColorKey | ( | SDL_Surface * | surface, |
int | flag, | ||
Uint32 | key | ||
) |
Sets the color key (transparent pixel) in a blittable surface.
surface | The surface to update |
flag | Non-zero to enable colorkey and 0 to disable colorkey |
key | The transparent pixel in the native surface format |
You can pass SDL_RLEACCEL to enable RLE accelerated blits.
DECLSPEC int SDLCALL SDL_SetSurfaceAlphaMod | ( | SDL_Surface * | surface, |
Uint8 | alpha | ||
) |
Set an additional alpha value used in blit operations.
surface | The surface to update. |
alpha | The alpha value multiplied into blit operations. |
DECLSPEC int SDLCALL SDL_SetSurfaceBlendMode | ( | SDL_Surface * | surface, |
SDL_BlendMode | blendMode | ||
) |
Set the blend mode used for blit operations.
surface | The surface to update. |
blendMode | SDL_BlendMode to use for blit blending. |
DECLSPEC int SDLCALL SDL_SetSurfaceColorMod | ( | SDL_Surface * | surface, |
Uint8 | r, | ||
Uint8 | g, | ||
Uint8 | b | ||
) |
Set an additional color value used in blit operations.
surface | The surface to update. |
r | The red color value multiplied into blit operations. |
g | The green color value multiplied into blit operations. |
b | The blue color value multiplied into blit operations. |
DECLSPEC int SDLCALL SDL_SetSurfacePalette | ( | SDL_Surface * | surface, |
SDL_Palette * | palette | ||
) |
Set the palette used by a surface.
DECLSPEC int SDLCALL SDL_SetSurfaceRLE | ( | SDL_Surface * | surface, |
int | flag | ||
) |
Sets the RLE acceleration hint for a surface.
DECLSPEC int SDLCALL 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.
DECLSPEC void SDLCALL SDL_UnlockSurface | ( | SDL_Surface * | surface | ) |
DECLSPEC int SDLCALL SDL_UpperBlit | ( | SDL_Surface * | src, |
const SDL_Rect * | srcrect, | ||
SDL_Surface * | dst, | ||
SDL_Rect * | dstrect | ||
) |
This is the public blit function, SDL_BlitSurface(), and it performs rectangle validation and clipping before passing it to SDL_LowerBlit()
DECLSPEC int SDLCALL SDL_UpperBlitScaled | ( | SDL_Surface * | src, |
const SDL_Rect * | srcrect, | ||
SDL_Surface * | dst, | ||
SDL_Rect * | dstrect | ||
) |
This is the public scaled blit function, SDL_BlitScaled(), and it performs rectangle validation and clipping before passing it to SDL_LowerBlitScaled()