ShaderPrint::FShaderPrintSetup Struct Reference

#include <ShaderPrintParameters.h>

Public Member Functions
	FShaderPrintSetup ()=default
RENDERER_API	FShaderPrintSetup (FSceneView const &InView)
RENDERER_API	FShaderPrintSetup (FIntRect InViewRect)

Public Attributes
bool	bEnabled = false
FIntRect	ViewRect = FIntRect(0, 0, 1, 1)
FIntPoint	CursorCoord = FIntPoint(-1, -1)
FVector	PreViewTranslation = FVector::ZeroVector
float	DPIScale = 1.f
FIntPoint	FontSize = 1
FIntPoint	FontSpacing = 1
uint32	MaxCharacterCount = 0
uint32	MaxStateCount = 0
uint32	MaxLineCount = 0
uint32	MaxTriangleCount = 0
bool	bIsDrawLocked = false

Detailed Description

Structure containing setup for shader print capturing.

Constructor & Destructor Documentation

FShaderPrintSetup() [1/3]

ShaderPrint::FShaderPrintSetup::FShaderPrintSetup ( )

default

Construct with shader print disabled setup.

FShaderPrintSetup() [2/3]

ShaderPrint::FShaderPrintSetup::FShaderPrintSetup

(

FSceneView const &

InView

)

Construct with view and system defaults.

FShaderPrintSetup() [3/3]

ShaderPrint::FShaderPrintSetup::FShaderPrintSetup

(

FIntRect

InViewRect

)

Construct with view rectangle and system defaults.

Member Data Documentation

bEnabled

bool ShaderPrint::FShaderPrintSetup::bEnabled = false

The shader print system's enabled state. This is set in the constructor and should't be overriden.

bIsDrawLocked

bool ShaderPrint::FShaderPrintSetup::bIsDrawLocked = false

CursorCoord

FIntPoint ShaderPrint::FShaderPrintSetup::CursorCoord = FIntPoint(-1, -1)

Cursor pixel position within viewport. Can be used for isolating a pixel to debug.

DPIScale

float ShaderPrint::FShaderPrintSetup::DPIScale = 1.f

DPI scale to take into account when drawing font.

FontSize

FIntPoint ShaderPrint::FShaderPrintSetup::FontSize = 1

Font size in pixels.

FontSpacing

FIntPoint ShaderPrint::FShaderPrintSetup::FontSpacing = 1

Font spacing in pixels (not including font size).

MaxCharacterCount

uint32 ShaderPrint::FShaderPrintSetup::MaxCharacterCount = 0

Initial size of character buffer. Will also be increased by RequestSpaceForCharacters().

MaxLineCount

uint32 ShaderPrint::FShaderPrintSetup::MaxLineCount = 0

Initial size of line buffer. Will also be increased by RequestSpaceForLines().

MaxStateCount

uint32 ShaderPrint::FShaderPrintSetup::MaxStateCount = 0

Initial size of widget buffer.

MaxTriangleCount

uint32 ShaderPrint::FShaderPrintSetup::MaxTriangleCount = 0

Initial size of triangle buffer. Will also be increased by RequestSpaceForLines().

PreViewTranslation

FVector ShaderPrint::FShaderPrintSetup::PreViewTranslation = FVector::ZeroVector

PreView translation used for storing line positions in translated world space.

ViewRect

FIntRect ShaderPrint::FShaderPrintSetup::ViewRect = FIntRect(0, 0, 1, 1)

Expected viewport rectangle.

---

The documentation for this struct was generated from the following files:

• Engine/Source/Runtime/Renderer/Public/ShaderPrintParameters.h
• Engine/Source/Runtime/Renderer/Private/ShaderPrint.cpp