mirrors/libfprint
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/libfprint/libfprint.git synced 2025-11-15 07:38:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

fpi-device: Clarify identify prints gallery usage in drivers docs

Browse Source
This commit is contained in:
Marco Trevisan (Treviño)
2022-07-15 22:51:11 +02:00
parent 70dc61d647
commit 4012a4fe6f
1 changed files with 27 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
libfprint/fpi-device.c
View File

@@ -622,7 +622,14 @@ fpi_device_get_verify_data (FpDevice *device,
* @device: The #FpDevice * @device: The #FpDevice
* @prints: (out) (transfer none) (element-type FpPrint): The gallery of prints * @prints: (out) (transfer none) (element-type FpPrint): The gallery of prints
* *
* Get data for identify. * Get prints gallery for identification.
*
* The @prints array is always non-%NULL and may contain a list of #FpPrint's
* that the device should match against.
*
* Note that @prints can be an empty array, in such case the device is expected
* to report the scanned print matching the one in its internal storage, if any.
*
*/ */
void void
fpi_device_get_identify_data (FpDevice *device, fpi_device_get_identify_data (FpDevice *device,
@@ -2009,12 +2016,26 @@ fpi_device_verify_report (FpDevice *device,
* fpi_device_identify_report: * fpi_device_identify_report:
* @device: The #FpDevice * @device: The #FpDevice
* @match: (transfer none): The #FpPrint from the gallery that matched * @match: (transfer none): The #FpPrint from the gallery that matched
* @print: (transfer floating): The scanned #FpPrint * @print: (transfer floating): The scanned #FpPrint, set in the absence
* @error: A #GError if result is %FPI_MATCH_ERROR * of an error.
* @error: A #GError of %FP_DEVICE_RETRY type if @match and @print are unset.
* *
* Report the result of a identify operation. Note that the passed @error must be * Report the results of an identify operation.
* a retry error with the %FP_DEVICE_RETRY domain. For all other error cases, *
* the error should passed to fpi_device_identify_complete(). * In case of successful identification @match is expected to be set to a
* #FpPrint that matches one from the provided gallery, while @print
* represents the scanned print and will be different.
*
* If there are no errors, it's expected that the device always reports the
* recognized @print even if there is no @match with the provided gallery (that
* can be potentially empty). This is required for application logic further
* up in the stack, such as for enroll-duplicate checking. @print needs to be
* sufficiently filled to do a comparison.
*
* In case of error, both @match and @print are expected to be %NULL.
* Note that the passed @error must be a retry error from the %FP_DEVICE_RETRY
* domain. For all other error cases, the error should passed to
* fpi_device_identify_complete().
*/ */
void void
fpi_device_identify_report (FpDevice *device, fpi_device_identify_report (FpDevice *device,