UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Static Public Member Functions | List of all members
FWindowsPlatformTLS Struct Reference

#include <WindowsPlatformTLS.h>

+ Inheritance diagram for FWindowsPlatformTLS:

Static Public Member Functions

static UE_FORCEINLINE_HINT uint32 GetCurrentThreadId (void)
 
static UE_FORCEINLINE_HINT uint32 AllocTlsSlot ()
 
static UE_FORCEINLINE_HINT void FreeTlsSlot (uint32 SlotIndex)
 
static void SetTlsValue (uint32 SlotIndex, void *Value)
 
static void * GetTlsValue (uint32 SlotIndex)
 
- Static Public Member Functions inherited from FGenericPlatformTLS
static UE_FORCEINLINE_HINT bool IsValidTlsSlot (uint32 SlotIndex)
 

Additional Inherited Members

- Static Public Attributes inherited from FGenericPlatformTLS
static const uint32 InvalidTlsSlot = 0xFFFFFFFF
 

Detailed Description

Windows implementation of the TLS OS functions.

Member Function Documentation

◆ AllocTlsSlot()

static UE_FORCEINLINE_HINT uint32 FWindowsPlatformTLS::AllocTlsSlot ( )
inlinestatic

Allocates a thread local store slot.

Returns
The index of the allocated slot.

◆ FreeTlsSlot()

static UE_FORCEINLINE_HINT void FWindowsPlatformTLS::FreeTlsSlot ( uint32  SlotIndex)
inlinestatic

Frees a previously allocated TLS slot

Parameters
SlotIndexthe TLS index to store it in

◆ GetCurrentThreadId()

static UE_FORCEINLINE_HINT uint32 FWindowsPlatformTLS::GetCurrentThreadId ( void  )
inlinestatic

Returns the currently executing thread's identifier.

Returns
The thread identifier.

◆ GetTlsValue()

static void * FWindowsPlatformTLS::GetTlsValue ( uint32  SlotIndex)
inlinestatic

Reads the value stored at the specified TLS slot.

Parameters
SlotIndexThe index of the slot to read.
Returns
The value stored in the slot.

◆ SetTlsValue()

static void FWindowsPlatformTLS::SetTlsValue ( uint32  SlotIndex,
void *  Value 
)
inlinestatic

Sets a value in the specified TLS slot.

Parameters
SlotIndexthe TLS index to store it in.
Valuethe value to store in the slot.
The documentation for this struct was generated from the following file: