SDL_DisplayFormat(3)

SDL_DisplayFormat3

Convert a surface to the display format

Usage

#include "SDL.h"

SDL_Surface *SDL_DisplayFormat(SDL_Surface *surface);

Overview

This function takes a surface and copies it to a new surface of the pixel format and colors of the video framebuffer, suitable for fast blitting onto the display surface. It calls SDL_ConvertSurface

If you want to take advantage of hardware colorkey or alpha blit acceleration, you should set the colorkey and alpha value before calling this function.

If you want an alpha channel, see SDL_DisplayFormatAlpha.

Return value

If the conversion fails or runs out of memory, it returns NULL

Releases

11 releases since Debian 3.0 (Woody); the text changed 1 time.

  1. 3.0–5.0
  2. 6.0–12

From libsdl1.2-dev 1.2.15+dfsg2-8 in Debian 12 (Bookworm). Parsed by carta from the page's man source.