Skip to content

Improve Bgr/Binarization/Conditional function descriptions in SimdLib.hpp - #818

Merged
ermig1979 merged 1 commit into
devfrom
cursor/improve-bgr-binarization-docs-fa6a
Aug 4, 2026
Merged

Improve Bgr/Binarization/Conditional function descriptions in SimdLib.hpp#818
ermig1979 merged 1 commit into
devfrom
cursor/improve-bgr-binarization-docs-fa6a

Conversation

@ermig1979

Copy link
Copy Markdown
Owner

Summary

Align C++ wrapper Doxygen descriptions in SimdLib.hpp with the improved C API wording in SimdLib.h for BGR conversion, binarization, and conditional helpers, and record the updates in release 7.2.165 notes.

Improved functions

  • Simd::BgrToBayer, Simd::BgrToBgra, Simd::Bgr48pToBgra32, Simd::BgrToGray
  • Simd::BgrToHsl, Simd::BgrToHsv, Simd::BgrToLab, Simd::BgrToRgb, Simd::BgrToRgba
  • Simd::BgrToYuv420p, Simd::BgrToYuv422p, Simd::BgrToYuv444p
  • Simd::Binarization, Simd::AveragingBinarization, Simd::AveragingBinarizationV2
  • Simd::ConditionalCount8u, Simd::ConditionalCount16i, Simd::ConditionalSum, Simd::ConditionalSquareSum

Notable doc fixes

  • Corrected default alpha description (0xFF, not 256) for BgrToBgra, Bgr48pToBgra32, and BgrToRgba.
  • Fixed neighborhood formula index typo (y + dy instead of x + dy) in averaging binarization docs.
  • Clarified YUV chroma subsampling behavior and that yuvType describes the output YUV type.
  • Clarified Conditional* output parameter semantics (references, zero-initialized accumulation).

Files

  • src/Simd/SimdLib.hpp — documentation only
  • docs/2026.html — release 7.2.165 Documentation/Improving entries

No test suite run (documentation-only change, as requested).

Open in Web Open in Cursor 

….hpp

Align C++ wrapper Doxygen docs with implementation behavior and the
improved C API wording, and record the changes in release 7.2.165 notes.

Co-authored-by: Ihar Yermalayeu <igor.ermolaev@altezza.org>
@ermig1979
ermig1979 marked this pull request as ready for review August 4, 2026 12:14
@ermig1979
ermig1979 merged commit 9c29687 into dev Aug 4, 2026
1 check passed
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.

2 participants