Skip to content

Improve deinterleave API documentation - #362

Merged
ermig1979 merged 5 commits into
masterfrom
cursor/improve-deinterleave-docs-31cc
Jun 3, 2026
Merged

Improve deinterleave API documentation#362
ermig1979 merged 5 commits into
masterfrom
cursor/improve-deinterleave-docs-31cc

Conversation

@ermig1979

@ermig1979 ermig1979 commented Jun 3, 2026

Copy link
Copy Markdown
Owner

Summary

  • Clarify SimdDeinterleaveUv, SimdDeinterleaveBgr, and SimdDeinterleaveBgra documentation to reflect per-channel extraction and nullable output planes.
  • Clarify detection loader, info, init, prepare, and detect function documentation to reflect supported cascade formats, context lifetime, integral image requirements, scan modes, and output semantics.
  • Clarify drawing and fill function documentation to reflect clipping, frame boundaries, pixel layout, row padding, and zero-fill behavior.
  • Clarify bfloat16/float16 conversion and font API documentation to reflect bit-format conversion, font context lifecycle, resize behavior, measurement, and clipped alpha drawing.
  • Clarify 16-bit float distance/norm and float32/uint8 conversion documentation to reflect accumulation precision, layouts, output ordering, bounds, scaling, and saturation behavior.

Testing

  • git diff --check HEAD~1..HEAD
  • git status --short --branch
  • Not run: build or test suite, per request for the documentation tasks.
Open in Web Open in Cursor 

cursoragent and others added 5 commits June 3, 2026 12:10
Co-authored-by: Ihar Yermalayeu <ermig@tut.by>
Co-authored-by: Ihar Yermalayeu <ermig@tut.by>
Co-authored-by: Ihar Yermalayeu <ermig@tut.by>
Co-authored-by: Ihar Yermalayeu <ermig@tut.by>
Co-authored-by: Ihar Yermalayeu <ermig@tut.by>
@ermig1979
ermig1979 marked this pull request as ready for review June 3, 2026 13:44
Copilot AI review requested due to automatic review settings June 3, 2026 13:44

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR refines public C API documentation in SimdLib.h, primarily clarifying behavior and usage constraints for deinterleave, object-detection, drawing/filling, font, and numeric conversion helpers.

Changes:

  • Document nullable output planes and per-channel extraction semantics for UV/BGR/BGRA deinterleave APIs.
  • Expand object detection cascade loader/init/prepare/detect documentation (supported cascade formats, integral image requirements, scan modes, and output semantics).
  • Clarify drawing/fill/font and float conversion function documentation (clipping, padding behavior, scaling/saturation, and context lifecycle).

Comment thread src/Simd/SimdLib.h
Comment on lines +3223 to +3227
If throughColumn is non-zero, the context is prepared for the interlaced detection functions
(*32fi and *16ii), which scan every second row and column. If int16 is non-zero and the loaded
LBP cascade has ::SimdDetectionInfoCanInt16, the context uses a 16-bit integer LBP representation
and must be used with *16ip or *16ii detection functions. Otherwise LBP detection uses 32-bit
integral sums and must be used with *32fp or *32fi detection functions.
@ermig1979
ermig1979 merged commit 740211c into master Jun 3, 2026
23 of 25 checks passed
@ermig1979
ermig1979 deleted the cursor/improve-deinterleave-docs-31cc branch July 1, 2026 11:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants