UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
RHIAccess.h File Reference
#include "CoreTypes.h"
#include "Misc/EnumClassFlags.h"

Go to the source code of this file.

Enumerations

enum class  ERHIAccess : uint32 {
  Unknown = 0 , CPURead = 1 << 0 , Present = 1 << 1 , IndirectArgs = 1 << 2 ,
  VertexOrIndexBuffer = 1 << 3 , SRVCompute = 1 << 4 , SRVGraphicsPixel = 1 << 5 , SRVGraphicsNonPixel = 1 << 6 ,
  CopySrc = 1 << 7 , ResolveSrc = 1 << 8 , DSVRead = 1 << 9 , UAVCompute = 1 << 10 ,
  UAVGraphics = 1 << 11 , RTV = 1 << 12 , CopyDest = 1 << 13 , ResolveDst = 1 << 14 ,
  DSVWrite = 1 << 15 , BVHRead = 1 << 16 , BVHWrite = 1 << 17 , Discard = 1 << 18 ,
  ShadingRateSource = 1 << 19 , Last = ShadingRateSource , None = Unknown , Mask = (Last << 1) - 1 ,
  SRVGraphics = SRVGraphicsPixel | SRVGraphicsNonPixel , SRVMask = SRVCompute | SRVGraphics , UAVMask = UAVCompute | UAVGraphics , ReadOnlyExclusiveMask = CPURead | Present | IndirectArgs | VertexOrIndexBuffer | SRVGraphics | SRVCompute | CopySrc | ResolveSrc | BVHRead | ShadingRateSource ,
  ReadOnlyExclusiveComputeMask = CPURead | IndirectArgs | SRVCompute | CopySrc | BVHRead , ReadOnlyMask = ReadOnlyExclusiveMask | DSVRead | ShadingRateSource , ReadableMask = ReadOnlyMask | UAVMask , WriteOnlyExclusiveMask = RTV | CopyDest | ResolveDst ,
  WriteOnlyMask = WriteOnlyExclusiveMask | DSVWrite , WritableMask = WriteOnlyMask | UAVMask | BVHWrite
}
 

Functions

constexpr bool IsReadOnlyExclusiveAccess (ERHIAccess Access)
 
constexpr bool IsReadOnlyAccess (ERHIAccess Access)
 
constexpr bool IsWriteOnlyAccess (ERHIAccess Access)
 
constexpr bool IsWritableAccess (ERHIAccess Access)
 
constexpr bool IsReadableAccess (ERHIAccess Access)
 
constexpr bool IsInvalidAccess (ERHIAccess Access)
 
constexpr bool IsValidAccess (ERHIAccess Access)
 

Variables

RHI_API ERHIAccess GRHIMergeableAccessMask
 
RHI_API ERHIAccess GRHIMultiPipelineMergeableAccessMask
 
RHI_API ERHIAccess GRHIMultiSubresourceDiscardIntermediateAccess
 

Enumeration Type Documentation

◆ ERHIAccess

enum class ERHIAccess : uint32
strong
Enumerator
Unknown 
CPURead 
Present 
IndirectArgs 
VertexOrIndexBuffer 
SRVCompute 
SRVGraphicsPixel 
SRVGraphicsNonPixel 
CopySrc 
ResolveSrc 
DSVRead 
UAVCompute 
UAVGraphics 
RTV 
CopyDest 
ResolveDst 
DSVWrite 
BVHRead 
BVHWrite 
Discard 
ShadingRateSource 
Last 
None 
Mask 
SRVGraphics 
SRVMask 
UAVMask 
ReadOnlyExclusiveMask 
ReadOnlyExclusiveComputeMask 
ReadOnlyMask 
ReadableMask 
WriteOnlyExclusiveMask 
WriteOnlyMask 
WritableMask 

Function Documentation

◆ IsInvalidAccess()

constexpr bool IsInvalidAccess ( ERHIAccess  Access)
inlineconstexpr

◆ IsReadableAccess()

constexpr bool IsReadableAccess ( ERHIAccess  Access)
inlineconstexpr

◆ IsReadOnlyAccess()

constexpr bool IsReadOnlyAccess ( ERHIAccess  Access)
inlineconstexpr

◆ IsReadOnlyExclusiveAccess()

constexpr bool IsReadOnlyExclusiveAccess ( ERHIAccess  Access)
inlineconstexpr

◆ IsValidAccess()

constexpr bool IsValidAccess ( ERHIAccess  Access)
inlineconstexpr

◆ IsWritableAccess()

constexpr bool IsWritableAccess ( ERHIAccess  Access)
inlineconstexpr

◆ IsWriteOnlyAccess()

constexpr bool IsWriteOnlyAccess ( ERHIAccess  Access)
inlineconstexpr

Variable Documentation

◆ GRHIMergeableAccessMask

RHI_API ERHIAccess GRHIMergeableAccessMask
extern

Mask of states which are allowed to be considered for state merging.

◆ GRHIMultiPipelineMergeableAccessMask

RHI_API ERHIAccess GRHIMultiPipelineMergeableAccessMask
extern

Mask of states which are allowed to be considered for multi-pipeline state merging. This should be a subset of GRHIMergeableAccessMask.

◆ GRHIMultiSubresourceDiscardIntermediateAccess

RHI_API ERHIAccess GRHIMultiSubresourceDiscardIntermediateAccess
extern

[NeedsTransientDiscardStateTracking] State to use as an intermediate state when transitioning to discard and the resource has differing prior states per subresource.