gpu::Query Class Reference

#include <Query.h>

Collaboration diagram for gpu::Query:

Public Member Functions
	Query (const Handler &returnHandler, const std::string &name="gpu::query")
double	getGPUElapsedTime () const
double	getBatchElapsedTime () const
const std::string &	getName () const
void	triggerReturnHandler (uint64_t queryResult, uint64_t batchElapsedTime)
	Saves query results and calls the callback function. More...

Public Attributes
const GPUObjectPointer	gpuObject {}
	Only for gpu::Context.

Protected Attributes
Handler	_returnHandler
	Function to call when query results are available.
const std::string	_name
	Name of the query.
uint64_t	_queryResult { 0 }
	Query result - GPU elapsed time in nanoseconds.
uint64_t	_nsecBatchElapsedTime { 0 }
	Batch time elapsed in nanoseconds.

Detailed Description

Query is used for measuring performance on GPU side.

Constructor & Destructor Documentation

Query()

Query::Query	(	const Handler &	returnHandler,
		const std::string &	name = "gpu::query"
	)

Parameters

returnHandler	Function that is called when the query readout is ready.
name	Name of the query.

Member Function Documentation

getBatchElapsedTime()

double Query::getBatchElapsedTime

(

)

const

Batch time is time measured between do_beginQuery and do_endQuery measured when the batch is executed.

Returns

Batch elapsed time in milliseconds.

getGPUElapsedTime()

double Query::getGPUElapsedTime

(

)

const

Returns

GPU elapsed time in milliseconds.

getName()

const std::string& gpu::Query::getName ( ) const

inline

Returns

Name of the query.

triggerReturnHandler()

void Query::triggerReturnHandler	(	uint64_t	queryResult,
		uint64_t	batchElapsedTime
	)

Saves query results and calls the callback function.

Parameters

queryResult	GPU time in nanoseconds.
batchElapsedTime	Batch time in nanoseconds.

---

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

• Query.h
• Query.cpp