logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

SDL_CreateSurfaceFrom - Allocate a new surface with a specific pixel format and existing pixel data.

Availability

       This function is available since SDL 3.2.0.

Description

       No  copy  is  made  of the pixel data. Pixel data is not managed automatically; you must free the surface
       before you free the pixel data.

       Pitch  is  the  offset  in  bytes  from  one  row  of   pixels   to   the   next,   e.g.    width*4   for
       SDL_PIXELFORMAT_RGBA8888 .

       You  may pass NULL for pixels and 0 for pitch to create a surface that you will fill in with valid values
       later.

Function Parameters

width  the width of the surface.

       height the height of the surface.

       format the SDL_PixelFormat
               for the new surface's pixel format.

       pixels a pointer to existing pixel data.

       pitch  the number of bytes between each row, including padding.

Header File

       Defined in SDL3/SDL_surface.h

Name

       SDL_CreateSurfaceFrom - Allocate a new surface with a specific pixel format and existing pixel data.

Return Value

       ( SDL_Surface
        *) Returns the new SDL_Surface

       structure that is created or NULL on failure; call

       SDL_GetError () for more information.

See Also

(3), SDL_CreateSurface(3), (3), SDL_DestroySurface(3)

Simple Directmedia Layer                           SDL 3.2.10                           SDL_CreateSurfaceFrom(3)

Synopsis

#include"SDL3/SDL.h"SDL_Surface*SDL_CreateSurfaceFrom(intwidth,intheight,SDL_PixelFormatformat,void*pixels,intpitch);

Thread Safety

       It is safe to call this function from any thread.

See Also