PxCutoutFlag Enumeration

typedef enum { ... } PxCutoutFlag;

Bit flags describing the state of the currently detected document cutout, combined into the value returned by PxFrameObserver’s observe: methods.

Enumeration Cases

NameSummary
PxCutoutFlag_CutoutStableThe detected corners are stable — it is safe to capture.
PxCutoutFlag_DefinedA document cutout was detected in the frame.
PxCutoutFlag_DistortionCheckedThe document is not too distorted (the distortion check passed).
PxCutoutFlag_FullnessCheckedThe document fills enough of the frame (the fullness check passed).
PxCutoutFlag_PausedDetection is paused (for example, during the grace period between pages).
Top