vkCompViz App
 
Loading...
Searching...
No Matches
Classes | Public Member Functions | Public Attributes | List of all members
Gpu::Gpu::BenchmarkReport Class Referenceexport
module gpu

Reports detailed benchmark statistics for GPU computation and rendering. More...

Collaboration diagram for Gpu::Gpu::BenchmarkReport:
Collaboration graph
[legend]

Classes

class  Times
 Timing data for different GPU operations in milliseconds. More...
 

Public Member Functions

float computeTime () const
 Returns total compute time in milliseconds.
 
float memoryTime () const
 Returns total memory transfer time in milliseconds.
 
float totalTime (bool includeDraw=false) const
 Returns total time including compute and optionally draw time in milliseconds.
 
std::string toString () const
 Returns a string representation of the benchmark report.
 
void print () const
 Prints the benchmark report to the console.
 
void store (std::string path) const
 Saves the benchmark report to the specified file path.
 

Public Attributes

std::size_t inFlightFrames {1}
 Number of in-flight frames during benchmarking.
 
class Gpu::Gpu::BenchmarkReport::Times times
 
float usedMemory {0}
 Amount of GPU memory used in bytes.
 

Detailed Description

Reports detailed benchmark statistics for GPU computation and rendering.

Member Function Documentation

◆ computeTime()

float Gpu::Gpu::BenchmarkReport::computeTime ( ) const
export

Returns total compute time in milliseconds.

Returns
Compute time.

◆ memoryTime()

float Gpu::Gpu::BenchmarkReport::memoryTime ( ) const
export

Returns total memory transfer time in milliseconds.

Returns
Memory transfer time.

◆ print()

void Gpu::Gpu::BenchmarkReport::print ( ) const
export

Prints the benchmark report to the console.

◆ store()

void Gpu::Gpu::BenchmarkReport::store ( std::string  path) const
export

Saves the benchmark report to the specified file path.

Parameters
pathFile path to save the report.

◆ toString()

std::string Gpu::Gpu::BenchmarkReport::toString ( ) const
export

Returns a string representation of the benchmark report.

Returns
String describing the benchmark data.

◆ totalTime()

float Gpu::Gpu::BenchmarkReport::totalTime ( bool  includeDraw = false) const
export

Returns total time including compute and optionally draw time in milliseconds.

Parameters
includeDrawWhether to include draw time in total.
Returns
Total elapsed time.

Member Data Documentation

◆ inFlightFrames

std::size_t Gpu::Gpu::BenchmarkReport::inFlightFrames {1}
export

Number of in-flight frames during benchmarking.

◆ times

class Gpu::Gpu::BenchmarkReport::Times Gpu::Gpu::BenchmarkReport::times

◆ usedMemory

float Gpu::Gpu::BenchmarkReport::usedMemory {0}
export

Amount of GPU memory used in bytes.