Resolution.h

[詳解]

/// @file
/// @brief 画面解像度情報構造体 Resolution のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_RESOLUTION_H
#define AMDAEMON_RESOLUTION_H

#include <cstdint>

namespace amdaemon
{
/// @addtogroup g_system
/// @{

    /// @brief 画面解像度情報構造体。
    /// @note memcpy 可能。
    /// @internal ライブラリ実装メモ: この型を直接共有メモリに配置する。
    struct Resolution
    {
        std::uint32_t width;    ///< 横幅。
        std::uint32_t height;   ///< 縦幅。

        /// @brief インスタンスを作成する。
        /// @param[in] width 横幅。
        /// @param[in] height 縦幅。
        /// @return 作成したインスタンス。
        static Resolution make(std::uint32_t width, std::uint32_t height)
        {
            Resolution result = { width, height };
            return result;
        }
    };

/// @}

    /// @brief 等価比較演算子のオーバロード。
    /// @param[in] l 左辺値。
    /// @param[in] r 右辺値。
    /// @return 比較結果値。
    /// @relatesalso Resolution
    inline bool operator==(const Resolution& l, const Resolution& r)
    {
        return (l.width == r.width && l.height == r.height);
    }

    /// @brief 非等価比較演算子のオーバロード。
    /// @param[in] l 左辺値。
    /// @param[in] r 右辺値。
    /// @return 比較結果値。
    /// @relatesalso Resolution
    inline bool operator!=(const Resolution& l, const Resolution& r)
    {
        return !(l == r);
    }
} // namespace amdaemon

#endif // AMDAEMON_RESOLUTION_H