chunky-dev / chunky

A path tracer to create realistic images of your Minecraft worlds.
https://chunky-dev.github.io/docs
GNU General Public License v3.0
637 stars 76 forks source link

Clarify render status UI #1683

Closed imsyphia closed 6 months ago

imsyphia commented 6 months ago

The current render status pane is somewhat messy with odd and inconsistent formatting, leading to issues like #1213, where Rendering: 5 of 7 can be misinterpreted as currently rendering 5 of 7. I tried to make it overall more readable and intuitively organized.

This (mostly) fixes #1213. It can still be misinterpreted, but it should be somewhat clearer without having to add additional visual clutter like "5 of 7 done".

I've attached before/after images below for comparison.

chunkyuibefore

chunkyuiafter

jackjt8 commented 6 months ago

This is definitely an improvement. Having Render time and ETA on the same line in the same format is really nice.

I am still not 100% happy with the "Rendering" line... but as you have said.. I'm not sure how we can "fix" it without adding more visual clutter. I wonder if hover text with more verbose information would be a good or bad idea.. It's clutter.. just not visible? Or would a button to toggle verbose status UI be silly?

leMaik commented 6 months ago

Great first PR! 🎉

How about calculating a percentage? Eg. "Rendering (42%)", if that "of" number is not zero? The numbers are spp for rendering but otherwise pretty arbitrary anyways, and a percentage is nicer in formatting imho.

imsyphia commented 6 months ago

Great first PR! 🎉

How about calculating a percentage? Eg. "Rendering (42%)", if that "of" number is not zero? The numbers are spp for rendering but otherwise pretty arbitrary anyways, and a percentage is nicer in formatting imho.

I actually did try adding a percentage, but the combination of counter and percentage looked a little clunky. Doing Rendering | 42% or something similar could totally work, though. And it would fix the "Rendering" issue as @jackjt8 stated. I'll try it when I get around to it.

My only concern is that having a specific number could be useful for debugging in certain circumstances, so it may be worth adding that information elsewhere if it's not already available.

imsyphia commented 6 months ago

Also, this may fall slightly outside the scope of this PR, but job names are inconsistent. Some are nouns, like Preview, and others are active verbs, like Rendering. If this is a simple fix I'll likely include it, since it is mostly relevant to the status pane, but if it's more complicated I'll make a separate issue.

leMaik commented 6 months ago

Feel free to update the task names to active verbs, while you're at it. Should be a matter of changing some strings. 👍

imsyphia commented 6 months ago

I've replaced the N of M indicator with percentage progress, and renamed "Render time" to "Time", since it should be clear enough from context, and is not necessarily restricted to rendering.

The percentage indicator is only two digits because additional digits on the percentage progress looked awkward and was unnecessary given that there's already a timer, progress bar, and SPP counter to indicate that progress is being made.

The "Preview" task is now named "Displaying preview", since it was the only inconsistent one. I avoided "Rendering preview" because a newer user could confuse it with the actual rendering process.

chunkyuiafter2

imsyphia commented 6 months ago

This is definitely outside the scope of this PR, but I was thinking that the top-right of the pane doesn't need to be exclusively SPP and SPS. It could be used as a general-purpose info/status list for the current task. Should I make an issue for that?

leMaik commented 6 months ago

My only concern is that having a specific number could be useful for debugging in certain circumstances, so it may be worth adding that information elsewhere if it's not already available.

Regarding this concern: Maybe have the full numbers as tooltip? Or maybe after the percentage, like Rendering - 20% (200 of 1000)?

imsyphia commented 6 months ago

Here's what it now looks like, just for reference.

chunkyuiafter3