SDL_SetSurfaceRLE(3)

SDL_SetSurfaceRLE3

Set the rle acceleration hint for a surface.

Usage

#include "SDL3/SDL.h"

bool SDL_SetSurfaceRLE(SDL_Surface *surface, bool enabled);

Header file

Defined in SDL3/SDL_surface.h

Overview

If RLE is enabled, color key and alpha blending blits are much faster, but the surface must be locked before directly accessing the pixels.

Function parameters

surface

the SDL_Surface
structure to optimize.

enabled

true to enable RLE acceleration, false to disable it.

Return value

Returns true on success or false on failure; call

SDL_GetError () for more information.

Thread safety

This function is not thread safe.

Availability

This function is available since SDL 3.2.0.

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