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

Clarify that only diffs are rendered to IO every frame #449

Open
kdheepak opened this issue Feb 14, 2024 · 2 comments
Open

Clarify that only diffs are rendered to IO every frame #449

kdheepak opened this issue Feb 14, 2024 · 2 comments
Labels
good first issue Good for newcomers

Comments

@kdheepak
Copy link
Contributor

kdheepak commented Feb 14, 2024

Currently, when people read "immediate mode rendering", there's a chance that people think ratatui draws every pixel to the terminal. However that is not case, only diffs are rendered to IO (e.g. stdout). Currently, I believe diff is only mentioned in under-the-hood section.

It should probably more prominently mentioned in the README, docs and website.

@kdheepak kdheepak added the good first issue Good for newcomers label Feb 14, 2024
@joshka
Copy link
Member

joshka commented Feb 14, 2024

To some extent this is true - the rendering happens from widget to memory to the buffer, but that's not the expensive bit (the actually copying to screen is).

@kdheepak kdheepak changed the title Clarify that only diffs are rendered every frame Clarify that only diffs are rendered to IO every frame Feb 14, 2024
@kdheepak
Copy link
Contributor Author

I clarified the issue to mean rendering to IO.

joshka pushed a commit that referenced this issue Jun 4, 2024
Add documentation to the `BarChart` widgets and its sub-modules.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants