SDL 3.0
SDL_Surface Struct Reference

#include <SDL_surface.h>

+ Collaboration diagram for SDL_Surface:

Data Fields

Uint32 flags
 
SDL_PixelFormatformat
 
int w
 
int h
 
int pitch
 
void * pixels
 
SDL_PropertiesID props
 
int locked
 
void * list_blitmap
 
SDL_Rect clip_rect
 
SDL_BlitMapmap
 
int refcount
 

Detailed Description

A collection of pixels used in software blitting.

Pixels are arranged in memory in rows, with the top row first. Each row occupies an amount of memory given by the pitch (sometimes known as the row stride in non-SDL APIs).

Within each row, pixels are arranged from left to right until the width is reached. Each pixel occupies a number of bits appropriate for its format, with most formats representing each pixel as one or more whole bytes (in some indexed formats, instead multiple pixels are packed into each byte), and a byte order given by the format. After encoding all pixels, any remaining bytes to reach the pitch are used as padding to reach a desired alignment, and have undefined contents.

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

Definition at line 87 of file SDL_surface.h.

Field Documentation

◆ clip_rect

SDL_Rect SDL_Surface::clip_rect

clipping information Read-only

Definition at line 105 of file SDL_surface.h.

◆ flags

Uint32 SDL_Surface::flags

Read-only

Definition at line 89 of file SDL_surface.h.

◆ format

SDL_PixelFormat* SDL_Surface::format

Read-only

Definition at line 90 of file SDL_surface.h.

◆ h

int SDL_Surface::h

Read-only

Definition at line 91 of file SDL_surface.h.

◆ list_blitmap

void* SDL_Surface::list_blitmap

list of BlitMap that hold a reference to this surface Private

Definition at line 102 of file SDL_surface.h.

◆ locked

int SDL_Surface::locked

information needed for surfaces requiring locks Read-only

Definition at line 99 of file SDL_surface.h.

◆ map

SDL_BlitMap* SDL_Surface::map

info for fast blit mapping to other surfaces Private

Definition at line 108 of file SDL_surface.h.

◆ pitch

int SDL_Surface::pitch

Read-only

Definition at line 92 of file SDL_surface.h.

◆ pixels

void* SDL_Surface::pixels

Read-write

Definition at line 93 of file SDL_surface.h.

◆ props

SDL_PropertiesID SDL_Surface::props

Application data associated with the surface Read-write

Definition at line 96 of file SDL_surface.h.

◆ refcount

int SDL_Surface::refcount

Reference count – used when freeing surface Read-mostly

Definition at line 111 of file SDL_surface.h.

◆ w

int SDL_Surface::w

Definition at line 91 of file SDL_surface.h.


The documentation for this struct was generated from the following file: