Add description of decoding error status for vaSyncSurface()

this will indicate APP behavior when meet VA_STATUS_ERROR_DECODING_ERROR from vaSyncSurface Signed-off-by: Pengxin Yuan <[email protected]>
intel · Nov 27, 2023 · 36407ae · 36407ae
1 parent 0931342
commit 36407ae
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/va/va.h b/va/va.h
@@ -4187,6 +4187,12 @@ Synchronization
  * This function blocks until all pending operations on the render target
  * have been completed.  Upon return it is safe to use the render target for a
  * different picture.
+ *
+ * Possible errors:
+ * - \ref VA_STATUS_ERROR_DECODING_ERROR: This error is triggered when encountering
+ *   Macroblock (MB) errors with non-conformance input clips during the decoding process.
+ *   Application can proceed with the subsequent frames, it is advised that the application
+ *   be aware of potential corruption in the output.
  */
 VAStatus vaSyncSurface(
     VADisplay dpy,