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

#include <RHIResources.h>

+ Inheritance diagram for FRHIViewDesc:

Classes

struct  FBuffer
 
struct  FBufferSRV
 
struct  FBufferUAV
 
struct  FCommon
 
struct  FTexture
 
struct  FTextureSRV
 
struct  FTextureUAV
 

Public Types

enum class  EViewType : uint8 { BufferSRV , BufferUAV , TextureSRV , TextureUAV }
 
enum class  EBufferType : uint8 {
  Unknown = 0 , Typed = 1 , Structured = 2 , AccelerationStructure = 3 ,
  Raw = 4
}
 
enum class  EDimension : uint8 {
  Unknown = 0 , Texture2D = 1 , Texture2DArray = 2 , TextureCube = 3 ,
  TextureCubeArray = 4 , Texture3D = 5 , NumBits = 3
}
 

Public Member Functions

bool IsSRV () const
 
bool IsUAV () const
 
bool IsBuffer () const
 
bool IsTexture () const
 
bool operator== (FRHIViewDesc const &RHS) const
 
bool operator!= (FRHIViewDesc const &RHS) const
 
 FRHIViewDesc ()
 

Static Public Member Functions

static FBufferSRV::FInitializer CreateBufferSRV ()
 
static FBufferUAV::FInitializer CreateBufferUAV ()
 
static FTextureSRV::FInitializer CreateTextureSRV ()
 
static FTextureUAV::FInitializer CreateTextureUAV ()
 
static const TCHARGetBufferTypeString (EBufferType BufferType)
 
static const TCHARGetTextureDimensionString (EDimension Dimension)
 

Public Attributes

union { 
 
   FCommon   Common 
 
   union { 
 
      FBufferSRV   SRV 
 
      FBufferUAV   UAV 
 
   }   Buffer 
 
   union { 
 
      FTextureSRV   SRV 
 
      FTextureUAV   UAV 
 
   }   Texture 
 
};  
 

Protected Member Functions

 FRHIViewDesc (EViewType ViewType)
 

Member Enumeration Documentation

◆ EBufferType

Enumerator
Unknown 
Typed 
Structured 
AccelerationStructure 
Raw 

◆ EDimension

Enumerator
Unknown 
Texture2D 
Texture2DArray 
TextureCube 
TextureCubeArray 
Texture3D 
NumBits 

◆ EViewType

Enumerator
BufferSRV 
BufferUAV 
TextureSRV 
TextureUAV 

Constructor & Destructor Documentation

◆ FRHIViewDesc() [1/2]

FRHIViewDesc::FRHIViewDesc ( )
inline

◆ FRHIViewDesc() [2/2]

FRHIViewDesc::FRHIViewDesc ( EViewType  ViewType)
inlineprotected

Member Function Documentation

◆ CreateBufferSRV()

FRHIViewDesc::FBufferSRV::FInitializer FRHIViewDesc::CreateBufferSRV ( )
inlinestatic

◆ CreateBufferUAV()

FRHIViewDesc::FBufferUAV::FInitializer FRHIViewDesc::CreateBufferUAV ( )
inlinestatic

◆ CreateTextureSRV()

FRHIViewDesc::FTextureSRV::FInitializer FRHIViewDesc::CreateTextureSRV ( )
inlinestatic

◆ CreateTextureUAV()

FRHIViewDesc::FTextureUAV::FInitializer FRHIViewDesc::CreateTextureUAV ( )
inlinestatic

◆ GetBufferTypeString()

const TCHAR * FRHIViewDesc::GetBufferTypeString ( FRHIViewDesc::EBufferType  BufferType)
static

◆ GetTextureDimensionString()

const TCHAR * FRHIViewDesc::GetTextureDimensionString ( FRHIViewDesc::EDimension  Dimension)
static

◆ IsBuffer()

bool FRHIViewDesc::IsBuffer ( ) const
inline

◆ IsSRV()

bool FRHIViewDesc::IsSRV ( ) const
inline

◆ IsTexture()

bool FRHIViewDesc::IsTexture ( ) const
inline

◆ IsUAV()

bool FRHIViewDesc::IsUAV ( ) const
inline

◆ operator!=()

bool FRHIViewDesc::operator!= ( FRHIViewDesc const &  RHS) const
inline

◆ operator==()

bool FRHIViewDesc::operator== ( FRHIViewDesc const &  RHS) const
inline

Member Data Documentation

◆ [union]

union { ... } FRHIViewDesc

◆ [union]

union { ... } FRHIViewDesc::Buffer

◆ Common

FCommon FRHIViewDesc::Common

◆ SRV [1/2]

FBufferSRV FRHIViewDesc::SRV

◆ SRV [2/2]

FTextureSRV FRHIViewDesc::SRV

◆ [union]

union { ... } FRHIViewDesc::Texture

◆ UAV [1/2]

FBufferUAV FRHIViewDesc::UAV

◆ UAV [2/2]

FTextureUAV FRHIViewDesc::UAV

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