Performance counters for render modes. More...
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... |
|
Additional Inherited Members | |
Public Types inherited from mi::base::Interface_declare< 0x4a939dfe, 0xf4de, 0x44a4, 0x98, 0x3f, 0x2e, 0xaa, 0x99, 0x3c, 0x33, 0x4e > | |
typedef Interface_declare< id1, id2, id3, id4, id5, id6, id7, id8, id9, id10, id11, IInterface > |
Self |
Own type. More... |
|
typedef Uuid_t< id1, id2, id3, id4, id5, id6, id7, id8, id9, id10, id11 > |
IID |
Declares the interface ID (IID) of this interface. More... |
|
Static Public Member Functions inherited from mi::base::Interface_declare< 0x4a939dfe, 0xf4de, 0x44a4, 0x98, 0x3f, 0x2e, 0xaa, 0x99, 0x3c, 0x33, 0x4e > | |
static bool | compare_iid (const Uuid &iid) |
Compares the interface ID iid against the interface ID of this interface and of its ancestors. More... |
|
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.
|
pure virtual |
Returns the description for a given key.
key | The key for which the description shall be returned. |
key
.
|
pure virtual |
Returns a subkey for a given key.
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. |
NULL
in case of failure. Note that the returned value is actually the last path component of the subkey, not the complete subkey.
|
pure virtual |
Returns the number of subkeys of a key.
key | The key for which the number of subkeys shall be returned. The empty string can be used to retrieve the top-level subkeys. |
|
pure virtual |
Returns the unit of the value associated with a given key.
key | The key for which the unit of the associated value shall be returned. |
key
, or NULL
if there is no unit for this key.
|
pure virtual |
Returns the value associated with a given key.
key | The key for which the associated value shall be returned. |
value | The value associated with key . |
true
in case of success, false
in case of failure (e.g. the key is invalid).