FDebugFloatHistory Struct Reference

#include <EngineTypes.h>

Public Member Functions
	FDebugFloatHistory ()
	FDebugFloatHistory (int32 const &InMaxSamples, float const &InMinValue, float const &InMaxValue, bool const &InbAutoAdjustMinMax)
void	AddSample (float const &FloatValue)
float	GetMinMaxRange () const
float	GetMinValue () const
float	GetMaxValue () const
int	GetNumSamples () const
TArray< float > const &	GetSamples () const

Public Attributes
int32	MaxSamples
float	MinValue
float	MaxValue
bool	bAutoAdjustMinMax

Detailed Description

Structure for recording float values and displaying them as an Histogram through DrawDebugFloatHistory.

Constructor & Destructor Documentation

FDebugFloatHistory() [1/2]

FDebugFloatHistory::FDebugFloatHistory ( )

inline

FDebugFloatHistory() [2/2]

FDebugFloatHistory::FDebugFloatHistory ( int32 const &  InMaxSamples, float const &  InMinValue, float const &  InMaxValue, bool const &  InbAutoAdjustMinMax  )

inline

Member Function Documentation

AddSample()

void FDebugFloatHistory::AddSample ( float const &  FloatValue )

inline

Record a new Sample. if bAutoAdjustMinMax is true, this new value will potentially adjust those bounds. Otherwise value will be clamped before being recorded. If MaxSamples is exceeded, old values will be deleted.

Parameters

FloatValue

new sample to record.

GetMaxValue()

float FDebugFloatHistory::GetMaxValue ( ) const

inline

Max value. This could be either the max value recorded or max value allowed depending on 'bAutoAdjustMinMax'.

GetMinMaxRange()

float FDebugFloatHistory::GetMinMaxRange ( ) const

inline

Range between Min and Max values

GetMinValue()

float FDebugFloatHistory::GetMinValue ( ) const

inline

Min value. This could either be the min value recorded or min value allowed depending on 'bAutoAdjustMinMax'.

GetNumSamples()

int FDebugFloatHistory::GetNumSamples ( ) const

inline

Number of Samples currently recorded

GetSamples()

TArray< float > const & FDebugFloatHistory::GetSamples ( ) const

inline

Read access to Samples array

Member Data Documentation

bAutoAdjustMinMax

bool FDebugFloatHistory::bAutoAdjustMinMax

Auto adjust Min/Max as new values are recorded?

MaxSamples

int32 FDebugFloatHistory::MaxSamples

Max Samples to record.

MaxValue

float FDebugFloatHistory::MaxValue

Max value to record.

MinValue

float FDebugFloatHistory::MinValue

Min value to record.

---

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

• Engine/Source/Runtime/Engine/Classes/Engine/EngineTypes.h