Magic_Game/src/kiwano/render/TextureCache.h

101 lines
2.7 KiB
C++

// Copyright (c) 2016-2019 Kiwano - Nomango
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
#pragma once
#include <kiwano/render/GifImage.h>
#include <kiwano/render/Texture.h>
#include <kiwano/core/Singleton.h>
namespace kiwano
{
/**
* \addtogroup Render
* @{
*/
/**
* \~chinese
* @brief 纹理缓存
*/
class KGE_API TextureCache final : public Singleton<TextureCache>
{
friend Singleton<TextureCache>;
public:
/// \~chinese
/// @brief 预加载本地图片
TexturePtr Preload(const String& file_path);
/// \~chinese
/// @brief 预加载图片资源
TexturePtr Preload(const Resource& res);
/// \~chinese
/// @brief 预加载本地GIF图片
GifImagePtr PreloadGif(const String& file_path);
/// \~chinese
/// @brief 预加载GIF图片资源
GifImagePtr PreloadGif(const Resource& res);
/// \~chinese
/// @brief 添加纹理缓存
void AddTexture(size_t key, TexturePtr texture);
/// \~chinese
/// @brief 添加GIF图像缓存
void AddGifImage(size_t key, GifImagePtr gif);
/// \~chinese
/// @brief 获取纹理缓存
TexturePtr GetTexture(size_t key) const;
/// \~chinese
/// @brief 获取GIF图像缓存
GifImagePtr GetGifImage(size_t key) const;
/// \~chinese
/// @brief 移除纹理缓存
void RemoveTexture(size_t key);
/// \~chinese
/// @brief 移除GIF图像缓存
void RemoveGifImage(size_t key);
/// \~chinese
/// @brief 清空缓存
void Clear();
~TextureCache();
private:
TextureCache();
private:
using TextureMap = UnorderedMap<size_t, TexturePtr>;
TextureMap texture_cache_;
using GifImageMap = UnorderedMap<size_t, GifImagePtr>;
GifImageMap gif_texture_cache_;
};
/** @} */
} // namespace kiwano