Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

SDL_MapRGBA (3)

Name

SDL_MapRGBA - Map a RGBA color value to a pixel format.

Synopsis

#include "SDL.h"

Uint32  SDL_MapRGBA(SDL_PixelFormat  *fmt,  Uint8  r, Uint8 g, Uint8 b,
Uint8 a);

Description

SDL_MapRGBA(3)                 SDL API Reference                SDL_MapRGBA(3)



NAME
       SDL_MapRGBA - Map a RGBA color value to a pixel format.

SYNOPSIS
       #include "SDL.h"

       Uint32  SDL_MapRGBA(SDL_PixelFormat  *fmt,  Uint8  r, Uint8 g, Uint8 b,
       Uint8 a);

DESCRIPTION
       Maps the RGBA color value to the specified pixel format and returns the
       pixel value as a 32-bit int.

       If  the  format has a palette (8-bit) the index of the closest matching
       color in the palette will be returned.

       If the specified pixel format has no alpha component  the  alpha  value
       will be ignored (as it will be in formats with a palette).

RETURN VALUE
       A pixel value best approximating the given RGBA color value for a given
       pixel format. If the pixel format bpp (color depth) is less than 32-bpp
       then  the  unused  upper bits of the return value can safely be ignored
       (e.g., with a 16-bpp format the return  value  can  be  assigned  to  a
       Uint16, and similarly a Uint8 for an 8-bpp format).


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


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | library/sdl      |
       +---------------+------------------+
       |Stability      | Volatile         |
       +---------------+------------------+
SEE ALSO
       SDL_GetRGB, SDL_GetRGBA, SDL_MapRGB, SDL_PixelFormat



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_MapRGBA(3)