Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

SDL_DisplayFormatAlpha (3)

Name

SDL_DisplayFormatAlpha - Convert a surface to the display format

Synopsis

#include "SDL.h"

SDL_Surface *SDL_DisplayFormatAlpha(SDL_Surface *surface);

Description

SDL_DisplayFormatAlpha(3)      SDL API Reference     SDL_DisplayFormatAlpha(3)



NAME
       SDL_DisplayFormatAlpha - Convert a surface to the display format

SYNOPSIS
       #include "SDL.h"

       SDL_Surface *SDL_DisplayFormatAlpha(SDL_Surface *surface);

DESCRIPTION
       This  function  takes  a  surface and copies it to a new surface of the
       pixel format and colors of the video framebuffer plus an alpha channel,
       suitable  for fast blitting onto the display surface. It calls SDL_Con-
       vertSurface

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

       This function can be used to convert a colourkey to an  alpha  channel,
       if  the  SDL_SRCCOLORKEY flag is set on the surface. The generated sur-
       face will then be transparent (alpha=0)  where  the  pixels  match  the
       colourkey, and opaque (alpha=255) elsewhere.

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


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | library/sdl      |
       +---------------+------------------+
       |Stability      | Volatile         |
       +---------------+------------------+
SEE ALSO
       SDL_ConvertSurface,  SDL_SetAlpha,  SDL_SetColorKey, SDL_DisplayFormat,
       SDL_Surface



NOTES
       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source       was        downloaded        from         https://www.lib-
       sdl.org/release/SDL-1.2.15.tar.gz

       Further information about this software can be found on the open source
       community website at https://www.libsdl.org/.



SDL                         Tue 11 Sep 2001, 23:01   SDL_DisplayFormatAlpha(3)