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_GetSurfaceProperties - Get the properties associated with a surface.

Availability

       This function is available since SDL 3.2.0.

Simple Directmedia Layer                           SDL 3.2.10                        SDL_GetSurfaceProperties(3)

Description

       The following properties are understood by SDL:

       • SDL_PROP_SURFACE_SDR_WHITE_POINT_FLOAT :
         for HDR10 and floating point surfaces, this defines the value of 100%
         diffuse white, with higher values being displayed in the High Dynamic
         Range headroom. This defaults to 203 for HDR10 surfaces and 1.0 for
         floating point surfaces.

       • SDL_PROP_SURFACE_HDR_HEADROOM_FLOAT :
         for HDR10 and floating point surfaces, this defines the maximum dynamic
         range used by the content, in terms of the SDR white point. This defaults
         to 0.0, which disables tone mapping.

       • SDL_PROP_SURFACE_TONEMAP_OPERATOR_STRING :
         the tone mapping operator used when compressing from a surface with high
         dynamic range to another with lower dynamic range. Currently this
         supports "chrome", which uses the same tone mapping that Chrome uses for
         HDR content, the form "*=N", where N is a floating point scale factor
         applied in linear space, and "none", which disables tone mapping. This
         defaults to "chrome".

       • SDL_PROP_SURFACE_HOTSPOT_X_NUMBER :
         the hotspot pixel offset from the left edge of the image, if this surface
         is being used as a cursor.

       • SDL_PROP_SURFACE_HOTSPOT_Y_NUMBER :
         the hotspot pixel offset from the top edge of the image, if this surface
         is being used as a cursor.

Function Parameters

surface
              the SDL_Surface
               structure to query.

Header File

       Defined in SDL3/SDL_surface.h

Name

       SDL_GetSurfaceProperties - Get the properties associated with a surface.

Return Value

       (  SDL_PropertiesID  )  Returns  a valid property ID on success or 0 on failure; call SDL_GetError () for
       more information.

Synopsis

#include"SDL3/SDL.h"SDL_PropertiesIDSDL_GetSurfaceProperties(SDL_Surface*surface);

Thread Safety

       It is safe to call this function from any thread.

See Also