EnumClassFlags.h File Reference

Additional utilities for Unreal Engine's enum routines macros. More...

#include "EnumClassFlags.h"

Include dependency graph for EnumClassFlags.h:

This graph shows which files directly or indirectly include this file:

Macros
#define	MORE_ENUM_CLASS_FLAGS(Enum, Bit)
	Operators with individual bit functionality.

Functions
template<typename EnumT , typename BitT >
EnumT &	EnumSetFlag (EnumT &Flags, const BitT Bit, const bool bState=true)
	Set or clear an enum flag.
template<typename EnumT , typename BitT >
constexpr EnumT	EnumWithFlagSet (const EnumT Flags, const BitT Bit, const bool bState=true)
	Enum with a set/cleared bit.
template<typename EnumT , typename BitT >
constexpr EnumT	EnumWithFlagToggled (const EnumT Flags, const BitT Bit)
	Enum with a toggled bit.
template<typename EnumT , typename BitT >
constexpr bool	EnumHasFlag (const EnumT Flags, const BitT Bit)
	Examine if the enum has a certain flag set.

Detailed Description

Additional utilities for Unreal Engine's enum routines macros.

Macro Definition Documentation

MORE_ENUM_CLASS_FLAGS

#define MORE_ENUM_CLASS_FLAGS	(		Enum,
			Bit
	)

Value:

    using Enum##Type = __underlying_type(Enum);                                                                                                                       \
    inline           Enum  FlagToEnum(const Bit Flag)            { return (Enum)((__underlying_type(Enum))1 << (int)Flag); }                                          \
    inline           Enum& operator-=(Enum& Lhs, const Enum Rhs) { return Lhs = (Enum)( (__underlying_type(Enum))Lhs & ~((__underlying_type(Enum))Rhs) ); }           \
    inline constexpr Enum  operator- (Enum  Lhs, const Enum Rhs) { return (Enum)( (__underlying_type(Enum))Lhs & ~((__underlying_type(Enum))Rhs) ); }                 \
    inline           Enum& operator|=(Enum& Lhs, const Bit  Rhs) { return Lhs = (Enum)( (__underlying_type(Enum))Lhs | ((__underlying_type(Enum))1 << (int)Rhs) ); }  \
    inline           Enum& operator&=(Enum& Lhs, const Bit  Rhs) { return Lhs = (Enum)( (__underlying_type(Enum))Lhs & ((__underlying_type(Enum))1 << (int)Rhs) ); }  \
    inline           Enum& operator^=(Enum& Lhs, const Bit  Rhs) { return Lhs = (Enum)( (__underlying_type(Enum))Lhs ^ ((__underlying_type(Enum))1 << (int)Rhs) ); }  \
    inline constexpr Enum  operator| (Enum  Lhs, const Bit  Rhs) { return (Enum)( (__underlying_type(Enum))Lhs | ((__underlying_type(Enum))1 << (int)Rhs) ); }        \
    inline constexpr Enum  operator& (Enum  Lhs, const Bit  Rhs) { return (Enum)( (__underlying_type(Enum))Lhs & ((__underlying_type(Enum))1 << (int)Rhs) ); }        \
    inline constexpr Enum  operator^ (Enum  Lhs, const Bit  Rhs) { return (Enum)( (__underlying_type(Enum))Lhs ^ ((__underlying_type(Enum))1 << (int)Rhs) ); }        \
    inline           Enum& operator+=(Enum& Lhs, const Bit  Rhs) { return Lhs = (Enum)( (__underlying_type(Enum))Lhs |   (__underlying_type(Enum))1 << (int)Rhs ); }  \
    inline           Enum& operator-=(Enum& Lhs, const Bit  Rhs) { return Lhs = (Enum)( (__underlying_type(Enum))Lhs & ~((__underlying_type(Enum))1 << (int)Rhs) ); } \
    inline constexpr Enum  operator- (Enum  Lhs, const Bit  Rhs) { return (Enum)( (__underlying_type(Enum))Lhs & ~((__underlying_type(Enum))1 << (int)Rhs) ); }       \
    inline constexpr Enum  operator+ (Enum  Lhs, const Bit  Rhs) { return (Enum)( (__underlying_type(Enum))Lhs |  ((__underlying_type(Enum))1 << (int)Rhs) ); }       \
    inline constexpr Enum  operator| (const Bit Lhs, const Bit Rhs) { return (Enum)( ((__underlying_type(Enum))1 << (int)Lhs) | ((__underlying_type(Enum))1 << (int)Rhs) ); } \
    inline constexpr Enum  operator& (const Bit Lhs, const Bit Rhs) { return (Enum)( ((__underlying_type(Enum))1 << (int)Lhs) & ((__underlying_type(Enum))1 << (int)Rhs) ); }

Operators with individual bit functionality.

Parameters

Enum	The type of enum bit flags.
Bit	The type of the individual bits enum.

Function Documentation

EnumHasFlag()

template<typename EnumT , typename BitT >

constexpr bool EnumHasFlag ( const EnumT  Flags, const BitT  Bit  )

inlineconstexpr

Examine if the enum has a certain flag set.

Template Parameters

EnumT	The type of enum to set.
BitT	The bit type to set.

Parameters

Flags	The flags to alter.
Bit	The flagmark bit to examine.

Returns

true The bit is set within the flags.

false The bit is cleared within the flags.

EnumSetFlag()

template<typename EnumT , typename BitT >

EnumT & EnumSetFlag ( EnumT &  Flags, const BitT  Bit, const bool  bState = true  )

inline

Set or clear an enum flag.

Template Parameters

EnumT	The type of enum to set.
BitT	The bit type to set.

Parameters

Flags	The flags to alter.
Bit	The bit to change.
bState	The state to set.

EnumWithFlagSet()

template<typename EnumT , typename BitT >

constexpr EnumT EnumWithFlagSet ( const EnumT  Flags, const BitT  Bit, const bool  bState = true  )

inlineconstexpr

Enum with a set/cleared bit.

The original enum is not changed.

Template Parameters

EnumT	The type of enum to set.
BitT	The bit type to set.

Parameters

Flags	The flags to alter.
Bit	The bit to change.
bState	The state to set.

EnumWithFlagToggled()

template<typename EnumT , typename BitT >

constexpr EnumT EnumWithFlagToggled ( const EnumT  Flags, const BitT  Bit  )

inlineconstexpr

Enum with a toggled bit.

The original enum is not changed.

Template Parameters

EnumT	The type of enum to toggle within.
BitT	The bit type to toggle.

Parameters

Flags	The flags to alter.
Bit	The bit to toggle.