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

#include <RHIResources.h>

+ Inheritance diagram for FRHIRenderPassInfo:

Classes

struct  FColorEntry
 
struct  FDepthStencilEntry
 

Public Member Functions

 FRHIRenderPassInfo ()=default
 
 FRHIRenderPassInfo (const FRHIRenderPassInfo &)=default
 
FRHIRenderPassInfooperator= (const FRHIRenderPassInfo &)=default
 
 FRHIRenderPassInfo (FRHITexture *ColorRT, ERenderTargetActions ColorAction, FRHITexture *ResolveRT=nullptr, uint8 InMipIndex=0, int32 InArraySlice=-1)
 
 FRHIRenderPassInfo (int32 NumColorRTs, FRHITexture *ColorRTs[], ERenderTargetActions ColorAction)
 
 FRHIRenderPassInfo (int32 NumColorRTs, FRHITexture *ColorRTs[], ERenderTargetActions ColorAction, FRHITexture *ResolveTargets[])
 
 FRHIRenderPassInfo (int32 NumColorRTs, FRHITexture *ColorRTs[], ERenderTargetActions ColorAction, FRHITexture *DepthRT, EDepthStencilTargetActions DepthActions, FExclusiveDepthStencil InEDS=FExclusiveDepthStencil::DepthWrite_StencilWrite)
 
 FRHIRenderPassInfo (int32 NumColorRTs, FRHITexture *ColorRTs[], ERenderTargetActions ColorAction, FRHITexture *ResolveRTs[], FRHITexture *DepthRT, EDepthStencilTargetActions DepthActions, FRHITexture *ResolveDepthRT, FExclusiveDepthStencil InEDS=FExclusiveDepthStencil::DepthWrite_StencilWrite)
 
 FRHIRenderPassInfo (FRHITexture *DepthRT, EDepthStencilTargetActions DepthActions, FRHITexture *ResolveDepthRT=nullptr, FExclusiveDepthStencil InEDS=FExclusiveDepthStencil::DepthWrite_StencilWrite)
 
 FRHIRenderPassInfo (FRHITexture *DepthRT, uint32 InNumOcclusionQueries, EDepthStencilTargetActions DepthActions, FRHITexture *ResolveDepthRT=nullptr, FExclusiveDepthStencil InEDS=FExclusiveDepthStencil::DepthWrite_StencilWrite)
 
 FRHIRenderPassInfo (FRHITexture *ColorRT, ERenderTargetActions ColorAction, FRHITexture *DepthRT, EDepthStencilTargetActions DepthActions, FExclusiveDepthStencil InEDS=FExclusiveDepthStencil::DepthWrite_StencilWrite)
 
 FRHIRenderPassInfo (FRHITexture *ColorRT, ERenderTargetActions ColorAction, FRHITexture *ResolveColorRT, FRHITexture *DepthRT, EDepthStencilTargetActions DepthActions, FRHITexture *ResolveDepthRT, FExclusiveDepthStencil InEDS=FExclusiveDepthStencil::DepthWrite_StencilWrite)
 
 FRHIRenderPassInfo (FRHITexture *ColorRT, ERenderTargetActions ColorAction, FRHITexture *ResolveColorRT, FRHITexture *DepthRT, EDepthStencilTargetActions DepthActions, FRHITexture *ResolveDepthRT, FRHITexture *InShadingRateTexture, EVRSRateCombiner InShadingRateTextureCombiner, FExclusiveDepthStencil InEDS=FExclusiveDepthStencil::DepthWrite_StencilWrite)
 
int32 GetNumColorRenderTargets () const
 
FGraphicsPipelineRenderTargetsInfo ExtractRenderTargetsInfo () const
 
RHI_API void Validate () const
 
RHI_API void ConvertToRenderTargetsInfo (FRHISetRenderTargetsInfo &OutRTInfo) const
 

Public Attributes

TStaticArray< FColorEntry, MaxSimultaneousRenderTargetsColorRenderTargets
 
FDepthStencilEntry DepthStencilRenderTarget
 
FResolveRect ResolveRect
 
FTextureRHIRef ShadingRateTexture = nullptr
 
EVRSRateCombiner ShadingRateTextureCombiner = VRSRB_Passthrough
 
ERHIAccess NopAccess = ERHIAccess::Unknown
 
uint32 NumOcclusionQueries = 0
 
bool bOcclusionQueries = false
 
uint8 MultiViewCount = 0
 
ESubpassHint SubpassHint = ESubpassHint::None
 

Constructor & Destructor Documentation

◆ FRHIRenderPassInfo() [1/12]

FRHIRenderPassInfo::FRHIRenderPassInfo ( )
default

◆ FRHIRenderPassInfo() [2/12]

FRHIRenderPassInfo::FRHIRenderPassInfo ( const FRHIRenderPassInfo )
default

◆ FRHIRenderPassInfo() [3/12]

FRHIRenderPassInfo::FRHIRenderPassInfo ( FRHITexture ColorRT,
ERenderTargetActions  ColorAction,
FRHITexture ResolveRT = nullptr,
uint8  InMipIndex = 0,
int32  InArraySlice = -1 
)
inlineexplicit

◆ FRHIRenderPassInfo() [4/12]

FRHIRenderPassInfo::FRHIRenderPassInfo ( int32  NumColorRTs,
FRHITexture ColorRTs[],
ERenderTargetActions  ColorAction 
)
inlineexplicit

◆ FRHIRenderPassInfo() [5/12]

FRHIRenderPassInfo::FRHIRenderPassInfo ( int32  NumColorRTs,
FRHITexture ColorRTs[],
ERenderTargetActions  ColorAction,
FRHITexture ResolveTargets[] 
)
inlineexplicit

◆ FRHIRenderPassInfo() [6/12]

FRHIRenderPassInfo::FRHIRenderPassInfo ( int32  NumColorRTs,
FRHITexture ColorRTs[],
ERenderTargetActions  ColorAction,
FRHITexture DepthRT,
EDepthStencilTargetActions  DepthActions,
FExclusiveDepthStencil  InEDS = FExclusiveDepthStencil::DepthWrite_StencilWrite 
)
inlineexplicit

◆ FRHIRenderPassInfo() [7/12]

FRHIRenderPassInfo::FRHIRenderPassInfo ( int32  NumColorRTs,
FRHITexture ColorRTs[],
ERenderTargetActions  ColorAction,
FRHITexture ResolveRTs[],
FRHITexture DepthRT,
EDepthStencilTargetActions  DepthActions,
FRHITexture ResolveDepthRT,
FExclusiveDepthStencil  InEDS = FExclusiveDepthStencil::DepthWrite_StencilWrite 
)
inlineexplicit

◆ FRHIRenderPassInfo() [8/12]

FRHIRenderPassInfo::FRHIRenderPassInfo ( FRHITexture DepthRT,
EDepthStencilTargetActions  DepthActions,
FRHITexture ResolveDepthRT = nullptr,
FExclusiveDepthStencil  InEDS = FExclusiveDepthStencil::DepthWrite_StencilWrite 
)
inlineexplicit

◆ FRHIRenderPassInfo() [9/12]

FRHIRenderPassInfo::FRHIRenderPassInfo ( FRHITexture DepthRT,
uint32  InNumOcclusionQueries,
EDepthStencilTargetActions  DepthActions,
FRHITexture ResolveDepthRT = nullptr,
FExclusiveDepthStencil  InEDS = FExclusiveDepthStencil::DepthWrite_StencilWrite 
)
inlineexplicit

◆ FRHIRenderPassInfo() [10/12]

FRHIRenderPassInfo::FRHIRenderPassInfo ( FRHITexture ColorRT,
ERenderTargetActions  ColorAction,
FRHITexture DepthRT,
EDepthStencilTargetActions  DepthActions,
FExclusiveDepthStencil  InEDS = FExclusiveDepthStencil::DepthWrite_StencilWrite 
)
inlineexplicit

◆ FRHIRenderPassInfo() [11/12]

FRHIRenderPassInfo::FRHIRenderPassInfo ( FRHITexture ColorRT,
ERenderTargetActions  ColorAction,
FRHITexture ResolveColorRT,
FRHITexture DepthRT,
EDepthStencilTargetActions  DepthActions,
FRHITexture ResolveDepthRT,
FExclusiveDepthStencil  InEDS = FExclusiveDepthStencil::DepthWrite_StencilWrite 
)
inlineexplicit

◆ FRHIRenderPassInfo() [12/12]

FRHIRenderPassInfo::FRHIRenderPassInfo ( FRHITexture ColorRT,
ERenderTargetActions  ColorAction,
FRHITexture ResolveColorRT,
FRHITexture DepthRT,
EDepthStencilTargetActions  DepthActions,
FRHITexture ResolveDepthRT,
FRHITexture InShadingRateTexture,
EVRSRateCombiner  InShadingRateTextureCombiner,
FExclusiveDepthStencil  InEDS = FExclusiveDepthStencil::DepthWrite_StencilWrite 
)
inlineexplicit

Member Function Documentation

◆ ConvertToRenderTargetsInfo()

void FRHIRenderPassInfo::ConvertToRenderTargetsInfo ( FRHISetRenderTargetsInfo OutRTInfo) const

◆ ExtractRenderTargetsInfo()

FGraphicsPipelineRenderTargetsInfo FRHIRenderPassInfo::ExtractRenderTargetsInfo ( ) const
inline

◆ GetNumColorRenderTargets()

int32 FRHIRenderPassInfo::GetNumColorRenderTargets ( ) const
inline

◆ operator=()

FRHIRenderPassInfo & FRHIRenderPassInfo::operator= ( const FRHIRenderPassInfo )
default

◆ Validate()

void FRHIRenderPassInfo::Validate ( ) const

Member Data Documentation

◆ bOcclusionQueries

bool FRHIRenderPassInfo::bOcclusionQueries = false

◆ ColorRenderTargets

TStaticArray<FColorEntry, MaxSimultaneousRenderTargets> FRHIRenderPassInfo::ColorRenderTargets

◆ DepthStencilRenderTarget

FDepthStencilEntry FRHIRenderPassInfo::DepthStencilRenderTarget

◆ MultiViewCount

uint8 FRHIRenderPassInfo::MultiViewCount = 0

◆ NopAccess

ERHIAccess FRHIRenderPassInfo::NopAccess = ERHIAccess::Unknown

◆ NumOcclusionQueries

uint32 FRHIRenderPassInfo::NumOcclusionQueries = 0

◆ ResolveRect

FResolveRect FRHIRenderPassInfo::ResolveRect

◆ ShadingRateTexture

FTextureRHIRef FRHIRenderPassInfo::ShadingRateTexture = nullptr

◆ ShadingRateTextureCombiner

EVRSRateCombiner FRHIRenderPassInfo::ShadingRateTextureCombiner = VRSRB_Passthrough

◆ SubpassHint

ESubpassHint FRHIRenderPassInfo::SubpassHint = ESubpassHint::None

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