Skip to content

docs: correct encoder API documentation - #450

Open
gregbenz wants to merge 1 commit into
google:mainfrom
gregbenz:codex/correct-output-format-api-docs
Open

docs: correct encoder API documentation#450
gregbenz wants to merge 1 commit into
google:mainfrom
gregbenz:codex/correct-output-format-api-docs

Conversation

@gregbenz

Copy link
Copy Markdown
Contributor

What changed

  • Document that JPEG output is always available and HEIF/AVIF output is build-dependent.
  • List the actual errors returned by uhdr_enc_set_output_format().
  • Correct the compressed-input examples and clarify that HEIF/AVIF currently support raw API-0 and API-1 only.

Why

The public header did not match the implementation: it described JPEG as the only output format while also implying compressed HDR and HEIF/AVIF transcoding workflows that are not supported. Accurate API documentation helps callers select valid inputs and handle unsupported formats correctly.

Testing

  • Verified the documentation against the encoder setter and JPEG/HEIF/AVIF dispatch paths.
  • git diff --check

@google-cla

google-cla Bot commented Aug 15, 2026

Copy link
Copy Markdown

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

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