SDL standard library

Dependents:   H261_encoder

Embed: (wiki syntax)

« Back to documentation index

SDL_Surface Struct Reference

SDL_Surface Struct Reference

A collection of pixels used in software blitting. More...

#include <SDL_surface.h>

Data Fields

Uint32 flags
 Read-only.
SDL_PixelFormatformat
 Read-only.
int h
 Read-only.
int pitch
 Read-only.
void * pixels
 Read-write.
void * userdata
 Application data associated with the surface.
int locked
 information needed for surfaces requiring locks
void * lock_data
 Read-only.
SDL_Rect clip_rect
 clipping information
struct SDL_BlitMap * map
 info for fast blit mapping to other surfaces
int refcount
 Reference count -- used when freeing surface.

Detailed Description

A collection of pixels used in software blitting.

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

Definition at line 69 of file SDL_surface.h.


Field Documentation

clipping information

Read-only

Definition at line 85 of file SDL_surface.h.

Read-only.

Definition at line 71 of file SDL_surface.h.

Read-only.

Definition at line 72 of file SDL_surface.h.

int h

Read-only.

Definition at line 73 of file SDL_surface.h.

void* lock_data

Read-only.

Definition at line 82 of file SDL_surface.h.

int locked

information needed for surfaces requiring locks

Read-only

Definition at line 81 of file SDL_surface.h.

struct SDL_BlitMap* map

info for fast blit mapping to other surfaces

Private

Definition at line 88 of file SDL_surface.h.

int pitch

Read-only.

Definition at line 74 of file SDL_surface.h.

void* pixels

Read-write.

Definition at line 75 of file SDL_surface.h.

int refcount

Reference count -- used when freeing surface.

Read-mostly

Definition at line 91 of file SDL_surface.h.

void* userdata

Application data associated with the surface.

Read-write

Definition at line 78 of file SDL_surface.h.