UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FRDGTextureSRVDesc Class Referencefinal

#include <RenderGraphResources.h>

+ Inheritance diagram for FRDGTextureSRVDesc:

Public Member Functions

 FRDGTextureSRVDesc ()=default
 
 FRDGTextureSRVDesc (FRDGTexture *InTexture)
 
bool operator== (const FRDGTextureSRVDesc &Other) const
 
bool operator!= (const FRDGTextureSRVDesc &Other) const
 
bool IsValid () const
 
- Public Member Functions inherited from FRHITextureSRVCreateInfo
 FRHITextureSRVCreateInfo (uint8 InMipLevel=0u, uint8 InNumMipLevels=1u, EPixelFormat InFormat=PF_Unknown)
 
 FRHITextureSRVCreateInfo (uint8 InMipLevel, uint8 InNumMipLevels, uint16 InFirstArraySlice, uint16 InNumArraySlices, EPixelFormat InFormat=PF_Unknown)
 
bool operator== (const FRHITextureSRVCreateInfo &Other) const
 
bool operator!= (const FRHITextureSRVCreateInfo &Other) const
 

Static Public Member Functions

static FRDGTextureSRVDesc Create (FRDGTextureRef Texture)
 
static FRDGTextureSRVDesc CreateForMipLevel (FRDGTextureRef Texture, int32 MipLevel)
 
static FRDGTextureSRVDesc CreateForSlice (FRDGTextureRef Texture, int32 SliceIndex)
 
static FRDGTextureSRVDesc CreateWithPixelFormat (FRDGTextureRef Texture, EPixelFormat PixelFormat)
 
static FRDGTextureSRVDesc CreateForMetaData (FRDGTextureRef Texture, ERDGTextureMetaDataAccess MetaData)
 
- Static Public Member Functions inherited from FRHITextureSRVCreateInfo
static bool CheckValidity (const FRHITextureDesc &TextureDesc, const FRHITextureSRVCreateInfo &TextureSRVDesc, const TCHAR *TextureName)
 

Public Attributes

FRDGTextureRef Texture = nullptr
 
- Public Attributes inherited from FRHITextureSRVCreateInfo
EPixelFormat Format
 
uint8 MipLevel
 
uint8 NumMipLevels
 
ERHITextureSRVOverrideSRGBType SRGBOverride
 
uint16 FirstArraySlice
 
uint16 NumArraySlices
 
ERHITextureMetaDataAccess MetaData = ERHITextureMetaDataAccess::None
 
TOptional< ETextureDimensionDimensionOverride
 

Friends

uint32 GetTypeHash (const FRDGTextureSRVDesc &Desc)
 

Additional Inherited Members

- Static Protected Member Functions inherited from FRHITextureSRVCreateInfo
static RHI_API bool Validate (const FRHITextureDesc &TextureDesc, const FRHITextureSRVCreateInfo &TextureSRVDesc, const TCHAR *TextureName, bool bFatal)
 

Detailed Description

Descriptor for render graph tracked SRV.

Constructor & Destructor Documentation

◆ FRDGTextureSRVDesc() [1/2]

FRDGTextureSRVDesc::FRDGTextureSRVDesc ( )
default

◆ FRDGTextureSRVDesc() [2/2]

FRDGTextureSRVDesc::FRDGTextureSRVDesc ( FRDGTexture InTexture)
inline

Member Function Documentation

◆ Create()

static FRDGTextureSRVDesc FRDGTextureSRVDesc::Create ( FRDGTextureRef  Texture)
inlinestatic

Create SRV that access all sub resources of texture.

◆ CreateForMetaData()

static FRDGTextureSRVDesc FRDGTextureSRVDesc::CreateForMetaData ( FRDGTextureRef  Texture,
ERDGTextureMetaDataAccess  MetaData 
)
inlinestatic

Create SRV with access to a specific meta data plane

◆ CreateForMipLevel()

static FRDGTextureSRVDesc FRDGTextureSRVDesc::CreateForMipLevel ( FRDGTextureRef  Texture,
int32  MipLevel 
)
inlinestatic

Create SRV that access one specific mip level.

◆ CreateForSlice()

static FRDGTextureSRVDesc FRDGTextureSRVDesc::CreateForSlice ( FRDGTextureRef  Texture,
int32  SliceIndex 
)
inlinestatic

Create SRV that access one specific slice.

◆ CreateWithPixelFormat()

static FRDGTextureSRVDesc FRDGTextureSRVDesc::CreateWithPixelFormat ( FRDGTextureRef  Texture,
EPixelFormat  PixelFormat 
)
inlinestatic

Create SRV that access all sub resources of texture with a specific pixel format.

◆ IsValid()

bool FRDGTextureSRVDesc::IsValid ( ) const
inline

Returns whether this descriptor conforms to requirements.

◆ operator!=()

bool FRDGTextureSRVDesc::operator!= ( const FRDGTextureSRVDesc Other) const
inline

◆ operator==()

bool FRDGTextureSRVDesc::operator== ( const FRDGTextureSRVDesc Other) const
inline

Friends And Related Symbol Documentation

◆ GetTypeHash

uint32 GetTypeHash ( const FRDGTextureSRVDesc Desc)
friend

Member Data Documentation

◆ Texture

FRDGTextureRef FRDGTextureSRVDesc::Texture = nullptr

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