ParticlePerfStats.h File Reference

#include "Templates/Atomic.h"
#include "CoreMinimal.h"
#include "CoreTypes.h"
#include "HAL/PlatformTime.h"
#include "Containers/Array.h"
#include "ProfilingDebugging/CsvProfiler.h"

Go to the source code of this file.

Classes
struct	FParticlePerfStats_GT
struct	FParticlePerfStats_RT
struct	FParticlePerfStats_GPU
struct	FParticlePerfStats
struct	FParticlePerfStatsContext
struct	FParticlePerfStatScope< TWriterFunc >

Macros
#define	WITH_GLOBAL_RUNTIME_FX_BUDGET   (!UE_SERVER)
#define	WITH_PARTICLE_PERF_STATS   1
#define	WITH_PER_SYSTEM_PARTICLE_PERF_STATS   (WITH_PARTICLE_PERF_STATS && !UE_BUILD_SHIPPING)
#define	WITH_PER_COMPONENT_PARTICLE_PERF_STATS   (WITH_PARTICLE_PERF_STATS && !UE_BUILD_SHIPPING)
#define	WITH_PARTICLE_PERF_CSV_STATS   WITH_PER_SYSTEM_PARTICLE_PERF_STATS && CSV_PROFILER_STATS && !UE_BUILD_SHIPPING
#define	PARTICLE_PERF_STAT_CYCLES_COMMON(CONTEXT, THREAD, NAME)
#define	PARTICLE_PERF_STAT_CYCLES_WITH_COUNT_COMMON(CONTEXT, THREAD, NAME, COUNT)
#define	PARTICLE_PERF_STAT_CYCLES_GT(CONTEXT, NAME)   PARTICLE_PERF_STAT_CYCLES_COMMON(CONTEXT, GameThread, NAME)
#define	PARTICLE_PERF_STAT_CYCLES_RT(CONTEXT, NAME)   PARTICLE_PERF_STAT_CYCLES_COMMON(CONTEXT, RenderThread, NAME)
#define	PARTICLE_PERF_STAT_CYCLES_WITH_COUNT_GT(CONTEXT, NAME, COUNT)   PARTICLE_PERF_STAT_CYCLES_WITH_COUNT_COMMON(CONTEXT, GameThread, NAME, COUNT)
#define	PARTICLE_PERF_STAT_CYCLES_WITH_COUNT_RT(CONTEXT, NAME, COUNT)   PARTICLE_PERF_STAT_CYCLES_WITH_COUNT_COMMON(CONTEXT, RenderThread, NAME, COUNT)

Typedefs
typedef TFunction< void(FParticlePerfStats *Stats, uint64 Cycles)>	FParticlePerfStatsWriterFunc

Functions
	CSV_DECLARE_CATEGORY_MODULE_EXTERN (ENGINE_API, Particles)

Macro Definition Documentation

PARTICLE_PERF_STAT_CYCLES_COMMON

#define PARTICLE_PERF_STAT_CYCLES_COMMON	(		CONTEXT,
			THREAD,
			NAME
	)

Value:

struct FParticlePerfStatsWriterCycles_##THREAD##_##NAME\
{\
    inline static void Write(FParticlePerfStats* Stats, uint64 Cycles, int32 Count)\
    {\
		if (Stats){ Stats->Get##THREAD##Stats().NAME##Cycles += Cycles;   }\
    }\
};\
FParticlePerfStatScope<FParticlePerfStatsWriterCycles_##THREAD##_##NAME> ANONYMOUS_VARIABLE(ParticlePerfStatScope##THREAD##NAME)(CONTEXT);

PARTICLE_PERF_STAT_CYCLES_GT

#define PARTICLE_PERF_STAT_CYCLES_GT	(		CONTEXT,
			NAME
	)		PARTICLE_PERF_STAT_CYCLES_COMMON(CONTEXT, GameThread, NAME)

PARTICLE_PERF_STAT_CYCLES_RT

#define PARTICLE_PERF_STAT_CYCLES_RT	(		CONTEXT,
			NAME
	)		PARTICLE_PERF_STAT_CYCLES_COMMON(CONTEXT, RenderThread, NAME)

PARTICLE_PERF_STAT_CYCLES_WITH_COUNT_COMMON

#define PARTICLE_PERF_STAT_CYCLES_WITH_COUNT_COMMON	(		CONTEXT,
			THREAD,
			NAME,
			COUNT
	)

Value:

struct FParticlePerfStatsWriterCyclesAndCount_##THREAD##_##NAME\
{\
    inline static void Write(FParticlePerfStats* Stats, uint64 Cycles, int32 Count)\
    {\
		if(Stats)\
        {\
            Stats->Get##THREAD##Stats().NAME##Cycles += Cycles; \
            Stats->Get##THREAD##Stats().NumInstances += Count; \
        }\
    }\
};\
FParticlePerfStatScope<FParticlePerfStatsWriterCyclesAndCount_##THREAD##_##NAME> ANONYMOUS_VARIABLE(ParticlePerfStatScope##THREAD##NAME)(CONTEXT, COUNT);

PARTICLE_PERF_STAT_CYCLES_WITH_COUNT_GT

#define PARTICLE_PERF_STAT_CYCLES_WITH_COUNT_GT	(		CONTEXT,
			NAME,
			COUNT
	)		PARTICLE_PERF_STAT_CYCLES_WITH_COUNT_COMMON(CONTEXT, GameThread, NAME, COUNT)

PARTICLE_PERF_STAT_CYCLES_WITH_COUNT_RT

#define PARTICLE_PERF_STAT_CYCLES_WITH_COUNT_RT	(		CONTEXT,
			NAME,
			COUNT
	)		PARTICLE_PERF_STAT_CYCLES_WITH_COUNT_COMMON(CONTEXT, RenderThread, NAME, COUNT)

WITH_GLOBAL_RUNTIME_FX_BUDGET

#define WITH_GLOBAL_RUNTIME_FX_BUDGET   (!UE_SERVER)

WITH_PARTICLE_PERF_CSV_STATS

#define WITH_PARTICLE_PERF_CSV_STATS   WITH_PER_SYSTEM_PARTICLE_PERF_STATS && CSV_PROFILER_STATS && !UE_BUILD_SHIPPING

WITH_PARTICLE_PERF_STATS

#define WITH_PARTICLE_PERF_STATS   1

WITH_PER_COMPONENT_PARTICLE_PERF_STATS

#define WITH_PER_COMPONENT_PARTICLE_PERF_STATS   (WITH_PARTICLE_PERF_STATS && !UE_BUILD_SHIPPING)

WITH_PER_SYSTEM_PARTICLE_PERF_STATS

#define WITH_PER_SYSTEM_PARTICLE_PERF_STATS   (WITH_PARTICLE_PERF_STATS && !UE_BUILD_SHIPPING)

Typedef Documentation

FParticlePerfStatsWriterFunc

typedef TFunction<void(FParticlePerfStats* Stats, uint64 Cycles)> FParticlePerfStatsWriterFunc

Function Documentation

CSV_DECLARE_CATEGORY_MODULE_EXTERN()

CSV_DECLARE_CATEGORY_MODULE_EXTERN	(	ENGINE_API	,
		Particles
	)