YiBitmap.h

Go to the documentation of this file.

// © You i Labs Inc. 2000-2017. All rights reserved.
#ifndef _YI_BITMAP_H_
#define _YI_BITMAP_H_

#include "framework/YiPredef.h"

#include <memory>

class CYIBitmapPriv;
class CYIColor;

class CYIBitmap
{
    friend class CYIBitmapPriv;

public:
    enum OWNERSHIP
    {
        SHARED, 
        PRIVATE 
    };

    enum COLOR_MODE
    {
        COLOR_MODE_RGBA8888, 
        COLOR_MODE_RGBA4444, 
        COLOR_MODE_RGB565 
    };

    enum DITHERING_MODE
    {
        DITHERING_NONE, 
        DITHERING_FLOYD_STEINBERG 
    };

    CYIBitmap();
    virtual ~CYIBitmap();

    std::unique_ptr<CYIBitmap> Clone() const;

    virtual bool Create(int32_t nWidth, int32_t nHeight);

    void Draw(const CYIBitmap &srcImage, int32_t nDestX, int32_t nDestY);

    void Draw(const CYIBitmap &srcImage, int32_t nDestX, int32_t nDestY, const YI_RECT_REL &clipRegion);

    void Draw(const CYIBitmap &srcImage, int32_t nDestX, int32_t nDestY, int32_t nClipWidth, int32_t nClipHeight);

    void DrawScale(const CYIBitmap & srcImage, const YI_RECT_REL *pDest, const YI_RECT_REL *pSrc);
 
    void Fill(const CYIColor &color);

    void Fill(const CYIColor &color, const YI_RECT  &region);

    const uint32_t *GetPixels() const;

    uint32_t *GetPixels();

    void FreePixels();
    

    virtual int32_t GetHeight() const;

    void ReduceHeightTo(int32_t nNewHeight);

    virtual int32_t GetWidth() const;

    int32_t GetXPitch() const;

    int32_t GetYPitch() const;

    virtual int32_t GetDepth() const;

    uint32_t GetBytesPerPixel() const;

    virtual int32_t GetSize() const;

    void SetPixels(uint32_t *pBits, int32_t nWidth, int32_t nHeight, CYIBitmap::OWNERSHIP ownership = CYIBitmap::PRIVATE);

    void SetPixel(int32_t nX, int32_t nY, const CYIColor &color);

    virtual void SetPixelPacked(int32_t nX, int32_t nY, uint32_t color);

    void SetPixelRaw(int32_t nX, int32_t nY, uint32_t color);

    CYIColor GetPixel(int32_t nX, int32_t nY) const;

    virtual uint32_t GetPixelPacked(int32_t nX, int32_t nY) const;

    uint32_t GetPixelRaw(int32_t nX, int32_t nY) const;

    COLOR_MODE GetColorMode() const;

    std::unique_ptr<CYIBitmap> ToColorMode(COLOR_MODE eColorMode, DITHERING_MODE eDitheringMode = DITHERING_NONE) const;

    bool operator==(const CYIBitmap &other) const;

    bool operator!=(const CYIBitmap &other) const;

private:
    std::unique_ptr<CYIBitmapPriv> m_pPriv;
    CYIBitmap(std::unique_ptr<CYIBitmapPriv> pPriv);
    CYIBitmap(const CYIBitmap &other);
    CYIBitmap &operator=(const CYIBitmap &other) = delete;
};

#endif // _YI_BITMAP_H_