YiTextureAtlas.h

Go to the documentation of this file.

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

/*****************************************************************************
    Includes
****************************************************************************/
#include "asset/YiAssetTexture.h"
#include "graphics/YiBitmap.h"
#include <glm/gtc/type_ptr.hpp>


typedef struct
{
    ssize_t ID;
    void * pReference;
    uint32_t unPage;
    int32_t nStartX;
    int32_t nStartY;
    int32_t nWidth;
    int32_t nHeight;
    float fUV_S0;
    float fUV_T0;
    float fUV_S1;
    float fUV_T1;
    uint32_t unRefCount;
} YI_TEXTURE_DETAILS;

typedef struct
{
    std::vector<YI_TEXTURE_DETAILS>  Textures;     /* Vector of textures */
} YI_LOADED_TEXTURES;

typedef struct
{
    YI_RECT_REL Area;
    uint32_t unPage;
    bool bValid;
} YI_REGION;

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

    bool CreateNewAtlas(uint32_t unWidth, uint32_t unHeight, uint32_t unPages);

    /* Returns a region allocation based on a requested size
        The atlas can hold anything, this method is used if
        you are using the regioning for packing data. */
    YI_REGION GetRegion(int32_t nWidth, int32_t nHeight);

    //Set pixels and references in a region allocation based on a requested size
    virtual void SetRegion(ssize_t ID, void *pReference, YI_REGION Region, const uint8_t *data, const int32_t nStride);

    //Get the details of a texture region from the atlas. Increments the use count
    virtual YI_TEXTURE_DETAILS *GetTexture(ssize_t ID, void *pReference);

    //Update the atlas, forces a GPU update
    void UpdateAtlas();

    //Get the atlas bitmap image
    const std::shared_ptr<CYIBitmap> GetBitmap() const;

    //Get the atlas node array
    const std::vector<glm::ivec4> *GetNodes(uint32_t unPage) const;

    //Get the GPU texture for the atlas
    virtual std::shared_ptr<CYIAssetTexture> GetGLTexture() const;

    const std::shared_ptr<CYIAssetTexture> GetTextureAsset()
    {
        return m_pTextureAsset;
    }

    //Get the array of textures in the atlas
    YI_LOADED_TEXTURES * GetLoadedTextures();

    void SetTextureFilter(CYIAssetTexture::YI_MIN_MAG_FILTER minificationFilter, CYIAssetTexture::YI_MIN_MAG_FILTER magnificationFilter);

    void SetTextureWrap(CYIAssetTexture::YI_TEXTURE_WRAP wrapS, CYIAssetTexture::YI_TEXTURE_WRAP wrapT);
    
    void SetName(const CYIString &name);
    const CYIString &GetName() const;
    
    float GetAtlasPercentageUsed() const;

    bool RenderAtlasToPng(const CYIString &filePath) const;

    void Reset();

protected:
    int32_t Fit(uint32_t unPage, uint32_t unIndex, int32_t nWidth, int32_t nHeight);
    void Merge(uint32_t unPage);

    CYIString m_name;
    std::shared_ptr<CYIBitmap> m_Image;
    std::vector<glm::ivec4> m_Nodes[4];
    std::shared_ptr<CYIAssetTexture> m_pTextureAsset;
    YI_LOADED_TEXTURES m_Textures;
    int32_t m_nWidth;
    int32_t m_nHeight;
    uint32_t m_unPages;
    CYIAssetTexture::YI_TEXTURE_CONFIG m_textureConfiguration;
    uint32_t m_unPixelsUsed;
    uint32_t m_unLastUpdatedSize;
};

#endif // _YI_TEXTURE_ATLAS_H_