BitmapCache.h

// 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/Bitmap.h>
#include <kiwano/render/GifImage.h>
 
namespace kiwano
{
class KGE_API BitmapCache final
{
public:
    RefPtr<Bitmap> Preload(StringView file_path);
 
    RefPtr<Bitmap> Preload(const Resource& res);
 
    RefPtr<GifImage> PreloadGif(StringView file_path);
 
    RefPtr<GifImage> PreloadGif(const Resource& res);
 
    void AddBitmap(size_t key, RefPtr<Bitmap> Bitmap);
 
    void AddGifImage(size_t key, RefPtr<GifImage> gif);
 
    RefPtr<Bitmap> GetBitmap(size_t key) const;
 
    RefPtr<GifImage> GetGifImage(size_t key) const;
 
    void RemoveBitmap(size_t key);
 
    void RemoveGifImage(size_t key);
 
    void Clear();
 
    ~BitmapCache();
 
private:
    BitmapCache();
 
private:
    using BitmapMap = UnorderedMap<size_t, RefPtr<Bitmap>>;
    BitmapMap Bitmap_cache_;
 
    using GifImageMap = UnorderedMap<size_t, RefPtr<GifImage>>;
    GifImageMap gif_Bitmap_cache_;
};
 
}  // namespace kiwano