shz::version Class Reference

#include <shz_version.hpp>

Public Member Functions
constexpr	version (shz_version_t value) noexcept
constexpr	version (uint8_t major, uint16_t minor, uint8_t patch) noexcept
constexpr	operator shz_version_t () const noexcept
constexpr version	operator= (uint32_t rhs) noexcept
constexpr uint8_t	major () const noexcept
constexpr uint16_t	minor () const noexcept
constexpr uint8_t	patch () const noexcept

Static Public Member Functions
static constexpr version	compiled () noexcept
static version	linked () noexcept

Detailed Description

Class representing a full SH4ZAM API version.

Definition at line 21 of file shz_version.hpp.

Constructor & Destructor Documentation

version() [1/2]

shz::version::version ( shz_version_t value )

inlineconstexprnoexcept

Constructs a version from the given full value.

Definition at line 26 of file shz_version.hpp.

                                                       :
            value_(value) {}

version() [2/2]

shz::version::version ( uint8_t major, uint16_t minor, uint8_t patch )

inlineconstexprnoexcept

Constructs a full version from the given component values.

Definition at line 30 of file shz_version.hpp.

                                                                                :
            version(SHZ_VERSION_INIT(major, minor, patch)) {}

Member Function Documentation

compiled()

static constexpr version shz::version::compiled ( )

inlinestaticconstexprnoexcept

Compile-time version of SH4ZAM headers which are being included.

Definition at line 34 of file shz_version.hpp.

{ return SHZ_VERSION; }

linked()

static version shz::version::linked ( )

inlinestaticnoexcept

Link-time version of SH4ZAM library which was linked against.

Definition at line 37 of file shz_version.hpp.

{ return shz_version_linked(); }

operator shz_version_t()

shz::version::operator shz_version_t ( ) const

inlineconstexprnoexcept

Implicit conversion operator to make this class automatically comparable to a uint32_t.

Definition at line 40 of file shz_version.hpp.

{ return value_; }

operator=()

version shz::version::operator= ( uint32_t rhs )

inlineconstexprnoexcept

Assignment operator for assigning a version to a full version ID value.

Definition at line 43 of file shz_version.hpp.

{ value_ = rhs; return *this; }

major()

uint8_t shz::version::major ( ) const

inlineconstexprnoexcept

Extracts the major component value from a full version.

Definition at line 46 of file shz_version.hpp.

{ return (value_ >> 24) & 0xff; }

minor()

uint16_t shz::version::minor ( ) const

inlineconstexprnoexcept

Extracts the minor component value from a full version.

Definition at line 49 of file shz_version.hpp.

{ return (value_ >> 8) & 0xffff; }

patch()

uint8_t shz::version::patch ( ) const

inlineconstexprnoexcept

Extracts the patch component value from a full version.

Definition at line 52 of file shz_version.hpp.

{ return value_ & 0xff; }

---

The documentation for this class was generated from the following file:

• shz_version.hpp