YiAssetTextureBase.h

Go to the documentation of this file.

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

#include "asset/YiAssetHardware.h"
#include "framework/YiPredef.h"
#include "graphics/YiBitmap.h"
#include "renderer/YiMaterialFactory.h"
#include "utility/YiRtti.h"

class CYIAssetTextureBase : public CYIAssetHardware
{
public:
    enum YI_MIN_MAG_FILTER {
        YI_LINEAR,                      
        YI_NEAREST                      
    };

    enum YI_TEXTURE_WRAP {
        YI_CLAMP_TO_EDGE,               
        YI_MIRROR,                      
        YI_REPEAT                       
    };

    enum USAGE
    {
        USAGE_STATIC,        
        USAGE_DYNAMIC,       
        USAGE_RENDER_TARGET  
    };

    struct YI_TEXTURE_CONFIG
    {
        YI_TEXTURE_CONFIG();
        YI_TEXTURE_WRAP wrapS, wrapT;
        YI_MIN_MAG_FILTER minFilter, magFilter;
        bool bUseMipmaps;
    };

public:
    CYIAssetTextureBase(USAGE usage = USAGE_STATIC);

    virtual ~CYIAssetTextureBase();

    void AddDirtyRegion(const YI_RECT_REL &dirtyRectangle);
    
    void ClearDirtyRegions();
       
    const std::vector<YI_RECT_REL> &GetDirtyRegions() const;

    const YI_TEXTURE_CONFIG &GetConfiguration() const;

    virtual int32_t GetWidth() const;

    virtual int32_t GetHeight() const;

    IYIMaterialFactory::YI_COLORSPACE GetColorSpace() const;

    void SetConfiguration(const YI_TEXTURE_CONFIG &config);

    void SetMinificationFilter(YI_MIN_MAG_FILTER minFilter = YI_LINEAR, YI_MIN_MAG_FILTER magFilter = YI_LINEAR);

    void SetMipmappingEnabled(bool bEnable);

    bool IsMipmappingEnabled() const;

    void SetTextureWrap(YI_TEXTURE_WRAP wrapS = YI_CLAMP_TO_EDGE, YI_TEXTURE_WRAP wrapT = YI_CLAMP_TO_EDGE);

    virtual bool HasExtendedDimensions() const;

    USAGE GetUsage() const;

protected:
    virtual std::shared_ptr<IYIGPUObject> CreateGPUObject() const override = 0;

    virtual void OnUnload() override = 0;

    virtual void DirtyEntireTexture();
    
    void SetWidth(int32_t nWidth);

    void SetHeight(int32_t nHeight);

    void SetColorSpace(IYIMaterialFactory::YI_COLORSPACE eColorSpace);

    virtual void ApplyRetainmentPolicy() override;

private:
    int32_t m_nWidth;
    int32_t m_nHeight;
    IYIMaterialFactory::YI_COLORSPACE m_eColorSpace;

    YI_TEXTURE_CONFIG m_textureConfiguration;
    std::vector<YI_RECT_REL> m_dirtyRegions;
    USAGE m_usage;

    YI_TYPE_BASES(CYIAssetTextureBase, CYIAssetHardware)
};

#endif // _YI_ASSET_TEXTURE_BASE_H_