Performance counters for render modes. More...

#include <irender_counters.h>

Inheritance diagram for mi::neuraylib::IRender_counters:

Public Member Functions
virtual bool	get_value (const char *key, Float64 &value) const =0
	Returns the value associated with a given key. More...

virtual const char *	get_unit (const char *key) const =0
	Returns the unit of the value associated with a given key. More...

virtual const char *	get_description (const char *key) const =0
	Returns the description for a given key. More...

virtual Size	get_subkeys_size (const char *key) const =0
	Returns the number of subkeys of a key. More...

virtual const char *	get_subkey (const char *key, Size index) const =0
	Returns a subkey for a given key. More...

Public Member Functions inherited from mi::base::IInterface
virtual Uint32	retain () const =0
	Increments the reference count. More...

virtual Uint32	release () const =0
	Decrements the reference count. More...

virtual const IInterface *	get_interface (const Uuid &interface_id) const =0
	Acquires a const interface from another. More...

template<class T>
const T *	get_interface () const
	Acquires a const interface from another. More...

virtual IInterface *	get_interface (const Uuid &interface_id)=0
	Acquires a mutable interface from another. More...

template<class T>
T *	get_interface ()
	Acquires a mutable interface from another. More...

virtual Uuid	get_iid () const =0
	Returns the interface ID of the most derived interface. More...

Additional Inherited Members
Public Types inherited from mi::base::Interface_declare< 0x4a939dfe, ... >
using	Self = Interface_declare< id1, ... >
	Own type. More...

using	IID = Uuid_t< id1, ... >
	Declares the interface ID (IID) of this interface. More...

Public Types inherited from mi::base::IInterface
using	IID = Uuid_t<0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0>
	Declares the interface ID (IID) of this interface. More...

Static Public Member Functions inherited from mi::base::Interface_declare< 0x4a939dfe, ... >
static bool	compare_iid (const Uuid &iid)
	Compares the interface ID `iid` against the interface ID of this interface and of its ancestors. More...

Static Public Member Functions inherited from mi::base::IInterface
static bool	compare_iid (const Uuid &iid)
	Compares the interface ID `iid` against the interface ID of this interface. More...

Detailed Description

Performance counters for render modes.

Render modes can be instrumented with various counters to measure performance. These counters are organized in a hierarchical fashion. This interface supports the discovery of existing counters and their hierarchy, as well as the retrieval of counter values.

Each counter is identified by a string key. The key describes the path in the hierarchy. A path consists of names delimited by a dot, e.g., "textures.nb_objs". The empty string represents the root of the hierarchy, a delimiter is not necessary here, i.e., "textures" would be a valid key just below the root, not ".textures".

Note that the counter hierarchy is not required to be stable.

Member Function Documentation

^◆ get_description()

virtual const char * mi::neuraylib::IRender_counters::get_description ( const char * key ) const

pure virtual

Returns the description for a given key.

Parameters

key	The key for which the description shall be returned.

Returns: A description of the meaning of the key key.

^◆ get_subkey()

virtual const char * mi::neuraylib::IRender_counters::get_subkey	(	const char *	key,
		Size	index
	)		const

pure virtual

Returns a subkey for a given key.

Parameters

key	The key for which a particular subkey shall be returned. The empty string can be used to retrieve the top-level subkeys.
index	The index of the subkey in question. The valid index range is from 0 to get_subkeys_size() - 1.

Returns: The requested subkey, or nullptr in case of failure. Note that the returned value is actually the last path component of the subkey, not the complete subkey.

^◆ get_subkeys_size()

virtual Size mi::neuraylib::IRender_counters::get_subkeys_size ( const char * key ) const

pure virtual

Returns the number of subkeys of a key.

Parameters

key	The key for which the number of subkeys shall be returned. The empty string can be used to retrieve the top-level subkeys.

Returns: The number of subkeys this key has.

^◆ get_unit()

virtual const char * mi::neuraylib::IRender_counters::get_unit ( const char * key ) const

pure virtual

Returns the unit of the value associated with a given key.

Parameters

key	The key for which the unit of the associated value shall be returned.

Returns: The unit of the value associated with key, or nullptr if there is no unit for this key.

^◆ get_value()

virtual bool mi::neuraylib::IRender_counters::get_value	(	const char *	key,
		Float64 &	value
	)		const

pure virtual

Returns the value associated with a given key.

Parameters

key	The key for which the associated value shall be returned.
value	The value associated with `key`.

Returns: true in case of success, false in case of failure (e.g. the key is invalid).

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ get_description()

◆ get_subkey()

◆ get_subkeys_size()

◆ get_unit()

◆ get_value()

^◆ get_description()

^◆ get_subkey()

^◆ get_subkeys_size()

^◆ get_unit()

^◆ get_value()