oc_colormap.h

Go to the documentation of this file.

#ifndef SYSTEM_CORE_INC_GUI_OC_COLORMAP_H_
#define SYSTEM_CORE_INC_GUI_OC_COLORMAP_H_

#include <oc_color.h>
#include <oc_pixel.h>
#include <oc_stdtypes.h>
#include <oc_assert.h>
#include <oc_stdlib.h>
#include <oc_font.h>

#define _________________________________________DEFINITIONS_SECTION________________________________________________________________________

#define oC_ColorMap_MagicNumber     0xFEADBABA

#undef  _________________________________________DEFINITIONS_SECTION________________________________________________________________________


#define _________________________________________TYPES_SECTION______________________________________________________________________________

typedef struct
{
    union
    {
        const void *            Map;
        const uint8_t *         ReadMap;
        uint8_t *               WriteMap;
        void *                  GenericWriteMap;
    };
    oC_Pixel_ResolutionUInt_t   Width;
    oC_Pixel_ResolutionUInt_t   Height;
    oC_ColorFormat_t            ColorFormat;
    uint32_t                    MagicNumber;
    uint32_t                    FormatSize;
} oC_ColorMap_t;

#undef  _________________________________________TYPES_SECTION______________________________________________________________________________

#define _________________________________________MACROS_SECTION_____________________________________________________________________________

#define oC_ColorMap_Define( ColorMapName , COLORS_ARRAY , WIDTH , HEIGHT , COLOR_FORMAT )         \
                oC_COMPILE_ASSERT( sizeof(COLORS_ARRAY) >= (WIDTH * HEIGHT * oC_Color_FormatSize(COLOR_FORMAT)) , #ColorMapName " array size is too small! (Required " #WIDTH "*" #HEIGHT ")");\
                oC_ColorMap_t ColorMapName = {                 \
                     .Map         = COLORS_ARRAY ,             \
                     .Width       = WIDTH ,                    \
                     .Height      = HEIGHT ,                   \
                     .ColorFormat = COLOR_FORMAT ,             \
                     .MagicNumber = oC_ColorMap_MagicNumber ,  \
                }


#undef  _________________________________________MACROS_SECTION_____________________________________________________________________________

#define _________________________________________INTERFACE_PROTOTYPES_SECTION_______________________________________________________________

extern oC_ColorMap_t * oC_ColorMap_New              ( Allocator_t Allocator , AllocationFlags_t AllocationFlags , oC_Pixel_ResolutionUInt_t Width , oC_Pixel_ResolutionUInt_t Height , oC_ColorFormat_t ColorFormat );
extern bool            oC_ColorMap_Delete           ( oC_ColorMap_t * ColorMap , AllocationFlags_t AllocationFlags );
extern oC_Color_t      oC_ColorMap_GetColor         ( const oC_ColorMap_t * ColorMap , oC_Pixel_Position_t Position , oC_ColorFormat_t ColorFormat );
extern bool            oC_ColorMap_SetColor         ( oC_ColorMap_t * ColorMap , oC_Pixel_Position_t Position , oC_Color_t Color , oC_ColorFormat_t ColorFormat );
extern bool            oC_ColorMap_DrawChar         ( oC_ColorMap_t * ColorMap , oC_Pixel_Position_t Position , oC_Color_t Color , oC_ColorFormat_t ColorFormat , uint16_t C , oC_Font_t Font );
extern bool            oC_ColorMap_IsCorrect        ( const oC_ColorMap_t * ColorMap );
extern bool            oC_ColorMap_IsPositionCorrect( const oC_ColorMap_t * ColorMap , oC_Pixel_Position_t Position );

#undef  _________________________________________INTERFACE_PROTOTYPES_SECTION_______________________________________________________________


#endif /* SYSTEM_CORE_INC_GUI_OC_COLORMAP_H_ */