Wiki Page Content

Revision 9 as of 2010-11-01 01:59:42

Clear message

DRAFT

SDL_Surface

A structure that contains a collection of pixels used in software blitting.

Data Fields

Uint32

flags

internal, read-only; see Remarks for details

SDL_PixelFormat*

format

read-only

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

void*

lock_data

read-only

Clipping information

SDL_Rect

clip_rect

read-only

Info for fast blit mapping to other surfaces

SDL_BlitMap*

map

Internal (struct)

Format version, bumped at every change to invalidate blit maps

unsigned int Uint?

format_version

private

Reference count -- used when freeing surface

int

refcount

read-mostly

green

Code Examples

You can add your code example here

Remarks

This structure should be treated as read-only, except for pixels, which, if not NULL, contains the raw pixel data for the surface.

The currently supported flags for SDL_Surface are:
or
flags may be 0 or any of the following OR'd together:

SDL_PREALLOC

surface uses preallocated memory

SDL_RLEACCEL

surface is RLE encoded

green

The following Evaluates to true if the surface needs to be locked before access.

  • #define SDL_MUSTLOCK(S) (((S)->flags & SDL_RLEACCEL) != 0)

green

*
An SDL_Surface represents an area of graphical memory that can be drawn to. The video framebuffer is returned as an SDL_Surface by SDL_SetVideoMode() and SDL_GetVideoSurface().

green


*


CategoryStruct, CategorySurface

(Page Info.)
Feedback
Please include your contact information if you'd like to receive a reply.
Submit