Skip to content

docs(cv_bridge): clarify encodings supported by conversion APIs - #569

Open
Functionhx wants to merge 1 commit into
ros-perception:rollingfrom
Functionhx:fix/doxygen-encoding-docs
Open

docs(cv_bridge): clarify encodings supported by conversion APIs#569
Functionhx wants to merge 1 commit into
ros-perception:rollingfrom
Functionhx:fix/doxygen-encoding-docs

Conversation

@Functionhx

@Functionhx Functionhx commented Jul 12, 2026

Copy link
Copy Markdown

The doxygen for toCvCopy and toCvShare presented encodings as an exhaustive list of six strings, but cv_bridge supports generic encodings of the form C. Update docs to reflect this. Fixes #554.

@mergify

mergify Bot commented Jul 12, 2026

Copy link
Copy Markdown

Tick the box to add this pull request to the merge queue (same as @mergifyio queue).

  • Queue this pull request

@Functionhx
Functionhx force-pushed the fix/doxygen-encoding-docs branch 2 times, most recently from 74a5998 to 9519751 Compare July 12, 2026 04:07
@Functionhx Functionhx changed the title docs(cv_bridge): note additional supported encodings in toCvCopy doxygen docs(cv_bridge): clarify encodings supported by conversion APIs Jul 12, 2026
The doxygen for toCvCopy and toCvShare listed only 6 encoding strings as
exhaustive options (mono8, bgr8, bgra8, rgb8, rgba8, mono16), but the
implementation actually supports many more OpenCV-compatible formats
(e.g., 32FC1, 16SC1). Update the docs to present these as common examples
and note that additional encodings are supported.

Fixes ros-perception#554

Signed-off-by: Functionhx <2994114386@qq.com>
@Functionhx
Functionhx force-pushed the fix/doxygen-encoding-docs branch from 9519751 to 0287099 Compare July 12, 2026 04:25
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.

ToCvCopy doxygen comments don't mention all allowed formats

1 participant