UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Classes | Enumerations | Functions
GBufferInfo.h File Reference
#include "Containers/UnrealString.h"
#include "CoreMinimal.h"
#include "HAL/Platform.h"
#include "PixelFormat.h"
#include "RHIDefinitions.h"
#include "RHIShaderPlatform.h"

Go to the source code of this file.

Classes

struct  FGBufferCompressionInfo
 
struct  FGBufferPacking
 
struct  FGBufferItem
 
struct  FGBufferTarget
 
struct  FGBufferBinding
 
struct  FGBufferBindings
 
struct  FGBufferInfo
 
struct  FGBufferParams
 

Enumerations

enum  EGBufferSlot {
  GBS_Invalid , GBS_SceneColor , GBS_WorldNormal , GBS_PerObjectGBufferData ,
  GBS_Metallic , GBS_Specular , GBS_Roughness , GBS_ShadingModelId ,
  GBS_SelectiveOutputMask , GBS_BaseColor , GBS_GenericAO , GBS_IndirectIrradiance ,
  GBS_AO , GBS_Velocity , GBS_PrecomputedShadowFactor , GBS_WorldTangent ,
  GBS_Anisotropy , GBS_CustomData , GBS_SubsurfaceColor , GBS_Opacity ,
  GBS_SubsurfaceProfile , GBS_ClearCoat , GBS_ClearCoatRoughness , GBS_HairSecondaryWorldNormal ,
  GBS_HairBacklit , GBS_Cloth , GBS_SubsurfaceProfileX , GBS_IrisNormal ,
  GBS_SeparatedMainDirLight , GBS_Num
}
 
enum  EGBufferCompression {
  GBC_Invalid , GBC_Raw_Float_16_16_16_16 , GBC_Raw_Float_16_16_16 , GBC_Raw_Float_11_11_10 ,
  GBC_Raw_Float_10_10_10 , GBC_Raw_Unorm_8_8_8_8 , GBC_Raw_Unorm_8_8_8 , GBC_Raw_Unorm_8_8 ,
  GBC_Raw_Unorm_8 , GBC_Raw_Unorm_2 , GBC_Raw_Float_16_16 , GBC_Raw_Float_16 ,
  GBC_Bits_4 , GBC_Bits_2 , GBC_Packed_Normal_Octahedral_8_8 , GBC_EncodeNormal_Normal_16_16_16 ,
  GBC_EncodeNormal_Normal_10_10_10 , GBC_EncodeNormal_Normal_8_8_8 , GBC_Packed_Color_5_6_5 , GBC_Packed_Color_5_6_5_Sqrt ,
  GBC_Packed_Color_4_4_4 , GBC_Packed_Color_4_4_4_Sqrt , GBC_Packed_Color_3_3_2 , GBC_Packed_Color_3_3_2_Sqrt ,
  GBC_Packed_Quantized_6 , GBC_Packed_Quantized_4 , GBC_Packed_Quantized_2 , GBC_Num
}
 
enum  EGBufferType {
  GBT_Invalid , GBT_Unorm_16_16 , GBT_Unorm_8_8_8_8 , GBT_Unorm_11_11_10 ,
  GBT_Unorm_10_10_10_2 , GBT_Unorm_16_16_16_16 , GBT_Float_16_16 , GBT_Float_16_16_16_16 ,
  GBT_Float_32 , GBT_Num
}
 
enum  EGBufferChecker {
  GBCH_Invalid , GBCH_Even , GBCH_Odd , GBCH_Both ,
  GBCH_Num
}
 
enum  EGBufferLayout { GBL_Default , GBL_ForceVelocity , GBL_Num }
 

Functions

int32 RENDERCORE_API FindGBufferTargetByName (const FGBufferInfo &GBufferInfo, const FString &Name)
 
FGBufferBinding RENDERCORE_API FindGBufferBindingByName (const FGBufferInfo &GBufferInfo, const FString &Name, EShaderPlatform ShaderPlatform)
 
FGBufferBinding FindGBufferBindingByName (const FGBufferInfo &GBufferInfo, const FString &Name)
 
FGBufferInfo RENDERCORE_API FetchFullGBufferInfo (const FGBufferParams &Params)
 
bool RENDERCORE_API IsGBufferInfoEqual (const FGBufferInfo &Lhs, const FGBufferInfo &Rhs)
 

Enumeration Type Documentation

◆ EGBufferChecker

enum EGBufferChecker
Enumerator
GBCH_Invalid 
GBCH_Even 
GBCH_Odd 
GBCH_Both 
GBCH_Num 

◆ EGBufferCompression

enum EGBufferCompression
Enumerator
GBC_Invalid 
GBC_Raw_Float_16_16_16_16 
GBC_Raw_Float_16_16_16 
GBC_Raw_Float_11_11_10 
GBC_Raw_Float_10_10_10 
GBC_Raw_Unorm_8_8_8_8 
GBC_Raw_Unorm_8_8_8 
GBC_Raw_Unorm_8_8 
GBC_Raw_Unorm_8 
GBC_Raw_Unorm_2 
GBC_Raw_Float_16_16 
GBC_Raw_Float_16 
GBC_Bits_4 
GBC_Bits_2 
GBC_Packed_Normal_Octahedral_8_8 
GBC_EncodeNormal_Normal_16_16_16 
GBC_EncodeNormal_Normal_10_10_10 
GBC_EncodeNormal_Normal_8_8_8 
GBC_Packed_Color_5_6_5 
GBC_Packed_Color_5_6_5_Sqrt 
GBC_Packed_Color_4_4_4 
GBC_Packed_Color_4_4_4_Sqrt 
GBC_Packed_Color_3_3_2 
GBC_Packed_Color_3_3_2_Sqrt 
GBC_Packed_Quantized_6 
GBC_Packed_Quantized_4 
GBC_Packed_Quantized_2 
GBC_Num 

◆ EGBufferLayout

enum EGBufferLayout
Enumerator
GBL_Default 
GBL_ForceVelocity 
GBL_Num 

◆ EGBufferSlot

enum EGBufferSlot
Enumerator
GBS_Invalid 
GBS_SceneColor 
GBS_WorldNormal 
GBS_PerObjectGBufferData 
GBS_Metallic 
GBS_Specular 
GBS_Roughness 
GBS_ShadingModelId 
GBS_SelectiveOutputMask 
GBS_BaseColor 
GBS_GenericAO 
GBS_IndirectIrradiance 
GBS_AO 
GBS_Velocity 
GBS_PrecomputedShadowFactor 
GBS_WorldTangent 
GBS_Anisotropy 
GBS_CustomData 
GBS_SubsurfaceColor 
GBS_Opacity 
GBS_SubsurfaceProfile 
GBS_ClearCoat 
GBS_ClearCoatRoughness 
GBS_HairSecondaryWorldNormal 
GBS_HairBacklit 
GBS_Cloth 
GBS_SubsurfaceProfileX 
GBS_IrisNormal 
GBS_SeparatedMainDirLight 
GBS_Num 

◆ EGBufferType

enum EGBufferType
Enumerator
GBT_Invalid 
GBT_Unorm_16_16 
GBT_Unorm_8_8_8_8 
GBT_Unorm_11_11_10 
GBT_Unorm_10_10_10_2 
GBT_Unorm_16_16_16_16 
GBT_Float_16_16 
GBT_Float_16_16_16_16 
GBT_Float_32 
GBT_Num 

Function Documentation

◆ FetchFullGBufferInfo()

FGBufferInfo RENDERCORE_API FetchFullGBufferInfo ( const FGBufferParams &  Params)

◆ FindGBufferBindingByName() [1/2]

FGBufferBinding FindGBufferBindingByName ( const FGBufferInfo &  GBufferInfo,
const FString &  Name 
)
inline

◆ FindGBufferBindingByName() [2/2]

FGBufferBinding RENDERCORE_API FindGBufferBindingByName ( const FGBufferInfo &  GBufferInfo,
const FString &  Name,
EShaderPlatform  ShaderPlatform 
)

◆ FindGBufferTargetByName()

int32 RENDERCORE_API FindGBufferTargetByName ( const FGBufferInfo &  GBufferInfo,
const FString &  Name 
)

◆ IsGBufferInfoEqual()

bool RENDERCORE_API IsGBufferInfoEqual ( const FGBufferInfo &  Lhs,
const FGBufferInfo &  Rhs 
)