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

#include <Atomic.h>

+ Inheritance diagram for TAtomicBase_Arithmetic< T, DiffType >:

Public Member Functions

FORCEINLINEoperator++ ()
 
FORCEINLINEoperator++ (int)
 
FORCEINLINEoperator+= (DiffType Value)
 
FORCEINLINEoperator-- ()
 
FORCEINLINEoperator-- (int)
 
FORCEINLINEoperator-= (DiffType Value)
 
FORCEINLINEIncrementExchange ()
 
FORCEINLINEDecrementExchange ()
 
FORCEINLINEAddExchange (DiffType Value)
 
FORCEINLINESubExchange (DiffType 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_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_Arithmetic() [1/2]

◆ TAtomicBase_Arithmetic() [2/2]

template<typename T , typename DiffType >
constexpr TAtomicBase_Arithmetic< T, DiffType >::TAtomicBase_Arithmetic ( Value)
inlineconstexprprotected

Member Function Documentation

◆ AddExchange()

template<typename T , typename DiffType >
FORCEINLINE T TAtomicBase_Arithmetic< T, DiffType >::AddExchange ( DiffType  Value)
inline

Adds Value to Element and returns a copy of the previous value of the element.

Parameters
ValueThe value to add to the element.
Returns
A copy of the previous, unincremented value.

◆ DecrementExchange()

template<typename T , typename DiffType >
FORCEINLINE T TAtomicBase_Arithmetic< T, DiffType >::DecrementExchange ( )
inline

Decrements Element and returns a copy of the previous value of the element.

Returns
A copy of the previous, undecremented value.

◆ IncrementExchange()

template<typename T , typename DiffType >
FORCEINLINE T TAtomicBase_Arithmetic< T, DiffType >::IncrementExchange ( )
inline

Increments Element and returns a copy of the previous value of the element.

Returns
A copy of the previous, unincremented value.

◆ operator++() [1/2]

template<typename T , typename DiffType >
FORCEINLINE T TAtomicBase_Arithmetic< T, DiffType >::operator++ ( )
inline

Performs ++Element, returning a copy of the new value of the element.

Returns
A copy of the new, incremented value.

◆ operator++() [2/2]

template<typename T , typename DiffType >
FORCEINLINE T TAtomicBase_Arithmetic< T, DiffType >::operator++ ( int  )
inline

Performs Element++, returning a copy of the previous value of the element.

Returns
A copy of the previous, unincremented value.

◆ operator+=()

template<typename T , typename DiffType >
FORCEINLINE T TAtomicBase_Arithmetic< T, DiffType >::operator+= ( DiffType  Value)
inline

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

Parameters
ValueThe value to add to the element.
Returns
A copy of the new, incremented value.

◆ operator--() [1/2]

template<typename T , typename DiffType >
FORCEINLINE T TAtomicBase_Arithmetic< T, DiffType >::operator-- ( )
inline

Performs –Element, returning a copy of the new value of the element.

Returns
A copy of the new, decremented value.

◆ operator--() [2/2]

template<typename T , typename DiffType >
FORCEINLINE T TAtomicBase_Arithmetic< T, DiffType >::operator-- ( int  )
inline

Performs Element–, returning a copy of the previous value of the element.

Returns
A copy of the previous, undecremented value.

◆ operator-=()

template<typename T , typename DiffType >
FORCEINLINE T TAtomicBase_Arithmetic< T, DiffType >::operator-= ( DiffType  Value)
inline

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

Parameters
ValueThe value to subtract from the element.
Returns
A copy of the new, decremented value.

◆ SubExchange()

template<typename T , typename DiffType >
FORCEINLINE T TAtomicBase_Arithmetic< T, DiffType >::SubExchange ( DiffType  Value)
inline

Subtracts Value from Element and returns a copy of the previous value of the element.

Parameters
ValueThe value to subtract from the element.
Returns
A copy of the previous, undecremented value.

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