FDebugViewModeInterface

Windows
MacOS
Linux

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Public/DebugViewModeInterface.h

Include

#include "DebugViewModeInterface.h"

Syntax

class FDebugViewModeInterface

Variables

Name Description

Public variable

const bool

 

bNeedsInstructionCount

Whether FDebugViewModePS::GetDebugViewModeShaderBindings() will use the num of instructions.

Public variable

const bool

 

bNeedsMaterialProperties

Whether the viewmode any of material properties (otherwise it can fallback to using the default material)

Public variable

const bool

 

bNeedsOnlyLocalVertexFactor

Whether only tiled mesh draw will be required.

Public variable

const TCHAR ...

 

PixelShaderName

The shader class name, used to filter out shaders that need to be compiled.

Constructors

Name Description

Public function

FDebugViewModeInterface

(
    const TCHAR * InPixelShaderName,
    bool InNeedsOnlyLocalVertexFactor,
    bool InNeedsMaterialProperties,
    bool InNeedsInstructionCount
)

Destructors

Name Description

Public function Virtual

~FDebugViewModeInterface()

Functions

Name Description

Public function Static

bool

 

AllowFallbackToDefaultMaterial

(
    const FMaterial * InMaterial
)

Whether this material can be substituted by the default material.

Public function Static

bool

 

AllowFallbackToDefaultMaterial

(
    EMaterialTessellationMode Tessellat...,
    bool bHasVertexPositionOffsetConnec...,
    bool bHasPixelDepthOffsetConnected
)

Whether this material can be substituted by the default material.

Public function Virtual Const

void

 

GetDebugViewModeShaderBindings

(
    const FDebugViewModePS& Shader,
    const FPrimitiveSceneProxy * Pr...,
    const FMaterialRenderProxy & Materi...,
    const FMaterial & Material,
    EDebugViewShaderMode DebugViewMode,
    const FVector & ViewOrigin,
    int32 VisualizeLODIndex,
    int32 VisualizeElementIndex,
    int32 NumVSInstructions,
    int32 NumPSInstructions,
    int32 ViewModeParam,
    FName ViewModeParamName,
    FMeshDrawSingleShaderBindings & Sha...
)

Public function Static

const FDebug ...

 

GetInterface

(
    EDebugViewShaderMode InDebugViewMod...
)

Return the interface object for the given viewmode.

Public function Const

TShaderRef < ...

 

GetPixelShader

(
    const FMaterial * InMaterial,
    FVertexFactoryType * VertexFact...
)

Public function Virtual Const

void

 

SetDrawRenderState

(
    EBlendMode BlendMode,
    FRenderState & DrawRenderState,
    bool bHasDepthPrepassForMaskedMater...
)

Public function Static

void

 

SetInterface

(
    EDebugViewShaderMode InDebugViewMod...,
    FDebugViewModeInterface * Inter...
)

Return the interface object for the given viewmode.

Classes

Name

Description

Public struct

FRenderState

Constants

Name

Description

Singletons

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