RageSurface.h

Go to the documentation of this file.

/* RageSurface - holds a simple 2d graphic surface */

#ifndef RAGE_SURFACE_H
#define RAGE_SURFACE_H

/* XXX remove? */
struct RageSurfaceColor 
{
        uint8_t r, g, b, a;
        RageSurfaceColor() { }
        RageSurfaceColor( uint8_t r_, uint8_t g_, uint8_t b_, uint8_t a_ ):
                r(r_), g(g_), b(b_), a(a_) { }

        bool operator== ( const RageSurfaceColor &rhs ) const;
};

struct RageSurfacePalette 
{
        RageSurfaceColor colors[256];
        int32_t ncolors;

        /* Find the exact color; returns -1 if not found. */
        int32_t FindColor( const RageSurfaceColor &color ) const;
        int32_t FindClosestColor( const RageSurfaceColor &color ) const;
};

struct RageSurfaceFormat
{
        RageSurfaceFormat();
        RageSurfaceFormat( const RageSurfaceFormat &cpy );
        ~RageSurfaceFormat();

        int32_t BytesPerPixel;
        int32_t BitsPerPixel;
        uint32_t Mask[4];
        uint32_t Shift[4];
        uint8_t Loss[4];
        uint32_t &Rmask, &Gmask, &Bmask, &Amask; /* deprecated */
        uint32_t &Rshift, &Gshift, &Bshift, &Ashift; /* deprecated */
        RageSurfacePalette *palette;

        void GetRGB( uint32_t val, uint8_t *r, uint8_t *g, uint8_t *b ) const;

        /* Return the decoded value for the given color; the result can be compared to
         * decodepixel() results.  If the image is paletted and the color isn't found,
         * val is undefined and false is returned. */
        bool MapRGBA( uint8_t r, uint8_t g, uint8_t b, uint8_t a, uint32_t &val ) const;

        /* MapRGBA, but also do a nearest-match on palette colors. */
        uint32_t MapNearestRGBA( uint8_t r, uint8_t g, uint8_t b, uint8_t a ) const;
        
        bool operator== ( const RageSurfaceFormat &rhs ) const;

        /* Like operator==, but ignores the palette (which is really a part of the
         * surface, not the format). */
        bool Equivalent( const RageSurfaceFormat &rhs ) const;
};

struct RageSurface
{
        RageSurfaceFormat *format; /* compatibility only */
        RageSurfaceFormat fmt;

        uint8_t *pixels;
        bool pixels_owned;
        int32_t w, h, pitch;
        int32_t flags;

        RageSurface();
        RageSurface( const RageSurface &cpy );
        ~RageSurface();
};

RageSurface *CreateSurface( int width, int height, int bpp, uint32_t Rmask, uint32_t Gmask, uint32_t Bmask, uint32_t Amask );
RageSurface *CreateSurfaceFrom( int width, int height, int bpp, uint32_t Rmask, uint32_t Gmask, uint32_t Bmask, uint32_t Amask, uint8_t *pPixels, uint32_t pitch );

#endif

/*
 * (c) 2001-2004 Glenn Maynard
 * All rights reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, and/or sell copies of the Software, and to permit persons to
 * whom the Software is furnished to do so, provided that the above
 * copyright notice(s) and this permission notice appear in all copies of
 * the Software and that both the above copyright notice(s) and this
 * permission notice appear in supporting documentation.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF
 * THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR HOLDERS
 * INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL INDIRECT
 * OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
 * OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
 * OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 * PERFORMANCE OF THIS SOFTWARE.
 */

---