BRAY::Stats Class Reference

#include <BRAY_Stats.h>

Inheritance diagram for BRAY::Stats:

Classes
struct	AutoBucket
struct	Value

Public Types
enum	Key {   USERNAME, HOSTNAME, KARMA_VERSION, SYSTEM_THREADS,   SYSTEM_CPU_BRAND, SYSTEM_CPU_ARCHITECTURE, SYSTEM_MEMORY, SYSTEM_TIME,   SYSTEM_RESOURCE_USAGE, ENGINE, XPU_DEVICE_COUNT, RENDER_SETTINGS,   RENDER_CAMERA, DICING_CAMERA, RESOLUTION, WORLD_TO_CAMERA,   WORLD_TO_SCREEN, WORLD_TO_NDC, WORLD_TO_RASTER, CAMERA_NEAR_FAR,   AOV_BUFFERS, AOV_RASTER_MEMORY, UNIFIED_CACHE, TEXTURE_ERROR_FILES,   TEXTURE_CONVERSIONS, RAT_STATS, RAT_DISK_CACHE, RAT_DISK_CACHE_ERRORS,   OIIO_STATS, OIIO_STATS_STRING, PTEX_STATS, OBJECT_COUNTS,   GEOMETRY_COUNTS, LIGHT_TYPES, PRIMVAR_CACHE, PERCENT_COMPLETE,   RENDER_STAGE, RENDER_STAGE_LABEL, LOAD_TIME, LOAD_MEMORY,   TTFP, FILTER_ERRORS, SHADER_CALLS, SHADER_NODES,   RAY_COUNTS, TIMINGS, XPU_COMPILES, STOCHASTIC_DEPTH,   RAY_DEPTHS, RAY_DEPTHS_PERCENTAGE, RAY_BATCH_EFFICIENCY, CHECKPOINT_STATS,   ACTIVE_BUCKETS, PROGRESS_ANNOTATION, STATS_ANNOTATION, MAX_KEYS }
enum	DeviceKey {   DEVICE_LABEL, DEVICE_TYPE, DEVICE_STATUS, DEVICE_ERROR,   DEVICE_MEMORY, DEVICE_SAMPLES, DEVICE_CONTRIB, DEVICE_MAX_KEYS }

Public Member Functions
	Stats (const BRAY_Renderer &renderer)
	~Stats ()
BRAY_RenderStage	renderStage () const
	Lightweight method to get the render stage. More...
fpreal	percentComplete () const
	Lightweight method to get the percent complete (between 0 and 100) More...
Value	get (Key key) const
	Get the value of the stat. More...
Value	get (DeviceKey key, int device) const
	Get the value of the device stat. More...
void	initDevices ()
void	clear ()
	Clear for next render. More...

Static Public Member Functions
static const UT_StringHolder &	keyName (Key key)
static const UT_StringHolder &	deviceKeyName (DeviceKey key)
void	setPercentDone (fpreal v)
void	setTTFP (fpreal v)
void	setProgressAnnotation (const UT_StringHolder &s)
void	setStatsAnnotation (const UT_StringHolder &s)
void	setAnnotations (const UT_StringHolder &progress_annotation, const UT_StringHolder &stats_annotation)
void	startBucket (const UT_DimRect &bounds, int pass)
void	endBucket ()

Detailed Description

Definition at line 28 of file BRAY_Stats.h.

Member Enumeration Documentation

enum BRAY::Stats::DeviceKey

Enumerator
DEVICE_LABEL
DEVICE_TYPE
DEVICE_STATUS
DEVICE_ERROR
DEVICE_MEMORY
DEVICE_SAMPLES
DEVICE_CONTRIB
DEVICE_MAX_KEYS

Definition at line 124 of file BRAY_Stats.h.

enum BRAY::Stats::Key

Enumerator
USERNAME
HOSTNAME
KARMA_VERSION
SYSTEM_THREADS
SYSTEM_CPU_BRAND
SYSTEM_CPU_ARCHITECTURE
SYSTEM_MEMORY
SYSTEM_TIME
SYSTEM_RESOURCE_USAGE
ENGINE
XPU_DEVICE_COUNT
RENDER_SETTINGS
RENDER_CAMERA
DICING_CAMERA
RESOLUTION
WORLD_TO_CAMERA
WORLD_TO_SCREEN
WORLD_TO_NDC
WORLD_TO_RASTER
CAMERA_NEAR_FAR
AOV_BUFFERS
AOV_RASTER_MEMORY
UNIFIED_CACHE
TEXTURE_ERROR_FILES
TEXTURE_CONVERSIONS
RAT_STATS
RAT_DISK_CACHE
RAT_DISK_CACHE_ERRORS
OIIO_STATS
OIIO_STATS_STRING
PTEX_STATS
OBJECT_COUNTS
GEOMETRY_COUNTS
LIGHT_TYPES
PRIMVAR_CACHE
PERCENT_COMPLETE
RENDER_STAGE
RENDER_STAGE_LABEL
LOAD_TIME
LOAD_MEMORY
TTFP
FILTER_ERRORS
SHADER_CALLS
SHADER_NODES
RAY_COUNTS
TIMINGS
XPU_COMPILES
STOCHASTIC_DEPTH
RAY_DEPTHS
RAY_DEPTHS_PERCENTAGE
RAY_BATCH_EFFICIENCY
CHECKPOINT_STATS
ACTIVE_BUCKETS
PROGRESS_ANNOTATION
STATS_ANNOTATION
MAX_KEYS

Definition at line 35 of file BRAY_Stats.h.

Constructor & Destructor Documentation

BRAY::Stats::Stats

(

const BRAY_Renderer &

renderer

)

BRAY::Stats::~Stats

(

)

Member Function Documentation

void BRAY::Stats::clear

(

)

Clear for next render.

static const UT_StringHolder& BRAY::Stats::deviceKeyName ( DeviceKey  key )

static

void BRAY::Stats::endBucket

(

)

• methods used by the renderer to update stats during rendering

Value BRAY::Stats::get ( Key  key ) const

inline

Get the value of the stat.

Definition at line 172 of file BRAY_Stats.h.

Value BRAY::Stats::get ( DeviceKey  key, int  device  ) const

inline

Get the value of the device stat.

Definition at line 176 of file BRAY_Stats.h.

void BRAY::Stats::initDevices

(

)

After XPU devices are initialized, call this method to configure the stats.

static const UT_StringHolder& BRAY::Stats::keyName ( Key  key )

static

fpreal BRAY::Stats::percentComplete

(

)

const

Lightweight method to get the percent complete (between 0 and 100)

BRAY_RenderStage BRAY::Stats::renderStage

(

)

const

Lightweight method to get the render stage.

void BRAY::Stats::setAnnotations	(	const UT_StringHolder &	progress_annotation,
		const UT_StringHolder &	stats_annotation
	)

• methods used by the renderer to update stats during rendering

void BRAY::Stats::setPercentDone

(

fpreal

v

)

• methods used by the renderer to update stats during rendering

void BRAY::Stats::setProgressAnnotation

(

const UT_StringHolder &

s

)

• methods used by the renderer to update stats during rendering

void BRAY::Stats::setStatsAnnotation

(

const UT_StringHolder &

s

)

• methods used by the renderer to update stats during rendering

void BRAY::Stats::setTTFP

(

fpreal

v

)

• methods used by the renderer to update stats during rendering

void BRAY::Stats::startBucket	(	const UT_DimRect &	bounds,
		int	pass
	)

• methods used by the renderer to update stats during rendering

---

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

• BRAY/BRAY_Stats.h