UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
WindowsPlatform.h File Reference
#include <sal.h>
#include "Microsoft/MSVCPlatform.h"
#include "GenericPlatform/GenericPlatform.h"

Go to the source code of this file.

Classes

struct  FWindowsPlatformTypes
 

Macros

#define PLATFORM_COMPILER_CLANG   0
 
#define PLATFORM_DESKTOP   1
 
#define PLATFORM_64BITS   0
 
#define PLATFORM_CAN_SUPPORT_EDITORONLY_DATA   1
 
#define PLATFORM_LITTLE_ENDIAN   1
 
#define PLATFORM_SUPPORTS_UNALIGNED_LOADS   1
 
#define PLATFORM_SUPPORTS_FLIP_TRACKING   1
 
#define PLATFORM_SUPPORTS_PRAGMA_PACK   1
 
#define PLATFORM_ALWAYS_HAS_FMA3   0
 
#define PLATFORM_USE_LS_SPEC_FOR_WIDECHAR   0
 
#define PLATFORM_HAS_BSD_TIME   0
 
#define PLATFORM_USE_PTHREADS   0
 
#define PLATFORM_USES_UNFAIR_LOCKS   1
 
#define PLATFORM_MAX_FILEPATH_LENGTH_DEPRECATED   WINDOWS_MAX_PATH
 
#define PLATFORM_HAS_BSD_IPV6_SOCKETS   1
 
#define PLATFORM_HAS_BSD_SOCKET_FEATURE_WINSOCKETS   1
 
#define PLATFORM_USES_MICROSOFT_LIBC_FUNCTIONS   1
 
#define PLATFORM_IS_ANSI_MALLOC_THREADSAFE   1
 
#define PLATFORM_SUPPORTS_ASYMMETRIC_FENCES   1
 
#define PLATFORM_SUPPORTS_TBB   1
 
#define PLATFORM_SUPPORTS_MIMALLOC   PLATFORM_64BITS
 
#define PLATFORM_SUPPORTS_NAMED_PIPES   1
 
#define PLATFORM_COMPILER_HAS_TCHAR_WMAIN   1
 
#define PLATFORM_SUPPORTS_EARLY_MOVIE_PLAYBACK   (!WITH_EDITOR)
 
#define PLATFORM_USE_GENERIC_STRING_IMPLEMENTATION   0
 
#define PLATFORM_SUPPORTS_VARIABLE_RATE_SHADING   1
 
#define PLATFORM_SUPPORTS_MESH_SHADERS   1
 
#define PLATFORM_SUPPORTS_WORKGRAPH_SHADERS   1
 
#define PLATFORM_SUPPORTS_BINDLESS_RENDERING   1
 
#define PLATFORM_USES__ALIGNED_MALLOC   1
 
#define PLATFORM_SUPPORTS_STACK_SYMBOLS   1
 
#define PLATFORM_GLOBAL_LOG_CATEGORY   LogWindows
 
#define PLATFORM_SUPPORTS_BORDERLESS_WINDOW   1
 
#define PLATFORM_RETURN_ADDRESS_FOR_CALLSTACKTRACING   PLATFORM_RETURN_ADDRESS_POINTER
 
#define PLATFORM_USE_CALLSTACK_ADDRESS_POINTER   1
 
#define WINDOWS_USE_FEATURE_APPLICATIONMISC_CLASS   1
 
#define WINDOWS_USE_FEATURE_PLATFORMMISC_CLASS   1
 
#define WINDOWS_USE_FEATURE_PLATFORMHTTP_CLASS   1
 
#define PLATFORM_BREAK()   (__nop(), __debugbreak())
 
#define PLATFORM_BREAK_IS_EXPRESSION   1
 
#define PLATFORM_HAS_128BIT_ATOMICS   (PLATFORM_64BITS && (WINVER >= 0x602))
 
#define VARARGS   __cdecl /* Functions with variable arguments */
 
#define CDECL   __cdecl /* Standard C function */
 
#define STDCALL   __stdcall /* Standard calling convention */
 
#define FORCEINLINE   __forceinline /* Force code to be inline */
 
#define FORCENOINLINE   __declspec(noinline) /* Force code to NOT be inline */
 
#define FUNCTION_NON_NULL_RETURN_START   _Ret_notnull_ /* Indicate that the function never returns nullptr. */
 
#define DECLARE_UINT64(x)   x
 
#define PRAGMA_DISABLE_OPTIMIZATION_ACTUAL   __pragma(optimize("",off))
 
#define PRAGMA_ENABLE_OPTIMIZATION_ACTUAL   __pragma(optimize("",on))
 
#define PLATFORM_EMPTY_BASES   __declspec(empty_bases)
 
#define PLATFORM_CODE_SECTION(Name)   __declspec(code_seg(Name))
 
#define TYPENAME_OUTSIDE_TEMPLATE
 
#define ABSTRACT   abstract
 
#define LINE_TERMINATOR   TEXT("\r\n")
 
#define LINE_TERMINATOR_ANSI   "\r\n"
 
#define MS_ALIGN(n)   __declspec(align(n))
 
#define MSVC_PRAGMA(Pragma)   __pragma(Pragma)
 
#define PLATFORM_CACHE_LINE_SIZE   64
 
#define DLLEXPORT   __declspec(dllexport)
 
#define DLLIMPORT   __declspec(dllimport)
 
#define ENABLE_WIN_ALLOC_TRACKING   0
 
#define WINDOWS_LOWINTEGRITYLEVEL_EXPECT_DEFAULT   0
 
#define WINDOWS_LOWINTEGRITYLEVEL_AUTOMIGRATE_USERDATA   0
 

Typedefs

typedef FWindowsPlatformTypes FPlatformTypes
 

Macro Definition Documentation

◆ ABSTRACT

#define ABSTRACT   abstract

◆ CDECL

#define CDECL   __cdecl /* Standard C function */

◆ DECLARE_UINT64

#define DECLARE_UINT64 (   x)    x

◆ DLLEXPORT

#define DLLEXPORT   __declspec(dllexport)

◆ DLLIMPORT

#define DLLIMPORT   __declspec(dllimport)

◆ ENABLE_WIN_ALLOC_TRACKING

#define ENABLE_WIN_ALLOC_TRACKING   0

◆ FORCEINLINE

#define FORCEINLINE   __forceinline /* Force code to be inline */

◆ FORCENOINLINE

#define FORCENOINLINE   __declspec(noinline) /* Force code to NOT be inline */

◆ FUNCTION_NON_NULL_RETURN_START

#define FUNCTION_NON_NULL_RETURN_START   _Ret_notnull_ /* Indicate that the function never returns nullptr. */

◆ LINE_TERMINATOR

#define LINE_TERMINATOR   TEXT("\r\n")

◆ LINE_TERMINATOR_ANSI

#define LINE_TERMINATOR_ANSI   "\r\n"

◆ MS_ALIGN

#define MS_ALIGN (   n)    __declspec(align(n))

◆ MSVC_PRAGMA

#define MSVC_PRAGMA (   Pragma)    __pragma(Pragma)

◆ PLATFORM_64BITS

#define PLATFORM_64BITS   0

◆ PLATFORM_ALWAYS_HAS_FMA3

#define PLATFORM_ALWAYS_HAS_FMA3   0

◆ PLATFORM_BREAK

#define PLATFORM_BREAK ( )    (__nop(), __debugbreak())

◆ PLATFORM_BREAK_IS_EXPRESSION

#define PLATFORM_BREAK_IS_EXPRESSION   1

◆ PLATFORM_CACHE_LINE_SIZE

#define PLATFORM_CACHE_LINE_SIZE   64

◆ PLATFORM_CAN_SUPPORT_EDITORONLY_DATA

#define PLATFORM_CAN_SUPPORT_EDITORONLY_DATA   1

◆ PLATFORM_CODE_SECTION

#define PLATFORM_CODE_SECTION (   Name)    __declspec(code_seg(Name))

◆ PLATFORM_COMPILER_CLANG

#define PLATFORM_COMPILER_CLANG   0

◆ PLATFORM_COMPILER_HAS_TCHAR_WMAIN

#define PLATFORM_COMPILER_HAS_TCHAR_WMAIN   1

◆ PLATFORM_DESKTOP

#define PLATFORM_DESKTOP   1

◆ PLATFORM_EMPTY_BASES

#define PLATFORM_EMPTY_BASES   __declspec(empty_bases)

◆ PLATFORM_GLOBAL_LOG_CATEGORY

#define PLATFORM_GLOBAL_LOG_CATEGORY   LogWindows

◆ PLATFORM_HAS_128BIT_ATOMICS

#define PLATFORM_HAS_128BIT_ATOMICS   (PLATFORM_64BITS && (WINVER >= 0x602))

◆ PLATFORM_HAS_BSD_IPV6_SOCKETS

#define PLATFORM_HAS_BSD_IPV6_SOCKETS   1

◆ PLATFORM_HAS_BSD_SOCKET_FEATURE_WINSOCKETS

#define PLATFORM_HAS_BSD_SOCKET_FEATURE_WINSOCKETS   1

◆ PLATFORM_HAS_BSD_TIME

#define PLATFORM_HAS_BSD_TIME   0

◆ PLATFORM_IS_ANSI_MALLOC_THREADSAFE

#define PLATFORM_IS_ANSI_MALLOC_THREADSAFE   1

◆ PLATFORM_LITTLE_ENDIAN

#define PLATFORM_LITTLE_ENDIAN   1

◆ PLATFORM_MAX_FILEPATH_LENGTH_DEPRECATED

#define PLATFORM_MAX_FILEPATH_LENGTH_DEPRECATED   WINDOWS_MAX_PATH

◆ PLATFORM_RETURN_ADDRESS_FOR_CALLSTACKTRACING

#define PLATFORM_RETURN_ADDRESS_FOR_CALLSTACKTRACING   PLATFORM_RETURN_ADDRESS_POINTER

◆ PLATFORM_SUPPORTS_ASYMMETRIC_FENCES

#define PLATFORM_SUPPORTS_ASYMMETRIC_FENCES   1

◆ PLATFORM_SUPPORTS_BINDLESS_RENDERING

#define PLATFORM_SUPPORTS_BINDLESS_RENDERING   1

◆ PLATFORM_SUPPORTS_BORDERLESS_WINDOW

#define PLATFORM_SUPPORTS_BORDERLESS_WINDOW   1

◆ PLATFORM_SUPPORTS_EARLY_MOVIE_PLAYBACK

#define PLATFORM_SUPPORTS_EARLY_MOVIE_PLAYBACK   (!WITH_EDITOR)

◆ PLATFORM_SUPPORTS_FLIP_TRACKING

#define PLATFORM_SUPPORTS_FLIP_TRACKING   1

◆ PLATFORM_SUPPORTS_MESH_SHADERS

#define PLATFORM_SUPPORTS_MESH_SHADERS   1

◆ PLATFORM_SUPPORTS_MIMALLOC

#define PLATFORM_SUPPORTS_MIMALLOC   PLATFORM_64BITS

◆ PLATFORM_SUPPORTS_NAMED_PIPES

#define PLATFORM_SUPPORTS_NAMED_PIPES   1

◆ PLATFORM_SUPPORTS_PRAGMA_PACK

#define PLATFORM_SUPPORTS_PRAGMA_PACK   1

◆ PLATFORM_SUPPORTS_STACK_SYMBOLS

#define PLATFORM_SUPPORTS_STACK_SYMBOLS   1

◆ PLATFORM_SUPPORTS_TBB

#define PLATFORM_SUPPORTS_TBB   1

◆ PLATFORM_SUPPORTS_UNALIGNED_LOADS

#define PLATFORM_SUPPORTS_UNALIGNED_LOADS   1

◆ PLATFORM_SUPPORTS_VARIABLE_RATE_SHADING

#define PLATFORM_SUPPORTS_VARIABLE_RATE_SHADING   1

◆ PLATFORM_SUPPORTS_WORKGRAPH_SHADERS

#define PLATFORM_SUPPORTS_WORKGRAPH_SHADERS   1

◆ PLATFORM_USE_CALLSTACK_ADDRESS_POINTER

#define PLATFORM_USE_CALLSTACK_ADDRESS_POINTER   1

◆ PLATFORM_USE_GENERIC_STRING_IMPLEMENTATION

#define PLATFORM_USE_GENERIC_STRING_IMPLEMENTATION   0

◆ PLATFORM_USE_LS_SPEC_FOR_WIDECHAR

#define PLATFORM_USE_LS_SPEC_FOR_WIDECHAR   0

◆ PLATFORM_USE_PTHREADS

#define PLATFORM_USE_PTHREADS   0

◆ PLATFORM_USES__ALIGNED_MALLOC

#define PLATFORM_USES__ALIGNED_MALLOC   1

◆ PLATFORM_USES_MICROSOFT_LIBC_FUNCTIONS

#define PLATFORM_USES_MICROSOFT_LIBC_FUNCTIONS   1

◆ PLATFORM_USES_UNFAIR_LOCKS

#define PLATFORM_USES_UNFAIR_LOCKS   1

◆ PRAGMA_DISABLE_OPTIMIZATION_ACTUAL

#define PRAGMA_DISABLE_OPTIMIZATION_ACTUAL   __pragma(optimize("",off))

◆ PRAGMA_ENABLE_OPTIMIZATION_ACTUAL

#define PRAGMA_ENABLE_OPTIMIZATION_ACTUAL   __pragma(optimize("",on))

◆ STDCALL

◆ TYPENAME_OUTSIDE_TEMPLATE

#define TYPENAME_OUTSIDE_TEMPLATE

◆ VARARGS

#define VARARGS   __cdecl /* Functions with variable arguments */

◆ WINDOWS_LOWINTEGRITYLEVEL_AUTOMIGRATE_USERDATA

#define WINDOWS_LOWINTEGRITYLEVEL_AUTOMIGRATE_USERDATA   0

◆ WINDOWS_LOWINTEGRITYLEVEL_EXPECT_DEFAULT

#define WINDOWS_LOWINTEGRITYLEVEL_EXPECT_DEFAULT   0

◆ WINDOWS_USE_FEATURE_APPLICATIONMISC_CLASS

#define WINDOWS_USE_FEATURE_APPLICATIONMISC_CLASS   1

◆ WINDOWS_USE_FEATURE_PLATFORMHTTP_CLASS

#define WINDOWS_USE_FEATURE_PLATFORMHTTP_CLASS   1

◆ WINDOWS_USE_FEATURE_PLATFORMMISC_CLASS

#define WINDOWS_USE_FEATURE_PLATFORMMISC_CLASS   1

Typedef Documentation

◆ FPlatformTypes