GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
SDLmm::PixelFormat(3) FreeBSD Library Functions Manual SDLmm::PixelFormat(3)

SDLmm::PixelFormat -

#include <sdlmm_pixelformat.h>


PixelFormat (SDL_PixelFormat *pixelformat)
Constructor from an SDL_PixelFormat*. virtual ~PixelFormat ()
The destructor. Uint8 BitsPerPixel () const
Uint8 BytesPerPixel () const
Uint8 Rshift () const
Uint8 Gshift () const
Uint8 Bshift () const
Uint8 Rloss () const
Uint8 Gloss () const
Uint8 Bloss () const
Uint8 Aloss () const
Uint32 Rmask () const
Uint32 Gmask () const
Uint32 Bmask () const
Uint32 Amask () const
Color colorkey () const
Uint8 alpha () const
SDL_Palette* palette () const
Color MapRGB (Uint8 r, Uint8 g, Uint8 b) const
Map a RGB color value to a pixel format. Color MapRGB (const ColorRGB &colorrgb) const
Color MapRGBA (Uint8 r, Uint8 g, Uint8 b, Uint8 a) const
Map a RGBA color value to a pixel format. Color MapRGBA (const ColorRGBA &colorrgba) const
void GetRGB (Color pixel, Uint8 &r, Uint8 &g, Uint8 &b) const
Get RGB values from a pixel in the pixel format of this PixelFormat . const ColorRGB GetRGB (Color pixel) const
void GetRGBA (Color pixel, Uint8 &r, Uint8 &g, Uint8 &b, Uint8 &a) const
Get RGBA values from a pixel in the pixel format of this PixelFormat . const ColorRGBA GetRGBA (Color pixel) const

Informational methods



bool valid () const
Returns true if this PixelFormat is initialized, false otherwise.


SDL_PixelFormat* me
The actual SDL_PixelFormat for this PixelFormat.

Author:
Adam Gates

Constructor from an SDL_PixelFormat*.

This creates a new PixelFormat object from an existing SDL_PixelFormat. It's very important not to free the original pixel format since that will cause problems. Use with caution.

The destructor.

Get RGB values from a pixel in the pixel format of this PixelFormat.

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

Parameters:

pixel
the pixel value
r, g, b
references to integers where the RGB result will be stored.

See also:
GetRGBA, MapRGB, MapRGBA

Get RGBA values from a pixel in the pixel format of this PixelFormat.

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

Note:
If the PixelFormat has no alpha component, the alpha will be returned as 0xff (100% opaque).

Parameters:

pixel
the pixel value
r, g, b, a
references to integers where the RGBA result will be stored.

See also:
GetRGB, MapRGB, MapRGBA

Map a RGB color value to a pixel format.

Maps the RGB color value to this PixelFormat's 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 an alpha component it will be returned as all 1 bits (fully opaque).

Returns:
A pixel value best approximating the given RGB 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).

Parameters:

r, g, b
the RGB values.

See also:
GetRGB, GetRGBA, MapRGBA

Map a RGBA color value to a pixel format.

Maps the RGBA color value to this PixelFormat's 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).

Returns:
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).

Parameters:

r, g, b, a
the RGBA values.

See also:
GetRGB, GetRGBA, MapRGB

Returns true if this PixelFormat is initialized, false otherwise.

Warning:
Using an uninitialzied PixelFormat can cause many problems.

The actual SDL_PixelFormat for this PixelFormat.

Generated automatically by Doxygen for SDLmm from the source code.
16 Jul 2001 SDLmm

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.