 |
Gondwana Game Engine Development (master) - 2.6.1
Gondwana is a cross-platform 2.5D game and rendering engine written in C#/.NET 8. It provides fine-grained control over rendering, timing, and scene composition, with built-in support for parallax, z-ordering, pixel overhang, collision detection, and particle effects. Gondwana targets desktop and web platforms using SkiaSharp for graphics and pluggable audio backends for desktop and browser targets.
|
Provides the compatibility payload for legacy cycles-per-second (CPS) performance notifications. This event args class contains both gross and net cycle counts, their corresponding rates per second, and the sampling time period. Net CPS typically represents the effective frame rate (FPS) of the engine, while gross CPS includes all cycles regardless of whether they resulted in rendered frames. More...
Public Member Functions | |
| CyclesPerSecondCalculatedEventArgs (long totalGross, long totalNet, double grossCPS, double netCPS, double sampleTime, double? gpuFps=null) | |
| Initializes a new instance of the CyclesPerSecondCalculatedEventArgs class with the specified cycle counts, rates, sampling time, and optional GPU FPS. | |
| override string | ToString () |
| Returns a formatted string representation of the performance metrics, including total cycle counts, sampling time, and calculated rates. This provides a human-readable summary of all performance data suitable for logging, debugging, or display purposes. | |
Public Attributes | |
| long | TotalGrossCycles |
| The total number of gross cycles counted during the sampling period. Gross cycles represent all engine update cycles, including those that may not have resulted in a rendered frame. This value provides insight into the engine's overall processing activity. | |
| long | TotalNetCycles |
| The total number of net cycles counted during the sampling period. Net cycles typically represent engine update cycles that resulted in rendered frames, providing a more accurate measure of visible performance and frame delivery. | |
| double | GrossCPS |
| The calculated gross cycles per second rate, representing how many engine cycles occurred per second during the sampling period. This includes all cycles regardless of whether they produced rendered output. | |
| double | NetCPS |
| The calculated net cycles per second rate, representing the effective frame rate (FPS). This value indicates how many rendered frames or meaningful engine cycles occurred per second during the sampling period, providing the most relevant performance metric for visual smoothness. | |
| double? | GpuFps |
The actual GPU presentation rate, measured by counting successful GPU PaintSurface callbacks over the same sampling window used for NetCPS. On platforms where presentation cadence is independent of Gondwana's foreground cadence, this value can differ from NetCPS. For example, the Blazor WebGL path may re-present the current GPU backbuffer on a browser animation frame without rendering a new Gondwana scene frame. null when no GPU-rendered surfaces are registered (i.e. when only BitmapBackbuffer surfaces are in use). | |
| double | SampleTime |
| The duration of the sampling period in seconds over which the cycle counts and rates were measured. This time window determines the granularity and accuracy of the CPS calculations. | |
Provides the compatibility payload for legacy cycles-per-second (CPS) performance notifications. This event args class contains both gross and net cycle counts, their corresponding rates per second, and the sampling time period. Net CPS typically represents the effective frame rate (FPS) of the engine, while gross CPS includes all cycles regardless of whether they resulted in rendered frames.
The payload type itself remains supported so existing compatibility handlers can continue to compile. Engine.CPSCalculated is warning-only obsolete; new diagnostics should use Engine.Profiler or the optional ProfilerWidget display.
Definition at line 16 of file CyclesPerSecondCalculatedEventArgs.cs.
| Gondwana.CyclesPerSecondCalculatedEventArgs.CyclesPerSecondCalculatedEventArgs | ( | long | totalGross, |
| long | totalNet, | ||
| double | grossCPS, | ||
| double | netCPS, | ||
| double | sampleTime, | ||
| double? | gpuFps = null ) |
Initializes a new instance of the CyclesPerSecondCalculatedEventArgs class with the specified cycle counts, rates, sampling time, and optional GPU FPS.
| totalGross | The total number of gross cycles counted during the sampling period. |
| totalNet | The total number of net cycles counted during the sampling period. |
| grossCPS | The calculated gross cycles per second rate. |
| netCPS | The calculated net cycles per second rate (effective FPS). |
| sampleTime | The duration of the sampling period in seconds. |
| gpuFps | The actual GPU presentation rate, or null when no GPU surfaces are active. |
Definition at line 88 of file CyclesPerSecondCalculatedEventArgs.cs.
| override string Gondwana.CyclesPerSecondCalculatedEventArgs.ToString | ( | ) |
Returns a formatted string representation of the performance metrics, including total cycle counts, sampling time, and calculated rates. This provides a human-readable summary of all performance data suitable for logging, debugging, or display purposes.
Definition at line 107 of file CyclesPerSecondCalculatedEventArgs.cs.
| double? Gondwana.CyclesPerSecondCalculatedEventArgs.GpuFps |
The actual GPU presentation rate, measured by counting successful GPU PaintSurface callbacks over the same sampling window used for NetCPS. On platforms where presentation cadence is independent of Gondwana's foreground cadence, this value can differ from NetCPS. For example, the Blazor WebGL path may re-present the current GPU backbuffer on a browser animation frame without rendering a new Gondwana scene frame. null when no GPU-rendered surfaces are registered (i.e. when only BitmapBackbuffer surfaces are in use).
Definition at line 58 of file CyclesPerSecondCalculatedEventArgs.cs.
| double Gondwana.CyclesPerSecondCalculatedEventArgs.GrossCPS |
The calculated gross cycles per second rate, representing how many engine cycles occurred per second during the sampling period. This includes all cycles regardless of whether they produced rendered output.
Definition at line 38 of file CyclesPerSecondCalculatedEventArgs.cs.
| double Gondwana.CyclesPerSecondCalculatedEventArgs.NetCPS |
The calculated net cycles per second rate, representing the effective frame rate (FPS). This value indicates how many rendered frames or meaningful engine cycles occurred per second during the sampling period, providing the most relevant performance metric for visual smoothness.
Definition at line 45 of file CyclesPerSecondCalculatedEventArgs.cs.
| double Gondwana.CyclesPerSecondCalculatedEventArgs.SampleTime |
The duration of the sampling period in seconds over which the cycle counts and rates were measured. This time window determines the granularity and accuracy of the CPS calculations.
Definition at line 64 of file CyclesPerSecondCalculatedEventArgs.cs.
| long Gondwana.CyclesPerSecondCalculatedEventArgs.TotalGrossCycles |
The total number of gross cycles counted during the sampling period. Gross cycles represent all engine update cycles, including those that may not have resulted in a rendered frame. This value provides insight into the engine's overall processing activity.
Definition at line 24 of file CyclesPerSecondCalculatedEventArgs.cs.
| long Gondwana.CyclesPerSecondCalculatedEventArgs.TotalNetCycles |
The total number of net cycles counted during the sampling period. Net cycles typically represent engine update cycles that resulted in rendered frames, providing a more accurate measure of visible performance and frame delivery.
Definition at line 31 of file CyclesPerSecondCalculatedEventArgs.cs.
1.14.0