#include "Containers/StringFwd.h"
#include "CoreFwd.h"
#include "CoreTypes.h"
#include "HAL/PlatformCrt.h"
#include "Math/NumericLimits.h"
#include "Misc/CompressionFlags.h"
#include "Misc/EnumClassFlags.h"

Include dependency graph for GenericPlatformMisc.h:

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

Go to the source code of this file.

Classes
struct	FSHA256Signature

struct	FProcessorGroupDesc

struct	FPageFaultStats

struct	FProcessIOStats

struct	FContextSwitchStats

struct	FGenericPlatformMisc

Namespaces
namespace	EBuildConfigurations

namespace	EBuildTargets

namespace	EErrorReportMode

namespace	EAppMsgType

namespace	EAppReturnType

Macros
#define	UE_DEBUG_BREAK() ((void)(FPlatformMisc::IsDebuggerPresent() && ([] () { UE_DEBUG_BREAK_IMPL(); } (), 1)))

Typedefs
typedef EBuildConfiguration	EBuildConfigurations::Type

typedef EBuildTargetType	EBuildTargets::Type

Enumerations
enum class	EBuildConfiguration : uint8 { Unknown , Debug , DebugGame , Development , Shipping , Test }

enum class	ECrashHandlingType : uint8 { Default , Disabled }

enum class	EBuildTargetType : uint8 { Unknown , Game , Server , Client , Editor , Program }

enum class	EConvertibleLaptopMode { NotSupported , Laptop , Tablet }

enum class	EDeviceScreenOrientation : uint8 { Unknown , Portrait , PortraitUpsideDown , LandscapeLeft , LandscapeRight , FaceUp , FaceDown , PortraitSensor , LandscapeSensor , FullSensor }

enum	EErrorReportMode::Type { EErrorReportMode::Interactive , EErrorReportMode::Unattended , EErrorReportMode::Balloon }

enum	EAppMsgType::Type { EAppMsgType::Ok , EAppMsgType::YesNo , EAppMsgType::OkCancel , EAppMsgType::YesNoCancel , EAppMsgType::CancelRetryContinue , EAppMsgType::YesNoYesAllNoAll , EAppMsgType::YesNoYesAllNoAllCancel , EAppMsgType::YesNoYesAll }

enum	EAppReturnType::Type { EAppReturnType::No , EAppReturnType::Yes , EAppReturnType::YesAll , EAppReturnType::NoAll , EAppReturnType::Cancel , EAppReturnType::Ok , EAppReturnType::Retry , EAppReturnType::Continue }

enum class	EMobileHapticsType : uint8 { FeedbackSuccess , FeedbackWarning , FeedbackError , SelectionChanged , ImpactLight , ImpactMedium , ImpactHeavy }

enum class	ENetworkConnectionStatus : uint8 { Unknown = 0 , Disabled , Local , Connected }

enum class	ENetworkConnectionType : uint8 { Unknown , None , AirplaneMode , Cell , WiFi , WiMAX , Bluetooth , Ethernet }

enum class	EProcessDiagnosticFlags : uint32 { None = 0 , MemorySanitizer = 1 << 0 , AnsiMalloc = 1 << 1 , StompMalloc = 1 << 2 }

enum class	EPageFaultFlags : uint8 { SoftPageFaults = 0x01 , HardPageFaults = 0x02 , TotalPageFaults = 0x04 , All = 0xFF }

enum class	EInputOutputFlags : uint8 { BlockingInput = 0x01 , BlockingOutput = 0x02 , BlockingOther = 0x04 , InputBytes = 0x08 , OutputBytes = 0x10 , OtherBytes = 0x20 , All = 0xFF }

enum class	EDisplayOutputFormat { SDR_sRGB = 0 , SDR_Rec709 = 1 , SDR_ExplicitGammaMapping = 2 , HDR_ACES_1000nit_ST2084 = 3 , HDR_ACES_2000nit_ST2084 = 4 , HDR_ACES_1000nit_ScRGB = 5 , HDR_ACES_2000nit_ScRGB = 6 , HDR_LinearEXR = 7 , HDR_LinearNoToneCurve = 8 , HDR_LinearWithToneCurve = 9 , MAX }

enum class	EDisplayColorGamut { sRGB_D65 = 0 , DCIP3_D65 = 1 , Rec2020_D65 = 2 , ACES_D60 = 3 , ACEScg_D60 = 4 , MAX }

enum class	EContextSwitchFlags : uint8 { VoluntaryContextSwitches = 0x01 , InvoluntaryContextSwitches = 0x02 , TotalContextSwitches = 0x04 , All = 0xFF }

Functions
bool	LexTryParseString (EBuildConfiguration &OutConfiguration, const TCHAR *Configuration)

const TCHAR *	LexToString (EBuildConfiguration Configuration)

	EBuildConfigurations::UE_DEPRECATED (4.24, "EBuildConfigurations::FromString() is deprecated. Use LexFromString() instead.") EBuildConfiguration FromString(const FString &Configuration)

	EBuildConfigurations::UE_DEPRECATED (4.24, "EBuildConfigurations::ToString() is deprecated. Use LexToString() instead.") const TCHAR *ToString(EBuildConfiguration Configuration)

FText	EBuildConfigurations::ToText (EBuildConfiguration Configuration)

bool	LexTryParseString (EBuildTargetType &OutType, const TCHAR *Text)

const TCHAR *	LexToString (EBuildTargetType Type)

EBuildTargetType	EBuildTargets::FromString (const FString &Target)

const TCHAR *	EBuildTargets::ToString (EBuildTargetType Target)

const TCHAR *	LexToString (EAppReturnType::Type Value)

const TCHAR *	LexToString (ENetworkConnectionStatus EnumVal)

	ENUM_CLASS_FLAGS (EProcessDiagnosticFlags)

const TCHAR *	LexToString (ENetworkConnectionType Target)

	ENUM_CLASS_FLAGS (EPageFaultFlags)

	ENUM_CLASS_FLAGS (EInputOutputFlags)

	ENUM_CLASS_FLAGS (EContextSwitchFlags)

Variables
static constexpr EBuildConfiguration	EBuildConfigurations::Unknown = EBuildConfiguration::Unknown

static constexpr EBuildConfiguration	EBuildConfigurations::Debug = EBuildConfiguration::Debug

static constexpr EBuildConfiguration	EBuildConfigurations::DebugGame = EBuildConfiguration::DebugGame

static constexpr EBuildConfiguration	EBuildConfigurations::Development = EBuildConfiguration::Development

static constexpr EBuildConfiguration	EBuildConfigurations::Test = EBuildConfiguration::Test

static constexpr EBuildConfiguration	EBuildConfigurations::Shipping = EBuildConfiguration::Shipping

static constexpr EBuildTargetType	EBuildTargets::Unknown = EBuildTargetType::Unknown

static constexpr EBuildTargetType	EBuildTargets::Editor = EBuildTargetType::Editor

static constexpr EBuildTargetType	EBuildTargets::Game = EBuildTargetType::Game

static constexpr EBuildTargetType	EBuildTargets::Server = EBuildTargetType::Server

Macro Definition Documentation

◆ UE_DEBUG_BREAK

#define UE_DEBUG_BREAK ( ) ((void)(FPlatformMisc::IsDebuggerPresent() && ([] () { UE_DEBUG_BREAK_IMPL(); } (), 1)))

Definition at line 41 of file GenericPlatformMisc.h.

Enumeration Type Documentation

◆ EBuildConfiguration

enum class EBuildConfiguration : uint8

strong

Available build configurations. Mirorred from UnrealTargetConfiguration.

Enumerator
Unknown	Unknown build configuration.
Debug	Debug build.
DebugGame	DebugGame build.
Development	Development build.
Shipping	Shipping build.
Test	Test build.

Definition at line 47 of file GenericPlatformMisc.h.

◆ EBuildTargetType

enum class EBuildTargetType : uint8

strong

Enumerates build target types.

Enumerator
Unknown	Unknown build target.
Game	Game target.
Server	Server target.
Client	Client target.
Editor	Editor target.
Program	Program target.

Definition at line 146 of file GenericPlatformMisc.h.

◆ EContextSwitchFlags

enum class EContextSwitchFlags : uint8

strong

Flags for Context Switch stats to retrieve

Enumerator
VoluntaryContextSwitches
InvoluntaryContextSwitches
TotalContextSwitches
All

Definition at line 521 of file GenericPlatformMisc.h.

◆ EConvertibleLaptopMode

enum class EConvertibleLaptopMode

strong

Enumerates the modes a convertible laptop can be in.

Enumerator
NotSupported	Not a convertible laptop.
Laptop	Laptop arranged as a laptop.
Tablet	Laptop arranged as a tablet.

Definition at line 211 of file GenericPlatformMisc.h.

◆ ECrashHandlingType

enum class ECrashHandlingType : uint8

strong

Controls behaviour for built in crash handling

Enumerator
Default
Disabled

Definition at line 71 of file GenericPlatformMisc.h.

◆ EDeviceScreenOrientation

enum class EDeviceScreenOrientation : uint8

strong

Device orientations for screens. e.g. Landscape, Portrait, etc.

Enumerator
Unknown	The orientation is not known
Portrait	The orientation is portrait with the home button at the bottom
PortraitUpsideDown	The orientation is portrait with the home button at the top
LandscapeLeft	The orientation is landscape with the home button at the right side
LandscapeRight	The orientation is landscape with the home button at the left side
FaceUp	The orientation is as if place on a desk with the screen upward
FaceDown	The orientation is as if place on a desk with the screen downward
PortraitSensor	The orientation is portrait, oriented upright with the sensor
LandscapeSensor	The orientation is landscape, oriented upright with the sensor
FullSensor	The orientation is no longer locked and adjusts according to the sensor

Definition at line 224 of file GenericPlatformMisc.h.

◆ EDisplayColorGamut

enum class EDisplayColorGamut

strong

Display gamut, format, and chromacities. You must update values in TonemapCommon.ush when changing this enum + EHDRCaptureGamut

Enumerator
sRGB_D65
DCIP3_D65
Rec2020_D65
ACES_D60
ACEScg_D60
MAX

Definition at line 492 of file GenericPlatformMisc.h.

◆ EDisplayOutputFormat

enum class EDisplayOutputFormat

strong

Defines the type of format the backbuffer expects. You must update values in TonemapCommon.ush when changing this enum

Enumerator
SDR_sRGB
SDR_Rec709
SDR_ExplicitGammaMapping
HDR_ACES_1000nit_ST2084
HDR_ACES_2000nit_ST2084
HDR_ACES_1000nit_ScRGB
HDR_ACES_2000nit_ScRGB
HDR_LinearEXR
HDR_LinearNoToneCurve
HDR_LinearWithToneCurve
MAX

Definition at line 473 of file GenericPlatformMisc.h.

◆ EInputOutputFlags

enum class EInputOutputFlags : uint8

strong

Flags for Input/Output stats to retrieve

Enumerator
BlockingInput
BlockingOutput
BlockingOther
InputBytes
OutputBytes
OtherBytes
All

Definition at line 456 of file GenericPlatformMisc.h.

◆ EMobileHapticsType

enum class EMobileHapticsType : uint8

strong

Enumerator
FeedbackSuccess
FeedbackWarning
FeedbackError
SelectionChanged
ImpactLight
ImpactMedium
ImpactHeavy

Definition at line 333 of file GenericPlatformMisc.h.

◆ ENetworkConnectionStatus

enum class ENetworkConnectionStatus : uint8

strong

Possible connection states

Enumerator
Unknown	Default state
Disabled	No network connection or network device disabled
Local	Ad-hoc Wifi network or LAN with no external connection
Connected	Connected to the network

Definition at line 346 of file GenericPlatformMisc.h.

◆ ENetworkConnectionType

enum class ENetworkConnectionType : uint8

strong

Enumerator
Unknown	Enumerates the network connection types
None
AirplaneMode
Cell
WiFi
WiMAX
Bluetooth
Ethernet

Definition at line 359 of file GenericPlatformMisc.h.

◆ EPageFaultFlags

enum class EPageFaultFlags : uint8

strong

Flags for page fault stats to retrieve

Enumerator
SoftPageFaults
HardPageFaults
TotalPageFaults
All

Definition at line 417 of file GenericPlatformMisc.h.

◆ EProcessDiagnosticFlags

enum class EProcessDiagnosticFlags : uint32

strong

Enumerator
None
MemorySanitizer
AnsiMalloc
StompMalloc

Definition at line 374 of file GenericPlatformMisc.h.

Function Documentation

◆ ENUM_CLASS_FLAGS() [1/4]

ENUM_CLASS_FLAGS ( EContextSwitchFlags )

◆ ENUM_CLASS_FLAGS() [2/4]

ENUM_CLASS_FLAGS ( EInputOutputFlags )

◆ ENUM_CLASS_FLAGS() [3/4]

ENUM_CLASS_FLAGS ( EPageFaultFlags )

◆ ENUM_CLASS_FLAGS() [4/4]

ENUM_CLASS_FLAGS ( EProcessDiagnosticFlags )

◆ LexToString() [1/5]

const TCHAR * LexToString ( EAppReturnType::Type Value )

Returns the string representation of the specified EAppReturnType::Type value.

Parameters

Value The value to get the string for.

Returns: The string representation.

◆ LexToString() [2/5]

const TCHAR * LexToString ( EBuildConfiguration Configuration )

Returns the string representation of the specified EBuildConfiguration value.

Parameters

Configuration The value to get the string for.

Returns: The string representation.

◆ LexToString() [3/5]

const TCHAR * LexToString ( EBuildTargetType Type )

Returns the string representation of the specified EBuildTargetType value.

Parameters

Target The string to get the EBuildTargetType for.

Returns: An EBuildTarget::Type value.

◆ LexToString() [4/5]

const TCHAR * LexToString ( ENetworkConnectionStatus EnumVal )

◆ LexToString() [5/5]

const TCHAR * LexToString ( ENetworkConnectionType Target )

Returns the string representation of the specified ENetworkConnection value.

Parameters

Target The value to get the string for.

Returns: The string representation.

◆ LexTryParseString() [1/2]

bool LexTryParseString	(	EBuildConfiguration &	OutConfiguration,
		const TCHAR *	Configuration )

Returns the string representation of the specified EBuildConfiguration value.

Parameters

Configuration The string to get the EBuildConfiguration for.

Returns: An EBuildConfiguration value.

◆ LexTryParseString() [2/2]

bool LexTryParseString	(	EBuildTargetType &	OutType,
		const TCHAR *	Text )

Returns the string representation of the specified EBuildTarget value.

Parameters

OutType	The value to get the string for.
Text	The text to parse.

Returns: The string representation.

Classes

Namespaces

Macros

Typedefs

Enumerations

Functions

Variables

Macro Definition Documentation

◆ UE_DEBUG_BREAK

Enumeration Type Documentation

◆ EBuildConfiguration

◆ EBuildTargetType

◆ EContextSwitchFlags

◆ EConvertibleLaptopMode

◆ ECrashHandlingType

◆ EDeviceScreenOrientation

◆ EDisplayColorGamut

◆ EDisplayOutputFormat

◆ EInputOutputFlags

◆ EMobileHapticsType

◆ ENetworkConnectionStatus

◆ ENetworkConnectionType

◆ EPageFaultFlags

◆ EProcessDiagnosticFlags

Function Documentation

◆ ENUM_CLASS_FLAGS() [1/4]

◆ ENUM_CLASS_FLAGS() [2/4]

◆ ENUM_CLASS_FLAGS() [3/4]

◆ ENUM_CLASS_FLAGS() [4/4]

◆ LexToString() [1/5]

◆ LexToString() [2/5]

◆ LexToString() [3/5]

◆ LexToString() [4/5]

◆ LexToString() [5/5]

◆ LexTryParseString() [1/2]

◆ LexTryParseString() [2/2]