FPrimitiveViewRelevance

The different types of relevance a primitive scene proxy can declare towards a particular scene view.

Windows
MacOS
Linux

Syntax

struct FPrimitiveViewRelevance

Remarks

The different types of relevance a primitive scene proxy can declare towards a particular scene view. the class is only storing bits, and has an |= operator

Variables

Name Description

Public variable

uint32: 1

 

bDecal

Public variable

uint32: 1

 

bDisableOffscreenRendering

For primitive that can't render in offscreen buffers (blend modulate).

Public variable

uint32: 1

 

bDistortionRelevance

The primitive has one or more distortion elements.

Public variable

uint32: 1

 

bDrawRelevance

The primitive is drawn.

Public variable

uint32: 1

 

bDynamicRelevance

The primitive's dynamic elements are rendered for the view.

Public variable

uint32: 1

 

bEditorNoDepthTestPrimitiveRelevance

The primitive is drawn only in the editor and composited onto the scene after post processing using no depth testing

Public variable

uint32: 1

 

bEditorPrimitiveRelevance

The primitive is drawn only in the editor and composited onto the scene after post processing

Public variable

uint32: 1

 

bEditorStaticSelectionRelevance

The primitive's static elements are selected and rendered again in the selection outline pass

Public variable

uint32: 1

 

bHasSimpleLights

The primitive should have GatherSimpleLights called on the proxy when gathering simple lights.

Public variable

uint32: 1

 

bHasVolumeMaterialDomain

The primitive has materials using the volume domain.

Public variable

uint32: 1

 

bInitializedThisFrame

Whether this primitive view relevance has been initialized this frame.

Public variable

uint32: 1

 

bMaskedRelevance

The primitive has one or more masked elements.

Public variable

uint32: 1

 

bNormalTranslucencyRelevance

The primitive has one or more elements that have normal translucency.

Public variable

uint32: 1

 

bOpaqueRelevance

The primitive has one or more opaque or masked elements.

Public variable

uint32: 1

 

bRenderCustomDepth

The primitive should render to the custom depth pass.

Public variable

uint32: 1

 

bRenderInMainPass

The primitive should render to the base pass / normal depth / velocity rendering.

Public variable

uint32: 1

 

bSeparateTranslucencyRelevance

The primitive has one or more elements that have SeparateTranslucency.

Public variable

uint32: 1

 

bShadowRelevance

The primitive is casting a shadow.

Public variable

uint32: 1

 

bStaticRelevance

The primitive's static elements are rendered for the view.

Public variable

uint32: 1

 

bTranslucentSelfShadow

Whether the primitive has materials that use volumetric translucent self shadow.

Public variable

uint32: 1

 

bTranslucentSurfaceLighting

Whether the primitive has materials that use translucent surface lighting.

Public variable

uint32: 1

 

bUseCustomViewData

Whether the view use custom data.

Public variable

uint32: 1

 

bUsesGlobalDistanceField

Public variable

uint32: 1

 

bUsesLightingChannels

Whether the primitive uses non-default lighting channels.

Public variable

uint32: 1

 

bUsesSceneColorCopy

For translucent primitives reading the scene color.

Public variable

uint32: 1

 

bUsesSceneDepth

Whether the primitive has materials that read the scene depth.

Public variable

uint32: 1

 

bUsesWorldPositionOffset

The primitive has one or more elements that have World Position Offset.

Public variable

uint32: 1

 

bVelocityRelevance

The primitive should render velocity.

Public variable

uint16

 

ShadingModelMaskRelevance

Warning: This class is memzeroed externally as 0 is assumed a valid value for all members meaning 'not relevant'.

Constructors

Name Description

Public function

FPrimitiveViewRelevance()

Default constructor

Functions

Name Description

Public function Const

bool

 

HasTranslucency()

Operators

Name Description

Public function

FPrimitiveVi...

 

operator|=

(
    const FPrimitiveViewRelevance& B
)

Bitwise OR operator. Sets any relevance bits which are present in either.

References

Module

Engine

Header

Runtime/Engine/Public/PrimitiveViewRelevance.h

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