FRHITextureSRVCreateInfo Struct Reference

#include <RHIResources.h>

Inheritance diagram for FRHITextureSRVCreateInfo:

Public Member Functions
	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 bool	CheckValidity (const FRHITextureDesc &TextureDesc, const FRHITextureSRVCreateInfo &TextureSRVDesc, const TCHAR *TextureName)

Public Attributes
EPixelFormat	Format
uint8	MipLevel
uint8	NumMipLevels
ERHITextureSRVOverrideSRGBType	SRGBOverride
uint16	FirstArraySlice
uint16	NumArraySlices
ERHITextureMetaDataAccess	MetaData = ERHITextureMetaDataAccess::None
TOptional< ETextureDimension >	DimensionOverride

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

Friends
uint32	GetTypeHash (const FRHITextureSRVCreateInfo &Info)

Constructor & Destructor Documentation

FRHITextureSRVCreateInfo() [1/2]

FRHITextureSRVCreateInfo::FRHITextureSRVCreateInfo ( uint8  InMipLevel = 0u, uint8  InNumMipLevels = 1u, EPixelFormat  InFormat = PF_Unknown  )

inlineexplicit

FRHITextureSRVCreateInfo() [2/2]

FRHITextureSRVCreateInfo::FRHITextureSRVCreateInfo ( uint8  InMipLevel, uint8  InNumMipLevels, uint16  InFirstArraySlice, uint16  InNumArraySlices, EPixelFormat  InFormat = PF_Unknown  )

inlineexplicit

Member Function Documentation

CheckValidity()

static bool FRHITextureSRVCreateInfo::CheckValidity ( const FRHITextureDesc &  TextureDesc, const FRHITextureSRVCreateInfo &  TextureSRVDesc, const TCHAR *  TextureName  )

inlinestatic

Check the validity.

operator!=()

bool FRHITextureSRVCreateInfo::operator!= ( const FRHITextureSRVCreateInfo &  Other ) const

inline

operator==()

bool FRHITextureSRVCreateInfo::operator== ( const FRHITextureSRVCreateInfo &  Other ) const

inline

Validate()

bool FRHITextureSRVCreateInfo::Validate ( const FRHITextureDesc &  TextureDesc, const FRHITextureSRVCreateInfo &  TextureSRVDesc, const TCHAR *  TextureName, bool  bFatal  )

staticprotected

Friends And Related Symbol Documentation

GetTypeHash

uint32 GetTypeHash ( const FRHITextureSRVCreateInfo &  Info )

friend

Member Data Documentation

DimensionOverride

TOptional<ETextureDimension> FRHITextureSRVCreateInfo::DimensionOverride

Specify a dimension to use which overrides the default

FirstArraySlice

uint16 FRHITextureSRVCreateInfo::FirstArraySlice

Specify first array slice index. By default 0.

Format

EPixelFormat FRHITextureSRVCreateInfo::Format

View the texture with a different format. Leave as PF_Unknown to use original format. Useful when sampling stencil

MetaData

ERHITextureMetaDataAccess FRHITextureSRVCreateInfo::MetaData = ERHITextureMetaDataAccess::None

Specify the metadata plane to use when creating a view.

MipLevel

uint8 FRHITextureSRVCreateInfo::MipLevel

Specify the mip level to use. Useful when rendering to one mip while sampling from another

NumArraySlices

uint16 FRHITextureSRVCreateInfo::NumArraySlices

Specify number of array slices. If FirstArraySlice and NumArraySlices are both zero, the SRV is created for all array slices. By default 0.

NumMipLevels

uint8 FRHITextureSRVCreateInfo::NumMipLevels

Create a view to a single, or multiple mip levels

SRGBOverride

ERHITextureSRVOverrideSRGBType FRHITextureSRVCreateInfo::SRGBOverride

Potentially override the texture's sRGB flag

---

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

• Engine/Source/Runtime/RHI/Public/RHIResources.h
• Engine/Source/Runtime/RHI/Private/RHI.cpp