tp::BaseQuery class

Base class implementing the shared functionality of device queries.

Derived classes

class RenderQuery: Query for measuring some statistic over a range of render commands.
class TimestampQuery: Query for measuring execution time on the device timeline.

Public functions

void clear(): Throws away all previous results.
auto getJobResult(const JobSemaphore& jobSemaphore) const -> QueryResult: Returns the result written during the execution of the given job, or a null result if not available. By default, any result older than the last result may be forgotten at any point. Use tp::BaseQuery::setMaxHistorySize to set the number of past results that should be stored and retrievable through this method.
auto getLastResult() const -> QueryResult: Returns the last (largest timestamp) result written for this query, or a null result if none are available.
auto isNull() const -> bool: Returns true if the query is null and not valid for use.
void setMaxHistorySize(uint32_t size): Sets the maximum number of past stored results that can be retrieved with tp::BaseQuery::getJobResult.

Function documentation

void tp::BaseQuery::clear()

Throws away all previous results.

QueryResult tp::BaseQuery::getJobResult(const JobSemaphore& jobSemaphore) const

Returns the result written during the execution of the given job, or a null result if not available. By default, any result older than the last result may be forgotten at any point. Use tp::BaseQuery::setMaxHistorySize to set the number of past results that should be stored and retrievable through this method.

Parameters
jobSemaphore	The semaphore that identifies the job for which a result should be retrieved.

void tp::BaseQuery::setMaxHistorySize(uint32_t size)

Sets the maximum number of past stored results that can be retrieved with tp::BaseQuery::getJobResult.