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

#include <MultiGPU.h>

Classes

struct  FIterator
 

Public Member Functions

GPUMASK_CONSTEXPR FRHIGPUMask ()
 
constexpr uint32 ToIndex () const
 
constexpr bool HasSingleIndex () const
 
constexpr uint32 GetNumActive () const
 
constexpr uint32 GetLastIndex () const
 
constexpr uint32 GetFirstIndex () const
 
SGPU_CONSTEXPR bool Contains (uint32 GPUIndex) const
 
SGPU_CONSTEXPR bool ContainsAll (FRHIGPUMask Rhs) const
 
SGPU_CONSTEXPR bool Intersects (FRHIGPUMask Rhs) const
 
SGPU_CONSTEXPR bool operator== (FRHIGPUMask Rhs) const
 
SGPU_CONSTEXPR bool operator!= (FRHIGPUMask Rhs) const
 
SGPU_CONSTEXPR void operator|= (FRHIGPUMask Rhs)
 
SGPU_CONSTEXPR void operator&= (FRHIGPUMask Rhs)
 
SGPU_CONSTEXPR uint32 GetNative () const
 
SGPU_CONSTEXPR uint32 GetForDisplay () const
 
SGPU_CONSTEXPR FRHIGPUMask operator& (FRHIGPUMask Rhs) const
 
SGPU_CONSTEXPR FRHIGPUMask operator| (FRHIGPUMask Rhs) const
 
bool Invert (FRHIGPUMask &OutInverse) const
 

Static Public Member Functions

static GPUMASK_CONSTEXPR FRHIGPUMask FromIndex (uint32 GPUIndex)
 
static GPUMASK_CONSTEXPR FRHIGPUMask GPU0 ()
 
static SGPU_CONSTEXPR FRHIGPUMask All ()
 
static SGPU_CONSTEXPR FRHIGPUMask FilterGPUsBefore (uint32 GPUIndex)
 

Friends

FRHIGPUMask::FIterator begin (FRHIGPUMask NodeMask)
 
FRHIGPUMask::FIterator end (FRHIGPUMask NodeMask)
 

Detailed Description

A mask where each bit is a GPU index. Can not be empty so that non SLI platforms can optimize it to be always 1.

Constructor & Destructor Documentation

◆ FRHIGPUMask()

GPUMASK_CONSTEXPR FRHIGPUMask::FRHIGPUMask ( )
inline

Member Function Documentation

◆ All()

static SGPU_CONSTEXPR FRHIGPUMask FRHIGPUMask::All ( )
inlinestatic

◆ Contains()

SGPU_CONSTEXPR bool FRHIGPUMask::Contains ( uint32  GPUIndex) const
inline

◆ ContainsAll()

SGPU_CONSTEXPR bool FRHIGPUMask::ContainsAll ( FRHIGPUMask  Rhs) const
inline

◆ FilterGPUsBefore()

static SGPU_CONSTEXPR FRHIGPUMask FRHIGPUMask::FilterGPUsBefore ( uint32  GPUIndex)
inlinestatic

◆ FromIndex()

static GPUMASK_CONSTEXPR FRHIGPUMask FRHIGPUMask::FromIndex ( uint32  GPUIndex)
inlinestatic

◆ GetFirstIndex()

constexpr uint32 FRHIGPUMask::GetFirstIndex ( ) const
inlineconstexpr

◆ GetForDisplay()

SGPU_CONSTEXPR uint32 FRHIGPUMask::GetForDisplay ( ) const
inline

◆ GetLastIndex()

constexpr uint32 FRHIGPUMask::GetLastIndex ( ) const
inlineconstexpr

◆ GetNative()

SGPU_CONSTEXPR uint32 FRHIGPUMask::GetNative ( ) const
inline

◆ GetNumActive()

constexpr uint32 FRHIGPUMask::GetNumActive ( ) const
inlineconstexpr

◆ GPU0()

static GPUMASK_CONSTEXPR FRHIGPUMask FRHIGPUMask::GPU0 ( )
inlinestatic

◆ HasSingleIndex()

constexpr bool FRHIGPUMask::HasSingleIndex ( ) const
inlineconstexpr

◆ Intersects()

SGPU_CONSTEXPR bool FRHIGPUMask::Intersects ( FRHIGPUMask  Rhs) const
inline

◆ Invert()

bool FRHIGPUMask::Invert ( FRHIGPUMask OutInverse) const
inline

◆ operator!=()

SGPU_CONSTEXPR bool FRHIGPUMask::operator!= ( FRHIGPUMask  Rhs) const
inline

◆ operator&()

SGPU_CONSTEXPR FRHIGPUMask FRHIGPUMask::operator& ( FRHIGPUMask  Rhs) const
inline

◆ operator&=()

SGPU_CONSTEXPR void FRHIGPUMask::operator&= ( FRHIGPUMask  Rhs)
inline

◆ operator==()

SGPU_CONSTEXPR bool FRHIGPUMask::operator== ( FRHIGPUMask  Rhs) const
inline

◆ operator|()

SGPU_CONSTEXPR FRHIGPUMask FRHIGPUMask::operator| ( FRHIGPUMask  Rhs) const
inline

◆ operator|=()

SGPU_CONSTEXPR void FRHIGPUMask::operator|= ( FRHIGPUMask  Rhs)
inline

◆ ToIndex()

constexpr uint32 FRHIGPUMask::ToIndex ( ) const
inlineconstexpr

Friends And Related Symbol Documentation

◆ begin

FRHIGPUMask::FIterator begin ( FRHIGPUMask  NodeMask)
friend

◆ end

FRHIGPUMask::FIterator end ( FRHIGPUMask  NodeMask)
friend

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