SDL_StretchSurface(3)

SDL_StretchSurface3

Perform a stretched pixel copy from one surface to another.

Usage

#include "SDL3/SDL.h"

bool SDL_StretchSurface(SDL_Surface *src, const SDL_Rect *srcrect, SDL_Surface *dst, const SDL_Rect *dstrect, SDL_ScaleMode scaleMode);

Header file

Defined in SDL3/SDL_surface.h

Function parameters

src

the SDL_Surface
structure to be copied from.

srcrect

the SDL_Rect
structure representing the rectangle to be copied, may not be NULL.

dst

the SDL_Surface
structure that is the blit target.

dstrect

the SDL_Rect
structure representing the target rectangle in the destination surface, may not be NULL.

scaleMode

the SDL_ScaleMode
to be used.

Return value

Returns true on success or false on failure; call

SDL_GetError () for more information.

Thread safety

Only one thread should be using the src and dst surfaces at any given time.

Availability

This function is available since SDL 3.4.0.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.