UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FUnixTLS Struct Reference

#include <UnixPlatformTLS.h>

+ Inheritance diagram for FUnixTLS:

Static Public Member Functions

static uint32 GetCurrentThreadId (void)
 
static void ClearThreadIdTLS (void)
 
static uint32 AllocTlsSlot (void)
 
static UE_FORCEINLINE_HINT void SetTlsValue (uint32 SlotIndex, void *Value)
 
static UE_FORCEINLINE_HINT voidGetTlsValue (uint32 SlotIndex)
 
static UE_FORCEINLINE_HINT void FreeTlsSlot (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

Unix implementation of the TLS OS functions

Member Function Documentation

◆ AllocTlsSlot()

static uint32 FUnixTLS::AllocTlsSlot ( void  )
inlinestatic

Allocates a thread local store slot

◆ ClearThreadIdTLS()

static void FUnixTLS::ClearThreadIdTLS ( void  )
inlinestatic

◆ FreeTlsSlot()

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

Frees a previously allocated TLS slot

Parameters
SlotIndexthe TLS index to store it in

◆ GetCurrentThreadId()

static uint32 FUnixTLS::GetCurrentThreadId ( void  )
inlinestatic

Returns the currently executing thread's id

◆ GetTlsValue()

static UE_FORCEINLINE_HINT void * FUnixTLS::GetTlsValue ( uint32  SlotIndex)
inlinestatic

Reads the value stored at the specified TLS slot

Returns
the value stored in the slot

◆ SetTlsValue()

static UE_FORCEINLINE_HINT void FUnixTLS::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 files: