Wiki Page Content

Differences between revisions 20 and 21
Revision 20 as of 2010-12-12 20:34:44
Size: 3337
Editor: SheenaSmith
Comment: update content - w/ Sam
Revision 21 as of 2010-12-12 20:38:03
Size: 3342
Editor: Sam Lantinga
Comment: Clarify the "scanline" concept
Deletions are marked like this. Additions are marked like this.
Line 13: Line 13:
||int ||'''pitch''' ||the length of a scanline in bytes (read-only) || ||int ||'''pitch''' ||the length of a row of pixels in bytes (read-only) ||

SDL_Surface

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

Data Fields

Uint32

flags

internal

SDL_PixelFormat*

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

internal; used for surfaces that require locking

void*

lock_data

internal; used for surfaces that require locking

SDL_Rect

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

internal; info for fast blit mapping to other surfaces

int

format_version

internal; bumped at every change to invalidate blit maps

int

refcount

reference count that can be incremented by the application

Code Examples

You can add your code example here

Remarks

With most surfaces you can access the pixels directly. Surfaces that have been optimized with SDL_SetSurfaceRLE() should be locked with SDL_LockSurface() before accessing pixels. When you are done you should call SDL_UnlockSurface() before blitting.


CategoryStruct, CategorySurface

None: SDL_Surface (last edited 2017-07-14 21:51:36 by PhilippWiesemann)

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