Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

SDL_GetRGB (3)

Name

SDL_GetRGB - Get RGB values from a pixel in the specified pixel format.

Synopsis

#include "SDL.h"

void SDL_GetRGB(Uint32 pixel, SDL_PixelFormat *fmt, Uint8 *r, Uint8 *g,
Uint8 *b);

Description

SDL_GetRGB(3)                  SDL API Reference                 SDL_GetRGB(3)



NAME
       SDL_GetRGB - Get RGB values from a pixel in the specified pixel format.

SYNOPSIS
       #include "SDL.h"

       void SDL_GetRGB(Uint32 pixel, SDL_PixelFormat *fmt, Uint8 *r, Uint8 *g,
       Uint8 *b);

DESCRIPTION
       Get RGB component values from a pixel stored  in  the  specified  pixel
       format.

       This  function  uses  the  entire  8-bit [0..255] range when converting
       color components from pixel formats with less than 8-bits per RGB  com-
       ponent  (e.g.,  a  completely white pixel in 16-bit RGB565 format would
       return [0xff, 0xff, 0xff] not [0xf8, 0xfc, 0xf8]).


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


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | library/sdl      |
       +---------------+------------------+
       |Stability      | Volatile         |
       +---------------+------------------+
SEE ALSO
       SDL_GetRGBA, SDL_MapRGB, SDL_MapRGBA, 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_GetRGB(3)