Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > RHI > FRHIRenderPassInfo

Light Theme

Dark Theme

FRHIRenderPassInfo

Windows

MacOS

Linux

References

Module	RHI
Header	/Engine/Source/Runtime/RHI/Public/RHIResources.h
Include	#include "RHIResources.h"

Syntax

struct FRHIRenderPassInfo

Variables

	Name	Description
bool	bGeneratingMips	Some RHIs need to know if this render pass is going to be reading and writing to the same texture in the case of generating mip maps for partial resource transitions.
bool	bIsMSAA
bool	bOcclusionQueries
bool	bTooManyUAVs	TODO: Remove once FORT-162640 is solved.
FColorEntry[Max...	ColorRenderTargets
FDepthStencilEn...	DepthStencilRenderTarget
uint8	MultiViewCount	If this renderpass should be multiview, and if so how many views are required
uint32	NumOcclusionQueries	Some RHIs require a hint that occlusion queries will be used in this render pass.
FResolveParams	ResolveParameters
FTextureRHIRef	ShadingRateTexture	Some RHIs can use a texture to control the sampling and/or shading resolution of different areas.
EVRSRateCombine...	ShadingRateTextureCombiner
ESubpassHint	SubpassHint	Hint for some RHI's that renderpass will have specific sub-passes.

Constructors

	Name	Description
	FRHIRenderPassInfo()
	FRHIRenderPassInfo ( FRHITexture* ColorRT, ERenderTargetActions ColorAction, FRHITexture* ResolveColorRT, FRHITexture* DepthRT, EDepthStencilTargetActions DepthAct..., FRHITexture* ResolveDepthRT, FExclusiveDepthStencil InEDS )	Color and depth with resolve.
	FRHIRenderPassInfo ( int32 NumColorRTs, FRHITexture* ColorRTs, ERenderTargetActions ColorAction, FRHITexture* ResolveRTs, FRHITexture* DepthRT, EDepthStencilTargetActions DepthAct..., FRHITexture* ResolveDepthRT, FExclusiveDepthStencil InEDS )	Color MRTs and depth.
	FRHIRenderPassInfo ( FRHITexture* ColorRT, ERenderTargetActions ColorAction, FRHITexture* ResolveColorRT, FRHITexture* DepthRT, EDepthStencilTargetActions DepthAct..., FRHITexture* ResolveDepthRT, FRHITexture* InShadingRateText..., EVRSRateCombiner InShadingRateTextu..., FExclusiveDepthStencil InEDS )	Color and depth with resolve and optional sample density.
	FRHIRenderPassInfo ( ENoRenderTargets Dummy )
	FRHIRenderPassInfo ( int32 NumColorRTs, FRHITexture* ColorRTs, ERenderTargetActions ColorAction )	Color MRTs, no depth.
	FRHIRenderPassInfo ( int32 NumColorRTs, FRHITexture* ColorRTs, ERenderTargetActions ColorAction, FRHITexture* ResolveTargets )	Color MRTs, no depth.
	FRHIRenderPassInfo ( FRHITexture* DepthRT, EDepthStencilTargetActions DepthAct..., FRHITexture* ResolveDepthRT, FExclusiveDepthStencil InEDS )	Depth, no color.
	FRHIRenderPassInfo ( FRHITexture* ColorRT, ERenderTargetActions ColorAction, FRHITexture* ResolveRT, uint32 InMipIndex, int32 InArraySlice )	Color, no depth, optional resolve, optional mip, optional array slice.
	FRHIRenderPassInfo ( FRHITexture* DepthRT, uint32 InNumOcclusionQueries, EDepthStencilTargetActions DepthAct..., FRHITexture* ResolveDepthRT, FExclusiveDepthStencil InEDS )	Depth, no color, occlusion queries.
	FRHIRenderPassInfo ( FRHITexture* ColorRT, ERenderTargetActions ColorAction, FRHITexture* DepthRT, EDepthStencilTargetActions DepthAct..., FExclusiveDepthStencil InEDS )	Color and depth.
	FRHIRenderPassInfo ( int32 NumColorRTs, FRHITexture* ColorRTs, ERenderTargetActions ColorAction, FRHITexture* DepthRT, EDepthStencilTargetActions DepthAct..., FExclusiveDepthStencil InEDS )	Color MRTs and depth.

Functions

		Name	Description
	void	ConvertToRenderTargetsInfo ( FRHISetRenderTargetsInfo& OutRTInf... )
	int32	GetNumColorRenderTargets()
	bool	IsMSAA()
	void	Validate()

Classes

	Name	Description
	FColorEntry
	FDepthStencilEntry

Enums

	Name	Description
	ENoRenderTargets

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss