AFRUtils

GPU mask utilities to get information about AFR groups and siblings.

Windows
MacOS
Linux

References

Module

RHI

Header

/Engine/Source/Runtime/RHI/Public/MultiGPU.h

Include

#include "MultiGPU.h"

Syntax

struct AFRUtils

Remarks

GPU mask utilities to get information about AFR groups and siblings.

  • An AFR group is the set of GPUs that are working on the same frame together.

  • AFR siblings are the GPUs in other groups do the same kind of work on subsequent frames. For example, two GPUs that render the same view on different frames are AFR siblings.

For an 4 GPU setup with 2 AFR groups:

  • There are 2 GPUs per AFR group. 0b1010 and 0b0101 are the two groups.

  • Each GPU has 1 sibling. 0b1100 and 0b0011 are siblings.

Functions

Name Description

Public function Static

FRHIGPUMask

 

GetGPUMaskForGroup

(
    uint32 GPUIndex
)

Gets the GPU mask including all GPUs within the same AFR group.

Public function Static

FRHIGPUMask

 

GetGPUMaskForGroup

(
    FRHIGPUMask InGPUMask
)

Gets the GPU mask including all GPUs within the same AFR group(s).

Public function Static

FRHIGPUMask

 

GetGPUMaskWithSiblings

(
    uint32 GPUIndex
)

Gets the GPU mask including all siblings across all AFR groups.

Public function Static

FRHIGPUMask

 

GetGPUMaskWithSiblings

(
    FRHIGPUMask InGPUMask
)

Gets the GPU mask including all siblings across all AFR groups.

Public function Static

uint32

 

GetGroupIndex

(
    uint32 GPUIndex
)

Gets the AFR group index for a GPU index.

Public function Static

uint32

 

GetIndexWithinGroup

(
    uint32 GPUIndex
)

Gets the index of a GPU relative its AFR group.

Public function Static

uint32

 

GetNextSiblingGPUIndex

(
    uint32 GPUIndex
)

Gets the next AFR sibling for a GPU.

Public function Static

FRHIGPUMask

 

GetNextSiblingGPUMask

(
    FRHIGPUMask InGPUMask
)

Gets a mask containing the next AFR siblings for a GPU mask.

Public function Static

uint32

 

GetNumGPUsPerGroup()

Gets the number of GPUs per AFR group.

Public function Static

uint32

 

GetPrevSiblingGPUIndex

(
    uint32 GPUIndex
)

Gets the previous AFR sibling for a GPU.

Public function Static

FRHIGPUMask

 

GetPrevSiblingGPUMask

(
    FRHIGPUMask InGPUMask
)

Gets a mask containing the previous AFR siblings for a GPU mask.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss