Support overlays - #820
Merged
Merged
Conversation
Enet4
added
enhancement
A-lib
Enet4
reviewed
Aug 13, 2026
Enet4
left a comment
Enet4
left a comment
Owner
There was a problem hiding this comment.
Thank you for working on this, it looks solid and extensive! I wasn't even expecting support for legacy overlay planes embedded in the pixel data, but we might as well keep it. 😅
I would only like for the overlay error reason field to be refactored (more details inline) before we get this upstream.
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
2 participants
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.
This PR adds 2 new functions to the
PixelDecodertrait:decode_overlays: This decodes all OverlayPlanes present in the file as vecdecode_overlay: This decodes a single OverlayPlane by it's indexThere's currently one default implementation in
overlay.rs, which is used by all PixelDecoder implementationsAdditionally i added support to the
toimagecrate, with the following options:overlays: A toggle to enable overlay burnins (defaults to false)overlay-color: A repeating argument which can be used to change the default overlay color (default is white)overlay-file: If overlays stored in a separate file (presentation state) these can be passed hereThis closes #818