Orrery Terrain · OrreryTerrainRenderer module · class
UOrreryTerrainStatsLibrary
Show and read the stat terrain panel.
Declaration
UCLASS()
class UOrreryTerrainStatsLibrary : public UBlueprintFunctionLibrary- Header
#include "OrreryTerrainStats.h"- Module
PublicDependencyModuleNames.Add("OrreryTerrainRenderer");in your module’s Build.cs.- Stability
- Stable: changes within a major version only add.
- Thread
- Game thread.
- Derives from
UBlueprintFunctionLibrary- Blueprint
- “Orrery Terrain Stats Library”, a Blueprint type
Description
In a build with a console, stat terrain toggles the panel and OrreryTerrain.Stat.Measure starts a GPU measurement; both work in Shipping through these functions.
Off, the panel costs one relaxed atomic load and a branch per counted scope; it registers nothing per frame. While it is up it also adds a few GPU timestamps and a render graph pass per timestamp.
Game thread.
Functions
- SetStatTerrainShownBlueprintstatic
Show or hide the panel on the game viewport of the context's world.
- IsStatTerrainShownBlueprintstatic
Whether the panel is on for the game viewport of the context's world.
- StartGpuCostMeasureBlueprintstatic
Measure what the terrain costs on the GPU: hide the far field, then the whole terrain, about two seconds each, and show them again.
- IsGpuCostMeasureRunningBlueprintstatic
Whether a GPU measurement runs now.
- GetStatTerrainLinesBlueprintstatic
The panel's lines as last built; empty while the panel has never been up.
- SetStatTerrainAnchorBlueprintstatic
Where to draw the panel, canvas pixels from the top left; a negative Y counts from the bottom of the screen to the panel's bottom.
- GetStatTerrainRectBlueprintstatic
The rectangle the panel covered in its last draw, viewport pixels; an invalid box when it was not drawn.
- IsStatTerrainCollectingBlueprintstatic
Whether the time counters collect now.
- BuildStatTerrainLinesstatic
Build the panel's lines from readings: the text of the panel, with what each section does not hold.
Blueprint
- Get Stat Terrain LinesOrrery › Terrain › Stats
- Get Stat Terrain RectOrrery › Terrain › Stats
- Is Gpu Cost Measure RunningOrrery › Terrain › Stats
- Is Stat Terrain CollectingOrrery › Terrain › Stats
- Is Stat Terrain ShownOrrery › Terrain › Stats
- Set Stat Terrain AnchorOrrery › Terrain › Stats
- Set Stat Terrain ShownOrrery › Terrain › Stats
- Start Gpu Cost MeasureOrrery › Terrain › Stats