Improve YUV conversion API docs - #377
Merged
Merged
Conversation
Co-authored-by: Ihar Yermalayeu <ermig1979@gmail.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR improves the public API documentation for YUV/YUVA conversion routines (and related helpers) in SimdLib.h, clarifying plane sizing/subsampling constraints, alpha handling, and packed UYVY byte order, and records these documentation updates in the 2026 release notes.
Changes:
- Expanded/clarified
SimdLib.hDoxygen docs forSimdYToGrayand multiple YUV/YUVA conversion functions (subsampling rules, even-dimension constraints, alpha behavior, and hue/HSL/HSV conversion details). - Documented UYVY422 byte layout for
SimdYuv420pToUyvy422. - Added corresponding “Improving” entries to
docs/2026.html.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/Simd/SimdLib.h | Updates Doxygen API docs for YUV/YUVA conversion functions (constraints, ranges, layouts). |
| docs/2026.html | Adds 2026 release-note bullets for the documentation improvements. |
Comment on lines
+11263
to
11265
| The Y values are treated as studio-range luma [16..235] and converted to full-range gray [0..255]. | ||
|
|
||
| \note This function has C++ wrappers: Simd::YToGray(const View& y, View& gray). |
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
SimdLib.hdescriptions forSimdYToGrayand the listed YUVA/YUV conversion functions.Testing
git diff --checkand confirmed the diff is whitespace-clean.docs/2026.htmlandsrc/Simd/SimdLib.hchanged.