Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(ecl-auto): ECL improvements and better custom drawing #161

Open
wants to merge 21 commits into
base: main
Choose a base branch
from

Conversation

g0dkar
Copy link
Owner

@g0dkar g0dkar commented Mar 11, 2025

feat(ecl-auto): ECL improvements and better custom drawing


4.4.0

I'm trying to keep a better CHANGELOG from now on ^^

Changed

  • Changed default ECL from VERY_HIGH to LOW as to stay closer to what other tools seems to use as a default
  • Computing the informationDensity value now always goes for the least possible value (down from a minimum of 6 set by QRCodeBuilder)
  • Better documentation of methods - this is an ongoing initiative!

New

  • New InsufficientInformationDensityException: instead of an IllegalArgumentException, this new exception is thrown with a more helpful message
  • Added useCustom<Canvas/BufferedImage>() methods to the QRCodeProcessor platform-specific classes: This allows users to manually set their own "painting instrument instance".
  • Added examples demonstrating what the ECL does (same data, different ECLs)
  • Added examples demonstrating what a Mask Pattern does (same data, different masks)

Removed

  • forceInformationDensity was removed. Now the QRCodeBuilder class uses infoDensity = 0 (default value) as a trigger to compute it automatically since it needs to be >= 1
    • Default value calling QRCode() directly is still 6 as to keep a bit of backwards compatibility 😅

Internal

  • Renamed "typeNum" to "informationDensity"
  • Updated dokka and KMP
  • Fixed dokka always triggering building the whole docs/dokka/ folder (that is only for GH Pages)

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.

3 participants