(This is the legacy documentation for SDL2, the previous stable version; SDL3 is the current stable version.)

SDL_SetSurfaceRLE

Set the RLE acceleration hint for a surface.

Header File

Defined in SDL_surface.h

Syntax

int SDL_SetSurfaceRLE(SDL_Surface * surface,
                      int flag);

Function Parameters

SDL_Surface *	surface	the SDL_Surface structure to optimize.
int	flag	0 to disable, non-zero to enable RLE acceleration.

Return Value

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

Remarks

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

Version

This function is available since SDL 2.0.0.

See Also

• SDL_BlitSurface
• SDL_LockSurface
• SDL_UnlockSurface

---

CategoryAPI, CategoryAPIFunction, CategorySurface

[ 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.