UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FReadSurfaceDataFlags Class Reference

#include <RHITypes.h>

Public Member Functions

 FReadSurfaceDataFlags (ERangeCompressionMode InCompressionMode=RCM_UNorm, ECubeFace InCubeFace=CubeFace_MAX)
 
ECubeFace GetCubeFace () const
 
void SetCubeFace (ECubeFace InCubeFace)
 
ERangeCompressionMode GetCompressionMode () const
 
void SetLinearToGamma (bool Value)
 
bool GetLinearToGamma () const
 
void SetOutputStencil (bool Value)
 
bool GetOutputStencil () const
 
void SetMip (uint8 InMipLevel)
 
uint8 GetMip () const
 
void SetMaxDepthRange (float Value)
 
float ComputeNormalizedDepth (float DeviceZ) const
 
void SetGPUIndex (uint32 InGPUIndex)
 
uint32 GetGPUIndex () const
 
void SetArrayIndex (int32 InArrayIndex)
 
int32 GetArrayIndex () const
 

Detailed Description

to customize the RHIReadSurfaceData() output

Constructor & Destructor Documentation

◆ FReadSurfaceDataFlags()

FReadSurfaceDataFlags::FReadSurfaceDataFlags ( ERangeCompressionMode  InCompressionMode = RCM_UNorm,
ECubeFace  InCubeFace = CubeFace_MAX 
)
inline

Member Function Documentation

◆ ComputeNormalizedDepth()

float FReadSurfaceDataFlags::ComputeNormalizedDepth ( float  DeviceZ) const
inline

◆ GetArrayIndex()

int32 FReadSurfaceDataFlags::GetArrayIndex ( ) const
inline

◆ GetCompressionMode()

ERangeCompressionMode FReadSurfaceDataFlags::GetCompressionMode ( ) const
inline

◆ GetCubeFace()

ECubeFace FReadSurfaceDataFlags::GetCubeFace ( ) const
inline

◆ GetGPUIndex()

uint32 FReadSurfaceDataFlags::GetGPUIndex ( ) const
inline

◆ GetLinearToGamma()

bool FReadSurfaceDataFlags::GetLinearToGamma ( ) const
inline

◆ GetMip()

uint8 FReadSurfaceDataFlags::GetMip ( ) const
inline

◆ GetOutputStencil()

bool FReadSurfaceDataFlags::GetOutputStencil ( ) const
inline

◆ SetArrayIndex()

void FReadSurfaceDataFlags::SetArrayIndex ( int32  InArrayIndex)
inline

◆ SetCubeFace()

void FReadSurfaceDataFlags::SetCubeFace ( ECubeFace  InCubeFace)
inline

◆ SetGPUIndex()

void FReadSurfaceDataFlags::SetGPUIndex ( uint32  InGPUIndex)
inline

◆ SetLinearToGamma()

void FReadSurfaceDataFlags::SetLinearToGamma ( bool  Value)
inline

◆ SetMaxDepthRange()

void FReadSurfaceDataFlags::SetMaxDepthRange ( float  Value)
inline

◆ SetMip()

void FReadSurfaceDataFlags::SetMip ( uint8  InMipLevel)
inline

◆ SetOutputStencil()

void FReadSurfaceDataFlags::SetOutputStencil ( bool  Value)
inline

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