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
 
void * reserved
 
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.

Since
This struct is available since SDL 3.0.0.

Definition at line 112 of file SDL_surface.h.

Field Documentation

◆ clip_rect

SDL_Rect SDL_Surface::clip_rect

clipping information Read-only

Definition at line 129 of file SDL_surface.h.

◆ flags

Uint32 SDL_Surface::flags

Read-only

Definition at line 114 of file SDL_surface.h.

◆ format

SDL_PixelFormat* SDL_Surface::format

Read-only

Definition at line 115 of file SDL_surface.h.

◆ h

int SDL_Surface::h

Read-only

Definition at line 116 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 126 of file SDL_surface.h.

◆ locked

int SDL_Surface::locked

information needed for surfaces requiring locks Read-only

Definition at line 123 of file SDL_surface.h.

◆ map

SDL_BlitMap* SDL_Surface::map

info for fast blit mapping to other surfaces Private

Definition at line 132 of file SDL_surface.h.

◆ pitch

int SDL_Surface::pitch

Read-only

Definition at line 117 of file SDL_surface.h.

◆ pixels

void* SDL_Surface::pixels

Read-write

Definition at line 118 of file SDL_surface.h.

◆ refcount

int SDL_Surface::refcount

Reference count – used when freeing surface Read-mostly

Definition at line 135 of file SDL_surface.h.

◆ reserved

void* SDL_Surface::reserved

Private

Definition at line 120 of file SDL_surface.h.

◆ w

int SDL_Surface::w

Definition at line 116 of file SDL_surface.h.


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