Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

class Enlighten::EnlightenProfile

A container for Enlighten runtime profile statistics.

...

NameDescription
DumpCubeMapStatsToStream(Geo::IGeoStream &)

Writes some summary stats (average etc.) for all Enlighten cube maps.

DumpCurrentStatsToStream(Geo::IGeoStream &)

Writes the set of most recently recorded stats.

DumpHeaderToStream(Geo::IGeoStream &)

Writes a small header containing the description (see SetDescription).

DumpProbeSetStatsToStream(Geo::IGeoStream &)

Writes some summary stats (average etc.) for all Enlighten probe sets.

DumpSystemStatsToStream(Geo::IGeoStream &)

Writes some summary stats (average etc.) for all Enlighten systems.

DumpToStream(Geo::IGeoStream &)

Writes the header, current stats and system stats to the given stream.

GetAggregateProfile()

Read-only access to profile data.

GetCubeMapProfileAtIdx(Geo::s32)

Get a cube map at the specified index.

GetCubeMapProfileAtIdx(Geo::s32)

Get a cube map at the specified index.

GetCubeMapProfileFromGuid(const Geo::GeoGuid &)

Get a cube map from a given guid.

GetDescription()

Gets/sets the profile description which is written in the header in DumpHeaderToStream.

GetNumCubeMaps()

Get number of recorded cube maps Calls to this should be surrounded in a Lock/Unlock pair.

GetNumProbeSets()

Get number of recorded probe sets.

GetNumSystems()

Get number of recorded systems.

GetProbeSetProfileAtIdx(Geo::s32)

Get a probe set at the specified index.

GetProbeSetProfileAtIdx(Geo::s32)

Get a probe set at the specified index.

GetProbeSetProfileFromGuid(const Geo::GeoGuid &)

Get a probe set from a given guid.

GetSystemProfileAtIdx(Geo::s32)

Get a system at the specified index.

GetSystemProfileAtIdx(Geo::s32)

Read-only access to profile data.

GetSystemProfileFromGuid(const Geo::GeoGuid &)

Get a system from a given guid.

Lock()

Multi-threaded access controls.

RecordAggregateProfileItem(AggregateProfileItem, double)

Record aggregate profile items.

RecordAggregateProfileItemUnsafe(AggregateProfileItem, double)

Record aggregate profile items.

RecordCubeMapItem(const Geo::GeoGuid &, CubeMapProfileItem, double)

Record a stat item for cube maps.

RecordEnlightenCpuTime(double)

Record a stat item for total enlighten cpu time.

RecordEnlightenCpuTimeUnsafe(double)

Record a stat item for total enlighten cpu time.

RecordEnlightenCubeMapTime(double)

Record a stat item for total enlighten cube map time.

RecordEnlightenCubeMapTimeUnsafe(double)

Record a stat item for total enlighten cube map time.

RecordEnlightenGpuTime(double)

Record a stat item for total enlighten gpu time.

RecordEnlightenGpuTimeUnsafe(double)

Record a stat item for total enlighten gpu time.

RecordEnlightenProbeInterpolationTime(double)

Record a stat item for total enlighten light probe interpolation time.

RecordEnlightenProbeInterpolationTimeUnsafe(double)

Record a stat item for total enlighten light probe interpolation time.

RecordEnlightenProbeSetTime(double)

Record a stat item for total enlighten light probe time (either cpu or gpu)

RecordEnlightenProbeSetTimeUnsafe(double)

Record a stat item for total enlighten light probe time (either cpu or gpu)

RecordProbeSetItem(const Geo::GeoGuid &, ProbeSetProfileItem, double)

Record a stat item for probes sets.

RecordSystemItem(const Geo::GeoGuid &, SystemProfileItem, double)

Stat recording functions.

RegisterCubeMap(const Geo::GeoGuid &)

Register HLRT objects with the profiler and returns their respective index.

RegisterProbeSet(const Geo::GeoGuid &)

Register HLRT objects with the profiler and returns their respective index.

RegisterSystem(const Geo::GeoGuid &)

Register HLRT objects with the profiler and returns their respective index.

Reset()

Reset all recorded stats. Also empties the arrays.

ResetHistory()

Reset the recorded stats.

SetDescription(ProfileDescription)

Gets/sets the profile description which is written in the header in DumpHeaderToStream.

Unlock()

Unlock access to the profile records.

...

Writes some summary stats (average etc.) for all Enlighten cube maps.


Anchor
af9a9857ee2988e4be0a674a4bedd83f0
af9a9857ee2988e4be0a674a4bedd83f0

...

Writes some summary stats (average etc.) for all Enlighten probe sets.


Anchor
ab99d8e15cf56c836bfdaad1b93558e09
ab99d8e15cf56c836bfdaad1b93558e09

...

Writes some summary stats (average etc.) for all Enlighten systems.


Anchor
a860e9b98b526cc7374ed4b4d417562b4
a860e9b98b526cc7374ed4b4d417562b4

...