xbmc/imagefiles/SpecialImageFileLoader.h

   1 /*
   2  *  Copyright (C) 2023 Team Kodi
   3  *  This file is part of Kodi - https://kodi.tv
   4  *
   5  *  SPDX-License-Identifier: GPL-2.0-or-later
   6  *  See LICENSES/README.md for more information.
   7  */
   8
   9 #pragma once
  10
  11 #include <memory>
  12 #include <string>
  13
  14 class CTexture;
  15
  16 namespace IMAGE_FILES
  17 {
  18
  19 /*!
  20  * @brief An interface to load special image files into a texture for display.
  21  *
  22  * Special image files are images that are more than just a link or path to an
  23  * image file, such as generated or embedded images - like album covers
  24  * embedded in music files or thumbnails generated from video files.
  25 */
  26 class ISpecialImageFileLoader
  27 {
  28 public:
  29   virtual bool CanLoad(const std::string& specialType) const = 0;
  30   virtual std::unique_ptr<CTexture> Load(const std::string& specialType,
  31                                          const std::string& filePath,
  32                                          unsigned int preferredWidth,
  33                                          unsigned int preferredHeight) const = 0;
  34   virtual ~ISpecialImageFileLoader() = default;
  35 };
  36
  37 } // namespace IMAGE_FILES