CreditSound.h

[詳解]

/// @file
/// @brief ビデオゲーム用のクレジット投入音列挙 CreditSound のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_CREDITSOUND_H
#define AMDAEMON_CREDITSOUND_H

#include "amdaemon/env.h"

namespace amdaemon
{
/// @addtogroup g_credit
/// @{

    /// ビデオゲーム用のクレジット投入音列挙。
    enum class CreditSound
    {
        None = 0,   ///< サウンドなし。
        Coin,       ///< コインカウントアップ音。
        Credit,     ///< クレジットカウントアップ音。
    };

    /// @brief @ref CreditSound 列挙値の文字列表現値を取得する。
    /// @param[in] sound @ref CreditSound 列挙値。
    /// @return @ref CreditSound 列挙値の文字列表現値。不正値の場合は nullptr 。
    /// @internal ライブラリ実装メモ: enumsToString.cpp で実装。
    const wchar_t* toString(CreditSound sound);

/// @}
} // namespace amdaemon

#endif // AMDAEMON_CREDITSOUND_H