libCZI::ISubBlockCacheStatistics Class Reference

This interface defines how status information about the cache-state can be queried. More...

#include <libCZI_Compositor.h>

Inheritance diagram for libCZI::ISubBlockCacheStatistics:

Classes
struct	Statistics

Public Member Functions
virtual Statistics	GetStatistics (std::uint8_t mask) const =0
	ISubBlockCacheStatistics (const ISubBlockCacheStatistics &)=delete
ISubBlockCacheStatistics &	operator= (const ISubBlockCacheStatistics &)=delete
	ISubBlockCacheStatistics (ISubBlockCacheStatistics &&) noexcept=delete
ISubBlockCacheStatistics &	operator= (ISubBlockCacheStatistics &&) noexcept=delete

Static Public Attributes
static constexpr std::uint8_t	kMemoryUsage = 1
	Bit-mask identifying the memory-usage field in the statistics struct.
static constexpr std::uint8_t	kElementsCount = 2
	Bit-mask identifying the elements-count field in the statistics struct.

Detailed Description

This interface defines how status information about the cache-state can be queried.

Member Function Documentation

GetStatistics()

virtual Statistics libCZI::ISubBlockCacheStatistics::GetStatistics ( std::uint8_t  mask ) const

pure virtual

Gets momentarily valid statistics about the cache. The mask defines which statistic/s is/are to be retrieved. In case of multiple fields being requested, it is guaranteed that all requested fields are a transactional snapshot of the state.

Parameters

mask	A bitmask specifying which fields are requested. Only the fields requested are guaranteed to be valid in the returned struct.

Returns

A consistent snapshot of the statistics.

---

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

• libCZI/libCZI_Compositor.h