Improve deinterleave API documentation - #362
Merged
Merged
Conversation
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>
Contributor
There was a problem hiding this comment.
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 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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
SimdDeinterleaveUv,SimdDeinterleaveBgr, andSimdDeinterleaveBgradocumentation to reflect per-channel extraction and nullable output planes.Testing
git diff --check HEAD~1..HEADgit status --short --branch