YiAbstractTextAtlas.h

Go to the documentation of this file.

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

#include "graphics/YiTextureAtlas.h"


struct YI_GLYPH_DETAILS
{
    ssize_t uFontID;

    int32_t nFontSize;

    uint32_t uGlyphID;

    uint32_t uTextureIndex;
};

class CYIAbstractTextAtlas : public CYITextureAtlas
{
public:
    CYIAbstractTextAtlas();
    virtual ~CYIAbstractTextAtlas();

    virtual bool CreateNewFontAtlas(uint32_t uWidth, uint32_t uHeight) = 0;

    virtual void SetRegion(ssize_t nID, void *pReference, YI_REGION Region, const uint8_t *pData, const int32_t nStride) override = 0;

    virtual YI_TEXTURE_DETAILS *GetTexture(ssize_t nID, void *pReference) override;

    int32_t GetGlyphPadding() const;

    bool AddGlyph(const uint32_t uGlyphWidth, const uint32_t uGlyphHeight, YI_GLYPH_DETAILS *pGlyphDetails, const uint8_t *pData, const int32_t nStride);

protected:
    void SetGlyphPadding(int32_t nGlyphPadding);

    /*
        \details This function is called in GetTexture to determine whether the requested glyph matches
        a glyph which already exists in the atlas. Implementations should use this to compare whether the
        requested glyph matches the existing candidate glyph based on their own criteria.
     
        The default implementation compares font size, glyph ID, and font ID.
    */
    virtual bool CompareGlyphDetails(YI_GLYPH_DETAILS *pLeft, YI_GLYPH_DETAILS *pRight) const;

private:
    int32_t m_nGlyphPadding;
};

#endif