FPrimitiveViewRelevance

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

Windows
MacOS
Linux

Inheritance Hierarchy

FMaterialRelevance

FPrimitiveViewRelevance

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Public/PrimitiveViewRelevance.h

Include

#include "PrimitiveViewRelevance.h"

Syntax

struct FPrimitiveViewRelevance : public FMaterialRelevance

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

 

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

 

bInitializedThisFrame

Whether this primitive view relevance has been initialized this frame.

Public variable

uint32 : 1

 

bRenderCustomDepth

The primitive should render to the custom depth pass.

Public variable

uint32 : 1

 

bRenderInDepthPass

The primitive should render to the depth prepass even if it's not rendered in the main pass.

Public variable

uint32 : 1

 

bRenderInMainPass

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

Public variable

uint32 : 1

 

bShadowRelevance

The primitive is casting a shadow.

Public variable

uint32 : 1

 

bStaticRelevance

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

Public variable

uint32 : 1

 

bTranslucentSelfShadow

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

Public variable

uint32 : 1

 

bUseCustomViewData

Whether the view use custom data.

Public variable

uint32 : 1

 

bUsesLightingChannels

Whether the primitive uses non-default lighting channels.

Public variable

uint32 : 1

 

bVelocityRelevance

The primitive should render velocity.

Constructors

Name Description

Public function

FPrimitiveViewRelevance()

Default constructor

Functions

Name Description

Public function Const

bool

 

HasTranslucency()

Public function Const

bool

 

HasVelocity()

Operators

Name Description

Public function

FPrimitiveVi ...

 

operator|=

(
    const FPrimitiveViewRelevance & B
)

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

Deprecated Variables

Name Description

Public variable

uint32 : 1

 

bDistortionRelevance

bDistortionRelevance has been renamed bDistortion

Public variable

uint32 : 1

 

bHairStrandsRelevance

bHairStrandsRelevance has been renamed bHairStrands

Public variable

uint32 : 1

 

bMaskedRelevance

bMaskedRelevance has been renamed bMasked

Public variable

uint32 : 1

 

bNormalTranslucencyRelevance

bNormalTranslucencyRelevance has been renamed bNormalTranslucency

Public variable

uint32 : 1

 

bOpaqueRelevance

bOpaqueRelevance has been renamed bOpaque

Public variable

uint32 : 1

 

bSeparateTranslucencyRelevance

bSeparateTranslucencyRelevance has been renamed bSeparateTranslucency

Public variable

uint32 : 1

 

bTranslucentVelocityRelevance

bTranslucentVelocityRelevance has been renamed bOutputsTranslucentVelocity

Public variable

uint16

 

ShadingModelMaskRelevance

ShadingModelMaskRelevance has been renamed ShadingModelMask

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