Skip to content

Refactor window visibility cache and fix viewport visibility #24464

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

Merged
merged 3 commits into from
May 22, 2025

Conversation

mixiate
Copy link
Contributor

@mixiate mixiate commented May 21, 2025

This refactors window visibility and fixes a couple of bugs related to viewports.

  • WindowIsVisible was a getter that was also updating the visibility if it was not already set. It makes much more sense to update it once in WindowUpdateAll and then just return that result.
  • Viewport visibility was generally not getting set due to a couple of bugs. The main viewport was not setting its viewport visibility at all. Several windows with viewports were recreating their viewports every frame (see Prevent some unnecessary window invalidations #24433), causing the visibility to get out of sync with the window. It now sets it to the windows visibility on creation.
  • Because the viewport visibility was rarely set, ViewportInvalidate was having to go to the window manager and get the window visibility every time, which causes major slowdown when invalidating hundreds of thousands of times a frame. It now only has to check a bool. I've also moved up that check to the parent functions to prevent some unnecessary calculations.

This should improve performance a small amount. It usually takes significantly more invalidations than most normal parks have to really see a big difference. I came across this issue when I was testing invalidating 500,000+ map animations.

You might notice that windows are always set to visible if they don't have a viewport. That is the current behavior and there is some more complications with that about window translucency as well. Another time maybe.

@ZehMatt ZehMatt added this to the v0.4.23 milestone May 21, 2025
@ZehMatt ZehMatt added the changelog This issue/PR deserves a changelog entry. label May 21, 2025
@mixiate mixiate force-pushed the fix-window-visibility-cache branch 2 times, most recently from 2616229 to 8d4c5eb Compare May 21, 2025 20:32
@mixiate mixiate force-pushed the fix-window-visibility-cache branch from 8d4c5eb to 04c3113 Compare May 21, 2025 20:37
Copy link
Member

@ZehMatt ZehMatt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Took it for a test, seems all fine from what I can tell.

Copy link
Member

@AaronVanGeffen AaronVanGeffen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found in my quick play test. Looks like a nice cleanup! :)

@ZehMatt ZehMatt merged commit f71b45b into OpenRCT2:develop May 22, 2025
23 checks passed
tupaschoal added a commit that referenced this pull request Jun 7, 2025
- Feature: [#22476] “Time since last inspection” statistic is available in the rides window.
- Feature: [#24313] [Plugin] Add API for setting a ride vehicle’s sprite to a smoke plume.
- Improved: [#24345] Vehicle fallback sprites are less likely to glitch with the track.
- Improved: [#24362, #24491] The Windows installer is now translated as well.
- Improved: [#24364] Improve the fallback vehicle sprites for Zero G Rolls, and allow small ones to be built without cheats if the fallbacks are available.
- Improved: [#24368] Clicking the in-game update notication now leads to a more user-friendly download page.
- Improved: [#24400] Ride list in preservation window is now sorted alphabetically.
- Improved: [#24409] Steam installs of RCT Classic are now detected automatically.
- Improved: [#24413] Better performance when moving the viewport on Windows and Linux platforms.
- Improved: [#24417] Improve the fallback vehicle sprites for Dive Loops.
- Improved: [#24433] The ride, new ride, scenery, path, viewport, park and tool windows no longer redraw every frame if they have not changed.
- Improved: [#24467] Apply tweening only to on-screen entities when not zoomed out for better performance with uncapped FPS.
- Improved: [#24474] More efficiently search viewports when playing Audio.
- Improved: [#24479] More descriptive error messages for `set` commands in the in-game console.
- Improved: [#24563] The Linux .desktop file will now request the more powerful dedicated GPU on hybrid graphics systems.
- Change: [#24342, #24484] g2.dat is now split into g2.dat, fonts.dat and tracks.dat.
- Change: [#24362] The Windows installer now prevents installing to the same folder as RollerCoaster Tycoon 2 or Classic.
- Change: [#24418] Small & Large Zero G Rolls can now be built on the LIM Launched RC without cheats if vehicle sprites are available.
- Fix: [#5269] Font bugs when using the Russian release of RCT2 as the base game.
- Fix: [#11071, #22958] The virtual floor does not always draw correctly.
- Fix: [#18220] Some custom RCT1 scenarios are detected as competition DLC scenarios.
- Fix: [#20095] UCES Halloween - Cemetery Ridge scenario has mismatched entrance/exit on haunted house.
- Fix: [#20158] Custom animated scenery .DATs with frame offsets draw a random sprite at the end of their animation.
- Fix: [#22628] Potential crash while rebuilding the scenario index.
- Fix: [#23289] Dodgems and Flying Saucer cars can spawn on top of each other when the ride is opened.
- Fix: [#24332] Banner font renders differently when using RCT Classic as the base game.
- Fix: [#24343] Large gently sloped turns are buildable without cheats when the vehicles do not have sprites for them.
- Fix: [#24346] Possible crash during line drawing in OpenGL mode.
- Fix: [#24353] ‘Show dirty visuals’ is off by one pixel and does not work correctly with higher framerates.
- Fix: [#24362] When upgrading from an older version on Windows, old versions of official objects are not always removed.
- Fix: [#24366] Zero G Rolls have some incorrect vehicle yaw rotations.
- Fix: [#24371] Fix divide by zero in the scenery window when there is no scenery.
- Fix: [#24378] Prevent ride and stall statistics from overflowing.
- Fix: [#24388] Shortcut keys are not localised based on the user’s language settings.
- Fix: [#24403] Park fences draw underneath and through opaque water.
- Fix: [#24406] The network status window uses an undefined string for its title.
- Fix: [#24444] In the object load error window, the guide text overlaps when the title bar is enlarged.
- Fix: [#24446] [Plugin] Fix regression breaking the track iterator on specific track pieces.
- Fix: [#24447] Shortcut list is not refreshed when changing language.
- Fix: [#24448] Shortcuts involving the Caps Lock key are wrongly localised to NumPad Dot.
- Fix: [#24464] Window and viewport visibility is not calculated correctly causing minor performance issues.
- Fix: [#24488] Objects are not always redrawn immediately when they are reloaded from the Object Selection window.
- Fix: [#24544] RCT1 Maze designs with wooden walls are not imported correctly.
- Fix: [#24567] Long flat-to-steep wooden mine support sprites don't connect to flat supports exactly.
tupaschoal added a commit that referenced this pull request Jun 7, 2025
- Feature: [#22476] “Time since last inspection” statistic is available in the rides window.
- Feature: [#24313] [Plugin] Add API for setting a ride vehicle’s sprite to a smoke plume.
- Improved: [#24345] Vehicle fallback sprites are less likely to glitch with the track.
- Improved: [#24362, #24491] The Windows installer is now translated as well.
- Improved: [#24364] Improve the fallback vehicle sprites for Zero G Rolls, and allow small ones to be built without cheats if the fallbacks are available.
- Improved: [#24368] Clicking the in-game update notication now leads to a more user-friendly download page.
- Improved: [#24400] Ride list in preservation window is now sorted alphabetically.
- Improved: [#24409] Steam installs of RCT Classic are now detected automatically.
- Improved: [#24413] Better performance when moving the viewport on Windows and Linux platforms.
- Improved: [#24417] Improve the fallback vehicle sprites for Dive Loops.
- Improved: [#24433] The ride, new ride, scenery, path, viewport, park and tool windows no longer redraw every frame if they have not changed.
- Improved: [#24467] Apply tweening only to on-screen entities when not zoomed out for better performance with uncapped FPS.
- Improved: [#24474] More efficiently search viewports when playing Audio.
- Improved: [#24479] More descriptive error messages for `set` commands in the in-game console.
- Improved: [#24563] The Linux .desktop file will now request the more powerful dedicated GPU on hybrid graphics systems.
- Change: [#24342, #24484] g2.dat is now split into g2.dat, fonts.dat and tracks.dat.
- Change: [#24362] The Windows installer now prevents installing to the same folder as RollerCoaster Tycoon 2 or Classic.
- Change: [#24418] Small & Large Zero G Rolls can now be built on the LIM Launched RC without cheats if vehicle sprites are available.
- Fix: [#5269] Font bugs when using the Russian release of RCT2 as the base game.
- Fix: [#11071, #22958] The virtual floor does not always draw correctly.
- Fix: [#18220] Some custom RCT1 scenarios are detected as competition DLC scenarios.
- Fix: [#20095] UCES Halloween - Cemetery Ridge scenario has mismatched entrance/exit on haunted house.
- Fix: [#20158] Custom animated scenery .DATs with frame offsets draw a random sprite at the end of their animation.
- Fix: [#22628] Potential crash while rebuilding the scenario index.
- Fix: [#23289] Dodgems and Flying Saucer cars can spawn on top of each other when the ride is opened.
- Fix: [#24332] Banner font renders differently when using RCT Classic as the base game.
- Fix: [#24343] Large gently sloped turns are buildable without cheats when the vehicles do not have sprites for them.
- Fix: [#24346] Possible crash during line drawing in OpenGL mode.
- Fix: [#24353] ‘Show dirty visuals’ is off by one pixel and does not work correctly with higher framerates.
- Fix: [#24362] When upgrading from an older version on Windows, old versions of official objects are not always removed.
- Fix: [#24366] Zero G Rolls have some incorrect vehicle yaw rotations.
- Fix: [#24371] Fix divide by zero in the scenery window when there is no scenery.
- Fix: [#24378] Prevent ride and stall statistics from overflowing.
- Fix: [#24388] Shortcut keys are not localised based on the user’s language settings.
- Fix: [#24403] Park fences draw underneath and through opaque water.
- Fix: [#24406] The network status window uses an undefined string for its title.
- Fix: [#24444] In the object load error window, the guide text overlaps when the title bar is enlarged.
- Fix: [#24446] [Plugin] Fix regression breaking the track iterator on specific track pieces.
- Fix: [#24447] Shortcut list is not refreshed when changing language.
- Fix: [#24448] Shortcuts involving the Caps Lock key are wrongly localised to NumPad Dot.
- Fix: [#24464] Window and viewport visibility is not calculated correctly causing minor performance issues.
- Fix: [#24488] Objects are not always redrawn immediately when they are reloaded from the Object Selection window.
- Fix: [#24544] RCT1 Maze designs with wooden walls are not imported correctly.
- Fix: [#24567] Long flat-to-steep wooden mine support sprites don't connect to flat supports exactly.
CorySanin added a commit to CorySanin/OpenRCT2 that referenced this pull request Jun 22, 2025
v0.4.23

Release v0.4.23

- Feature: [OpenRCT2#22476] “Time since last inspection” statistic is available in the rides window.
- Feature: [OpenRCT2#24313] [Plugin] Add API for setting a ride vehicle’s sprite to a smoke plume.
- Improved: [OpenRCT2#24345] Vehicle fallback sprites are less likely to glitch with the track.
- Improved: [OpenRCT2#24362, OpenRCT2#24491] The Windows installer is now translated as well.
- Improved: [OpenRCT2#24364] Improve the fallback vehicle sprites for Zero G Rolls, and allow small ones to be built without cheats if the fallbacks are available.
- Improved: [OpenRCT2#24368] Clicking the in-game update notication now leads to a more user-friendly download page.
- Improved: [OpenRCT2#24400] Ride list in preservation window is now sorted alphabetically.
- Improved: [OpenRCT2#24409] Steam installs of RCT Classic are now detected automatically.
- Improved: [OpenRCT2#24413] Better performance when moving the viewport on Windows and Linux platforms.
- Improved: [OpenRCT2#24417] Improve the fallback vehicle sprites for Dive Loops.
- Improved: [OpenRCT2#24433] The ride, new ride, scenery, path, viewport, park and tool windows no longer redraw every frame if they have not changed.
- Improved: [OpenRCT2#24467] Apply tweening only to on-screen entities when not zoomed out for better performance with uncapped FPS.
- Improved: [OpenRCT2#24474] More efficiently search viewports when playing Audio.
- Improved: [OpenRCT2#24479] More descriptive error messages for `set` commands in the in-game console.
- Improved: [OpenRCT2#24563] The Linux .desktop file will now request the more powerful dedicated GPU on hybrid graphics systems.
- Change: [OpenRCT2#24342, OpenRCT2#24484] g2.dat is now split into g2.dat, fonts.dat and tracks.dat.
- Change: [OpenRCT2#24362] The Windows installer now prevents installing to the same folder as RollerCoaster Tycoon 2 or Classic.
- Change: [OpenRCT2#24418] Small & Large Zero G Rolls can now be built on the LIM Launched RC without cheats if vehicle sprites are available.
- Fix: [OpenRCT2#5269] Font bugs when using the Russian release of RCT2 as the base game.
- Fix: [OpenRCT2#11071, OpenRCT2#22958] The virtual floor does not always draw correctly.
- Fix: [OpenRCT2#18220] Some custom RCT1 scenarios are detected as competition DLC scenarios.
- Fix: [OpenRCT2#20095] UCES Halloween - Cemetery Ridge scenario has mismatched entrance/exit on haunted house.
- Fix: [OpenRCT2#20158] Custom animated scenery .DATs with frame offsets draw a random sprite at the end of their animation.
- Fix: [OpenRCT2#22628] Potential crash while rebuilding the scenario index.
- Fix: [OpenRCT2#23289] Dodgems and Flying Saucer cars can spawn on top of each other when the ride is opened.
- Fix: [OpenRCT2#24332] Banner font renders differently when using RCT Classic as the base game.
- Fix: [OpenRCT2#24343] Large gently sloped turns are buildable without cheats when the vehicles do not have sprites for them.
- Fix: [OpenRCT2#24346] Possible crash during line drawing in OpenGL mode.
- Fix: [OpenRCT2#24353] ‘Show dirty visuals’ is off by one pixel and does not work correctly with higher framerates.
- Fix: [OpenRCT2#24362] When upgrading from an older version on Windows, old versions of official objects are not always removed.
- Fix: [OpenRCT2#24366] Zero G Rolls have some incorrect vehicle yaw rotations.
- Fix: [OpenRCT2#24371] Fix divide by zero in the scenery window when there is no scenery.
- Fix: [OpenRCT2#24378] Prevent ride and stall statistics from overflowing.
- Fix: [OpenRCT2#24388] Shortcut keys are not localised based on the user’s language settings.
- Fix: [OpenRCT2#24403] Park fences draw underneath and through opaque water.
- Fix: [OpenRCT2#24406] The network status window uses an undefined string for its title.
- Fix: [OpenRCT2#24444] In the object load error window, the guide text overlaps when the title bar is enlarged.
- Fix: [OpenRCT2#24446] [Plugin] Fix regression breaking the track iterator on specific track pieces.
- Fix: [OpenRCT2#24447] Shortcut list is not refreshed when changing language.
- Fix: [OpenRCT2#24448] Shortcuts involving the Caps Lock key are wrongly localised to NumPad Dot.
- Fix: [OpenRCT2#24464] Window and viewport visibility is not calculated correctly causing minor performance issues.
- Fix: [OpenRCT2#24488] Objects are not always redrawn immediately when they are reloaded from the Object Selection window.
- Fix: [OpenRCT2#24544] RCT1 Maze designs with wooden walls are not imported correctly.
- Fix: [OpenRCT2#24567] Long flat-to-steep wooden mine support sprites don't connect to flat supports exactly.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog This issue/PR deserves a changelog entry.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants