UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
TAtomicBase_Integral< T > Struct Template Reference

#include <Atomic.h>

+ Inheritance diagram for TAtomicBase_Integral< T >:

Public Member Functions

FORCEINLINEoperator&= (const T Value)
 
FORCEINLINEoperator|= (const T Value)
 
FORCEINLINEoperator^= (const T Value)
 
FORCEINLINEAndExchange (const T Value)
 
FORCEINLINEOrExchange (const T Value)
 
FORCEINLINEXorExchange (const T Value)
 
- Public Member Functions inherited from TAtomicBase_Arithmetic< T, T >
FORCEINLINEoperator++ ()
 
FORCEINLINEoperator++ (int)
 
FORCEINLINEoperator+= (T Value)
 
FORCEINLINEoperator-- ()
 
FORCEINLINEoperator-- (int)
 
FORCEINLINEoperator-= (T Value)
 
FORCEINLINEIncrementExchange ()
 
FORCEINLINEDecrementExchange ()
 
FORCEINLINEAddExchange (T Value)
 
FORCEINLINESubExchange (T Value)
 
- Public Member Functions inherited from TAtomicBase_Basic< T >
FORCEINLINELoad (EMemoryOrder Order=EMemoryOrder::SequentiallyConsistent) const
 
FORCEINLINE void Store (T Value, EMemoryOrder Order=EMemoryOrder::SequentiallyConsistent)
 
FORCEINLINEExchange (T Value)
 
FORCEINLINE bool CompareExchange (T &Expected, T Value)
 

Protected Member Functions

 TAtomicBase_Integral ()=default
 
constexpr TAtomicBase_Integral (T Value)
 
- Protected Member Functions inherited from TAtomicBase_Arithmetic< T, T >
 TAtomicBase_Arithmetic ()=default
 
constexpr TAtomicBase_Arithmetic (T Value)
 
- Protected Member Functions inherited from TAtomicBase_Basic< T >
 TAtomicBase_Basic ()=default
 
constexpr TAtomicBase_Basic (T Value)
 

Additional Inherited Members

- Protected Attributes inherited from TAtomicBase_Basic< T >
std::atomic< T > Element
 

Constructor & Destructor Documentation

◆ TAtomicBase_Integral() [1/2]

template<typename T >
TAtomicBase_Integral< T >::TAtomicBase_Integral ( )
protecteddefault

◆ TAtomicBase_Integral() [2/2]

template<typename T >
constexpr TAtomicBase_Integral< T >::TAtomicBase_Integral ( Value)
inlineconstexprprotected

Member Function Documentation

◆ AndExchange()

template<typename T >
FORCEINLINE T TAtomicBase_Integral< T >::AndExchange ( const T  Value)
inline

Performs Element &= Value, returning a copy of the previous value of the element.

Parameters
ValueThe value to and the element with.
Returns
A copy of the previous value.

◆ operator&=()

template<typename T >
FORCEINLINE T TAtomicBase_Integral< T >::operator&= ( const T  Value)
inline

Performs Element &= Value, returning a copy of the new value of the element.

Parameters
ValueThe value to and the element with.
Returns
A copy of the new value.

◆ operator^=()

template<typename T >
FORCEINLINE T TAtomicBase_Integral< T >::operator^= ( const T  Value)
inline

Performs Element ^= Value, returning a copy of the new value of the element.

Parameters
ValueThe value to xor the element with.
Returns
A copy of the new value.

◆ operator|=()

template<typename T >
FORCEINLINE T TAtomicBase_Integral< T >::operator|= ( const T  Value)
inline

Performs Element |= Value, returning a copy of the new value of the element.

Parameters
ValueThe value to or the element with.
Returns
A copy of the new value.

◆ OrExchange()

template<typename T >
FORCEINLINE T TAtomicBase_Integral< T >::OrExchange ( const T  Value)
inline

Performs Element |= Value, returning a copy of the previous value of the element.

Parameters
ValueThe value to or the element with.
Returns
A copy of the previous value.

◆ XorExchange()

template<typename T >
FORCEINLINE T TAtomicBase_Integral< T >::XorExchange ( const T  Value)
inline

Performs Element ^= Value, returning a copy of the previous value of the element.

Parameters
ValueThe value to xor the element with.
Returns
A copy of the previous value.

The documentation for this struct was generated from the following file: