SDL Wiki

SDL_StretchSurface

Perform a stretched pixel copy from one surface to another.

Header File

Defined in <SDL3/SDL_surface.h>

Syntax

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

Function Parameters

SDL_Surface * src the SDL_Surface structure to be copied from.
const SDL_Rect * srcrect the SDL_Rect structure representing the rectangle to be copied, may not be NULL.
SDL_Surface * dst the SDL_Surface structure that is the blit target.
const SDL_Rect * dstrect the SDL_Rect structure representing the target rectangle in the destination surface, may not be NULL.
SDL_ScaleMode scaleMode the SDL_ScaleMode to be used.

Return Value

(bool) 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.

Version

This function is available since SDL 3.4.0.

See Also


CategoryAPI, CategoryAPIFunction, CategorySurface


[ edit | delete | history | feedback | raw ]

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.