Skip to content

docs: image support marked as completed#1008

Merged
daveallie merged 1 commit intocrosspoint-reader:masterfrom
ariel-lindemann:docs/image_support
Feb 20, 2026
Merged

docs: image support marked as completed#1008
daveallie merged 1 commit intocrosspoint-reader:masterfrom
ariel-lindemann:docs/image_support

Conversation

@ariel-lindemann
Copy link
Contributor

@ariel-lindemann ariel-lindemann commented Feb 19, 2026

Summary

  • What is the goal of this PR? (e.g., Implements the new feature for file uploading.)

Epub image support was added in #556. The goal of this PR is to document that in the readme.

  • What changes are included?

Only the checkmark in the readme.

Additional Context

  • Add any other information that might be helpful for the reviewer (e.g., performance implications, potential risks,
    specific areas to focus on).

AI Usage

While CrossPoint doesn't have restrictions on AI tools in contributing, please be transparent about their usage as it
helps set the right context for reviewers.

Did you use AI tools to help write this code? < NO >

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 19, 2026 •
edited
Loading

No actionable comments were generated in the recent review. 🎉

📜 Recent review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d461d93 and e0e215a.

📒 Files selected for processing (1)
  • README.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: cppcheck
  • GitHub Check: build
🔇 Additional comments (1)
README.md (1)

29-29: The checkbox marking "Image support within EPUB" as complete is correct. The codebase implements full image support including:

  • Image parsing: EPUB content is parsed to extract image references from XHTML
  • Multiple formats: Supported formats include JPEG, PNG, and other image types handled by ImageDecoderFactory
  • Rendering pipeline: PageImage elements are created during parsing and rendered via ImageBlock::render()
  • E-paper optimization: Images are converted to grayscale and dithered for e-paper display quality
  • Performance caching: Decoded images are cached to .pxc files for efficient reloads
  • Test coverage: Test EPUB files exist for JPEG, PNG, and mixed image formats

Images are rendered directly to the framebuffer during page display, with full bounds checking and proper integration into the page layout.

📝 Walkthrough

Walkthrough

README.md documentation updated to reflect image support within EPUB as an implemented feature by changing the status checkbox from unchecked to checked. No functional code changes were made.

Changes

Cohort / File(s) Summary
Documentation
README.md		 Feature checkbox for EPUB image support updated from unchecked to checked.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~1 minute

🚥 Pre-merge checks | ✅ 2
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically describes the main change: marking image support as completed in the documentation.
Description check ✅ Passed The description is directly related to the changeset, explaining the goal of documenting completed EPUB image support and detailing the specific change made.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

Comment @coderabbitai help to get the list of available commands and usage tips.

@insunaa
Copy link

insunaa commented Feb 19, 2026

martin brook is currently working on replacing picojpeg with jpegdec, might make sense to delay this PR until that's done? This should further add support for progressive jpegs

@ariel-lindemann
Copy link
Contributor Author

ariel-lindemann commented Feb 20, 2026

yes, maybe.

I'll just leave the PR here and the maintainers can merge it whenever they feel the time is right

@daveallie
Copy link
Member

daveallie commented Feb 20, 2026

I think it's suitable to merge now, given that for the majority of cases, the current implementation will work fine. Keen for jpegdec, but overall worth signalling that it works from the README

@daveallie daveallie merged commit 388fbf2 into crosspoint-reader:master Feb 20, 2026
7 checks passed
lukestein pushed a commit to lukestein/crosspoint-reader that referenced this pull request Feb 20, 2026
@ariel-lindemann @lukestein
docs: image support marked as completed (crosspoint-reader#1008)
1e83e0d 
## Summary

* **What is the goal of this PR?** (e.g., Implements the new feature for
file uploading.)

Epub image support was added in crosspoint-reader#556. The goal of this PR is to document
that in the readme.

* **What changes are included?**

Only the checkmark in the readme.

## Additional Context

* Add any other information that might be helpful for the reviewer
(e.g., performance implications, potential risks,
  specific areas to focus on).

---

### AI Usage

While CrossPoint doesn't have restrictions on AI tools in contributing,
please be transparent about their usage as it
helps set the right context for reviewers.

Did you use AI tools to help write this code? _**< NO >**_
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@daveallie daveallie daveallie approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@ariel-lindemann @insunaa @daveallie