C
<outputverifier_capi.h> - Output Verifier C API
The <outputverifier_capi.h> header exposes a C API to enqueue display regions for verification and to retrieve CRC results produced by the display hardware. More...
| Header: | #include <outputverifier_capi.h> |
| Since: | QtSafeRenderer 2.2 |
is part of Qt Safe Monitor C API.
Functions
| void | OutputVerifier_addRegionForVerification(const RegionDefinition region) |
| void | OutputVerifier_destroyVerifierDevice() |
| RegionDefinition | OutputVerifier_getVerificationResult() |
| void | OutputVerifier_initVerifierDevice(const int xOffset, const int yOffset, const int width, const int height) |
| int | OutputVerifier_queueCount() |
| int | OutputVerifier_resultsCount() |
| void | OutputVerifier_verifyOutput() |
Detailed Description
The <outputverifier_capi.h> header exposes a C API to enqueue display regions for verification and to retrieve CRC results produced by the display hardware.
Function Documentation
void OutputVerifier_addRegionForVerification(const RegionDefinition region)
Enqueues region for output verification. The region identifies the item and state along with its rectangular coordinates. The input RegionDefinition::crc field is ignored on enqueue and populated by the verifier in results.
void OutputVerifier_destroyVerifierDevice()
Shuts down the verifier device and releases associated resources. Call after verification is no longer needed.
RegionDefinition OutputVerifier_getVerificationResult()
Retrieves the next verification result. Returns one RegionDefinition populated with the RegionDefinition::id, RegionDefinition::state, region coordinates, and the measured RegionDefinition::crc for that region. Invoke repeatedly up to OutputVerifier_resultsCount() times to consume all results for the last verification pass.
void OutputVerifier_initVerifierDevice(const int xOffset, const int yOffset, const int width, const int height)
Initializes the verifier device and defines the display area coordinates. Sets the top-left offsets (xOffset, yOffset) and dimensions (width, height) used as the reference frame for region coordinates. Call before queueing regions.
int OutputVerifier_queueCount()
Returns the number of regions currently queued for verification. Use to observe pending work before calling OutputVerifier_verifyOutput().
int OutputVerifier_resultsCount()
Returns the number of verification results available to read. Call after OutputVerifier_verifyOutput() to determine how many results can be retrieved.
void OutputVerifier_verifyOutput()
Triggers verification for all enqueued regions. Initiates reading the current CRC values from the display hardware for each queued region. After this call returns, verification results can be consumed via OutputVerifier_getVerificationResult().
Available under certain Qt licenses.
Find out more.