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

Public variable

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.

Public variable

bool

 

bIsMSAA

Public variable

bool

 

bMultiviewPass

If this render pass should be multiview.

Public variable

bool

 

bOcclusionQueries

Public variable

bool

 

bTooManyUAVs

TODO: Remove once FORT-162640 is solved.

Public variable

FColorEntry[MaxSimultaneousRenderTargets]

 

ColorRenderTargets

Public variable

FDepthStencilEntry

 

DepthStencilRenderTarget

Public variable

FTextureRHIRef

 

FoveationTexture

Some RHIs can use a texture to control the sampling and/or shading resolution of different areas (

Public variable

uint32

 

NumOcclusionQueries

Some RHIs require a hint that occlusion queries will be used in this render pass.

Public variable

int32

 

NumUAVs

Public variable

FResolveParams

 

ResolveParameters

Public variable

ESubpassHint

 

SubpassHint

Hint for some RHI's that renderpass will have specific sub-passes.

Public variable

int32

 

UAVIndex

Public variable

FUnorderedAccessViewRHIRef[MaxSimultaneousUAVs]

 

UAVs

Constructors

Name Description

Public function

FRHIRenderPassInfo()

Public function

FRHIRenderPassInfo

(
    FRHITexture* ColorRT,
    ERenderTargetActions ColorAction,
    FRHITexture* ResolveColorRT,
    FRHITexture* DepthRT,
    EDepthStencilTargetActions DepthActions,
    FRHITexture* ResolveDepthRT,
    FExclusiveDepthStencil InEDS
)

Color and depth with resolve.

Public function

FRHIRenderPassInfo

(
    int32 NumColorRTs,
    FRHITexture* ColorRTs,
    ERenderTargetActions ColorAction,
    FRHITexture* ResolveRTs,
    FRHITexture* DepthRT,
    EDepthStencilTargetActions DepthActions,
    FRHITexture* ResolveDepthRT,
    FExclusiveDepthStencil InEDS
)

Color MRTs and depth.

Public function

FRHIRenderPassInfo

(
    FRHITexture* ColorRT,
    ERenderTargetActions ColorAction,
    FRHITexture* ResolveColorRT,
    FRHITexture* DepthRT,
    EDepthStencilTargetActions DepthActions,
    FRHITexture* ResolveDepthRT,
    FRHITexture* InFoveationTexture,
    FExclusiveDepthStencil InEDS
)

Color and depth with resolve and optional sample density.

Public function

FRHIRenderPassInfo

(
    int32 InNumUAVs,
    FRHIUnorderedAccessView** InUAVs
)

Public function

FRHIRenderPassInfo

(
    int32 NumColorRTs,
    FRHITexture* ColorRTs,
    ERenderTargetActions ColorAction
)

Color MRTs, no depth.

Public function

FRHIRenderPassInfo

(
    int32 NumColorRTs,
    FRHITexture* ColorRTs,
    ERenderTargetActions ColorAction,
    FRHITexture* ResolveTargets
)

Color MRTs, no depth.

Public function

FRHIRenderPassInfo

(
    FRHITexture* DepthRT,
    EDepthStencilTargetActions DepthActions,
    FRHITexture* ResolveDepthRT,
    FExclusiveDepthStencil InEDS
)

Depth, no color.

Public function

FRHIRenderPassInfo

(
    FRHITexture* ColorRT,
    ERenderTargetActions ColorAction,
    FRHITexture* ResolveRT,
    uint32 InMipIndex,
    int32 InArraySlice
)

Color, no depth, optional resolve, optional mip, optional array slice.

Public function

FRHIRenderPassInfo

(
    FRHITexture* DepthRT,
    uint32 InNumOcclusionQueries,
    EDepthStencilTargetActions DepthActions,
    FRHITexture* ResolveDepthRT,
    FExclusiveDepthStencil InEDS
)

Depth, no color, occlusion queries.

Public function

FRHIRenderPassInfo

(
    FRHITexture* ColorRT,
    ERenderTargetActions ColorAction,
    FRHITexture* DepthRT,
    EDepthStencilTargetActions DepthActions,
    FExclusiveDepthStencil InEDS
)

Color and depth.

Public function

FRHIRenderPassInfo

(
    int32 NumColorRTs,
    FRHITexture* ColorRTs,
    ERenderTargetActions ColorAction,
    FRHITexture* DepthRT,
    EDepthStencilTargetActions DepthActions,
    FExclusiveDepthStencil InEDS
)

Color MRTs and depth.

Functions

Classes

Name

Description

Public struct

FColorEntry

Public struct

FDepthStencilEntry

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback