Navigation
API > API/Runtime > API/Runtime/Renderer
A collection of debug data associated with the current on screen view.
| Name | FViewDebugInfo |
| Type | struct |
| Header File | /Engine/Source/Runtime/Renderer/Public/ViewDebug.h |
| Include Path | #include "ViewDebug.h" |
Syntax
struct FViewDebugInfo
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FViewDebugInfo() |
ViewDebug.h |
Structs
| Name | Remarks |
|---|---|
| FPrimitiveInfo | Data collected about a single primitive being drawn to the screen. |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| Instance | FViewDebugInfo | ViewDebug.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bHasEverUpdated | bool | ViewDebug.h | ||
| bIsOutdated | bool | ViewDebug.h | ||
| bShouldCaptureSingleFrame | bool | ViewDebug.h | ||
| bShouldClearCapturedData | bool | ViewDebug.h | ||
| bShouldUpdate | bool | ViewDebug.h | ||
| Lock | FRWLock | ViewDebug.h | ||
| OnUpdate | FOnUpdateViewDebugInfo | ViewDebug.h | ||
| Primitives | TMap< FPrimitiveComponentId, FPrimitiveInfo > | ViewDebug.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FDelegateHandle AddUpdateHandler
(
void(*)() Func |
ViewDebug.h | ||
FDelegateHandle AddUpdateHandler
(
UserClass* UserObject, |
ViewDebug.h | ||
void DumpDrawCallsToCSV () |
Writes the draw call count of all currently tracked primitives to a csv file. | ViewDebug.h | |
void DumpToCSV () |
Writes detailed information about all currently tracked primitives to a csv file. | ViewDebug.h | |
void ForEachPrimitive
(
CallableT Action |
Performs an operation for each primitive currently tracked. | ViewDebug.h | |
bool HasEverUpdated() |
Checks if this debug information has ever been updated. | ViewDebug.h | |
bool IsOutOfDate() |
Checks if current information is from an older frame. | ViewDebug.h | |
void ProcessPrimitives
(
FScene* Scene, |
ViewDebug.h | ||
void RemoveUpdateHandler
(
const FDelegateHandle& Handle |
ViewDebug.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FViewDebugInfo & Get() |
Gets a reference to the view debug information that is used by the renderer. | ViewDebug.h |