FViewDebugInfo Struct Reference

#include <ViewDebug.h>

Classes
struct	FPrimitiveInfo

Public Member Functions
RENDERER_API void	ProcessPrimitives (FScene *Scene, const FViewInfo &View, const FViewCommands &ViewCommands)
RENDERER_API void	DumpDrawCallsToCSV ()
RENDERER_API void	DumpToCSV () const
template<typename CallableT >
void	ForEachPrimitive (CallableT Action) const
RENDERER_API bool	HasEverUpdated () const
RENDERER_API bool	IsOutOfDate () const
template<typename UserClass >
FDelegateHandle	AddUpdateHandler (UserClass *UserObject, void(UserClass::*Func)())
FDelegateHandle	AddUpdateHandler (void(*Func)())
void	RemoveUpdateHandler (const FDelegateHandle &Handle)

Static Public Member Functions
static FViewDebugInfo &	Get ()

Friends
class	FDrawPrimitiveDebuggerModule

Detailed Description

A collection of debug data associated with the current on screen view.

Member Function Documentation

AddUpdateHandler() [1/2]

template<typename UserClass >

FDelegateHandle FViewDebugInfo::AddUpdateHandler ( UserClass *  UserObject, void(UserClass::*)()  Func  )

inline

AddUpdateHandler() [2/2]

FDelegateHandle FViewDebugInfo::AddUpdateHandler ( void(*)()  Func )

inline

DumpDrawCallsToCSV()

void FViewDebugInfo::DumpDrawCallsToCSV

(

)

Writes the draw call count of all currently tracked primitives to a csv file. The file will be stored in /Saved/Profiling/Primitives/...

DumpToCSV()

void FViewDebugInfo::DumpToCSV

(

)

const

Writes detailed information about all currently tracked primitives to a csv file. The file will be stored in /Saved/Profiling/Primitives/...

ForEachPrimitive()

template<typename CallableT >

void FViewDebugInfo::ForEachPrimitive ( CallableT  Action ) const

inline

Performs an operation for each primitive currently tracked.

Parameters

Action

The action to perform for each primitive.

Get()

static FViewDebugInfo & FViewDebugInfo::Get ( )

inlinestatic

Gets a reference to the view debug information that is used by the renderer.

Returns

The debug information that is used by the renderer.

HasEverUpdated()

bool FViewDebugInfo::HasEverUpdated

(

)

const

Checks if this debug information has ever been updated.

Returns

True if the information has been updated at least once.

IsOutOfDate()

bool FViewDebugInfo::IsOutOfDate

(

)

const

Checks if current information is from an older frame.

Returns

True if the data in this object is outdated.

ProcessPrimitives()

void FViewDebugInfo::ProcessPrimitives	(	FScene *	Scene,
		const FViewInfo &	View,
		const FViewCommands &	ViewCommands
	)

RemoveUpdateHandler()

void FViewDebugInfo::RemoveUpdateHandler ( const FDelegateHandle &  Handle )

inline

Friends And Related Symbol Documentation

FDrawPrimitiveDebuggerModule

friend class FDrawPrimitiveDebuggerModule

friend

---

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

• Engine/Source/Runtime/Renderer/Public/ViewDebug.h
• Engine/Source/Runtime/Renderer/Private/ViewDebug.cpp