A collection of pixels used in software blitting.
Defined in [SDL_surface.h](https://github.com/libsdl-org/SDL/blob/SDL2/include/SDL_surface.h), but apps should _only_ `#include "SDL.h"`!
typedef struct SDL_Surface
{/**< Read-only */
Uint32 flags; /**< Read-only */
SDL_PixelFormat *format; int w, h; /**< Read-only */
int pitch; /**< Read-only */
void *pixels; /**< Read-write */
/** Application data associated with the surface */
void *userdata; /**< Read-write */
/** information needed for surfaces requiring locks */
int locked; /**< Read-only */
/** list of BlitMap that hold a reference to this surface */
void *list_blitmap; /**< Private */
/** clipping information */
/**< Read-only */
SDL_Rect clip_rect;
/** info for fast blit mapping to other surfaces */
/**< Private */
SDL_BlitMap *map;
/** Reference count -- used when freeing surface */
int refcount; /**< Read-mostly */
} SDL_Surface;
/* This is meant to show how to edit a surface's pixels on the CPU, but
normally you should use SDL_FillRect() to wipe a surface's contents. */
void WipeSurface(SDL_Surface *surface)
{/* This is fast for surfaces that don't require locking. */
/* Once locked, surface->pixels is safe to access. */
SDL_LockSurface(surface);
/* This assumes that color value zero is black. Use
SDL_MapRGBA() for more robust surface color mapping! */
/* height times pitch is the size of the surface's whole buffer. */
0, surface->h * surface->pitch);
SDL_memset(surface->pixels,
SDL_UnlockSurface(surface); }
Uint32 |
flags |
(internal use) |
format |
the format of the pixels stored in the surface; see SDL_PixelFormat for details (read-only) |
|
int |
w, h |
the width and height in pixels (read-only) |
int |
pitch |
the length of a row of pixels in bytes (read-only) |
void* |
pixels |
the pointer to the actual pixel data; see Remarks for details (read-write) |
void* |
userdata |
an arbitrary pointer you can set (read-write) |
int |
locked |
used for surfaces that require locking (internal use) |
void* |
lock_data |
used for surfaces that require locking (internal use) |
clip_rect |
an SDL_Rect structure used to clip blits to the surface which can be set by SDL_SetClipRect() (read-only) |
|
SDL_BlitMap* |
map |
info for fast blit mapping to other surfaces (internal use) |
int |
refcount |
reference count that can be incremented by the application |
CategoryAPI, CategoryAPIStruct, CategoryStruct, CategorySurface