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

Kitty z-index feature #49

Merged
merged 18 commits into from
Jun 11, 2022
Merged

Kitty z-index feature #49

merged 18 commits into from
Jun 11, 2022

Conversation

AnonymouX47
Copy link
Owner

@AnonymouX47 AnonymouX47 commented Jun 7, 2022

Resolving #40

  • Implements usage of kitty graphics protocol z-index feature.
    • Adds z_index style-specific parameter for "kitty" render style.
    • Adds mix style-specific parameter for "kitty" render style.
  • Adds "kitty" style-specific format specification.
    • Adds z-index spec.
    • Adds image/text inter-mix policy spec.
  • Improves "kitty" style support detection and identification of supported terminals.
  • Adds kitty style-specific CLI option --kz/--kitty-z-index.
  • Implements workarounds for animation in supported terminal emulators.
  • Implements workarounds for redrawing images in the TUI for different supported terminal emulators.
  • Fixes output deadlock and messed up terminal state when image drawing is interrupted mid-transmission.
  • Fixes parsing of style-specific CLI options.

- Add: Added `KittyImage._style_args`.
- Add: Added `z_index` style-specific parameter for "kitty" render style.
- Add: Added `KittyImage.draw()` for the purpose of documentation.
- Add: Added `KittyImage._check_style_format_spec()`.
- Add: Documented "kitty" style-specific format specification.
@AnonymouX47 AnonymouX47 added documentation Improvements or additions to documentation enhancement New feature / Improvement suggestion or request lib Related to the library (Not to be used anymore) cli Related to the image viewer's CLI (Not to be used anymore) tui Related to the image viewer's TUI (Not to be used anymore) labels Jun 7, 2022
@AnonymouX47 AnonymouX47 added this to the 0.4.0 milestone Jun 7, 2022
- Add: Added `_KITTY_VERSION` and `_KONSOLE_VERSION` to `KittyImage`.
- Change: Now using `CSI > q` for terminal identification in `KittyImage`.
- Add: Added workaround for different supported terminal emulators and specific versions having various limitations.
- Add: Added `--kitty-z-index` CL option.
- Change: Improved handling of style-specific CL options.
- Add: Added `.tui.render.style_specs`.
- Add: Added `Image._ti_style_spec`.
- Add: Added kitty style format spec for the TUI.
- Add: Added workarounds for image re-drawing and animation in the TUI.
- Fix: Worked around repeated image blending on Kitty.
- Fix: Fixed output deadlock and messed up terminal state when image drawing is interrupted mid-transmission.
- Add: Added `KittyImage._handle_interrupted_draw()`.
- Change: Removed `_render_image_lines` and `_render_image_whole` in `KittyImage`.
- Add: Added `mix` to `KittyImage._style_args`.
- Change: Updated `KittyImage.draw()` docstring.
- Fix: Corrected default argument value check in `KittyImage.draw()`.
- Add: Added format specification for `mix` style-specific parameter of the kitty render style.
- Change: Updated kitty style-specific format specification documentation.
@AnonymouX47 AnonymouX47 changed the title kitty render style z-index feature Kitty z-index feature Jun 9, 2022
- Change: Handled uninterpretable version numbers in `KittyImage.is_supported()`.
- Change: Updated `KittyImsge` doc.
@AnonymouX47 AnonymouX47 changed the title Kitty z-index feature Kitty style-specific features Jun 9, 2022
@AnonymouX47 AnonymouX47 changed the title Kitty style-specific features Kitty z-index feature Jun 10, 2022
- Change: Disabled retrieval of pixel data as it's unneeded.
  - Aproximately 1.5x faster rendering.
- Change: Replaced blank fill with XTerm erase + cursor movement escape sequences.
- Change: Updated render tests.
- Add: Added tests for 'kitty' style-specific parameters `z_index` and `mix`.
- Add: Added tests for 'kitty' style-specific format specification.
@AnonymouX47 AnonymouX47 merged commit 92a8946 into main Jun 11, 2022
@AnonymouX47 AnonymouX47 deleted the kitty-z-index branch June 11, 2022 02:30
AnonymouX47 added a commit that referenced this pull request Jun 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cli Related to the image viewer's CLI (Not to be used anymore) documentation Improvements or additions to documentation enhancement New feature / Improvement suggestion or request lib Related to the library (Not to be used anymore) tui Related to the image viewer's TUI (Not to be used anymore)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant