(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)

SDL_GetSurfaceColorspace

Get the colorspace used by a surface.

Header File

Defined in <SDL3/SDL_surface.h>

Syntax

int SDL_GetSurfaceColorspace(SDL_Surface *surface, SDL_Colorspace *colorspace);

Function Parameters

surface the SDL_Surface structure to query
colorspace a pointer filled in with an SDL_ColorSpace value describing the surface colorspace

Return Value

Returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.

Remarks

The colorspace defaults to SDL_COLORSPACE_SRGB_LINEAR for floating point formats, SDL_COLORSPACE_HDR10 for 10-bit formats, SDL_COLORSPACE_SRGB for other RGB surfaces and SDL_COLORSPACE_BT709_FULL for YUV textures.

Version

This function is available since SDL 3.0.0.

CategoryAPI, CategoryAPIFunction, CategorySurface