xbmc/cores/RetroPlayer/RetroPlayerUtils.h

   1 /*
   2  *  Copyright (C) 2017-2018 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 "cores/GameSettings.h"
  12
  13 #include <string>
  14
  15 namespace KODI
  16 {
  17 namespace RETRO
  18 {
  19 class CRetroPlayerUtils
  20 {
  21 public:
  22   /*!
  23    * \brief Convert a stretch mode enum to a short string identifier
  24    *
  25    * \param stretchMode The stretch mode
  26    *
  27    * \return A short string identifier specified by GameSettings.h, or an
  28    *         empty string if the stretch mode is invalid
  29    */
  30   static const char* StretchModeToIdentifier(STRETCHMODE stretchMode);
  31
  32   /*!
  33    * \brief Convert a stretch mode identifier to an enum
  34    *
  35    * \param stretchMode The short string identifier, from GameSettings.h,
  36    *        representing the stretch mode
  37    *
  38    * \return The stretch mode enum, or STRETCHMODE::Normal if the identifier
  39    *         is invalid
  40    */
  41   static STRETCHMODE IdentifierToStretchMode(const std::string& stretchMode);
  42 };
  43 } // namespace RETRO
  44 } // namespace KODI