s&box docs
API ReferenceSandbox.Diagnostics

GpuProfilerStatsclass

GPU profiler stats collected from the scene system timestamp manager

object→GpuProfilerStats
Namespace
Sandbox.Diagnostics
Assembly
Sandbox.Engine
Declaration
public static abstract sealed class Sandbox.Diagnostics.GpuProfilerStats

Methods2

Showing 2 methods

public static float GetMaxDuration(string name)PUBLICSTATIC

Get a decayed max duration for a given name (for display purposes)

ParameterTypeDescription
namestring—
Returns:float—

public static float GetSmoothedDuration(string name)PUBLICSTATIC

Get a smoothed duration for a given name (for display purposes)

ParameterTypeDescription
namestring—
Returns:float—

Properties6

Showing 6 properties

public static bool Sandbox.Diagnostics.GpuProfilerStats.Enabled { get; set; }PUBLICSTATICGETSET

Whether GPU profiling is enabled

Returns:bool—

public static System.Collections.Generic.IReadOnlyList`1<string> Sandbox.Diagnostics.GpuProfilerStats.Entries { get; set; }PUBLICSTATICGETSET

Full '/'-separated paths of the current GPU timing scopes (split to build the tree).

Returns:IReadOnlyList<string>—

public static ulong Sandbox.Diagnostics.GpuProfilerStats.VideoMemoryBudget { get; set; }PUBLICSTATICGETSET

GPU video memory budget in bytes.

Returns:ulong—

public static ulong Sandbox.Diagnostics.GpuProfilerStats.VideoMemoryFree { get; set; }PUBLICSTATICGETSET

GPU video memory free within the current budget in bytes.

Returns:ulong—

public static float Sandbox.Diagnostics.GpuProfilerStats.VideoMemoryUsageFraction { get; set; }PUBLICSTATICGETSET

GPU video memory usage as a 0-1 fraction of budget.

Returns:float—

public static ulong Sandbox.Diagnostics.GpuProfilerStats.VideoMemoryUsed { get; set; }PUBLICSTATICGETSET

GPU video memory used by the engine in bytes.

Returns:ulong—

VfxRuleChecks

Previous Page

Enabled

Next Page

On this page

Methodspublic static System.Single GetMaxDuration(System.String name)public static System.Single GetSmoothedDuration(System.String name)Propertiespublic static System.Boolean Sandbox.Diagnostics.GpuProfilerStats.Enabled { get; set; }public static System.Collections.Generic.IReadOnlyList`1<System.String> Sandbox.Diagnostics.GpuProfilerStats.Entries { get; set; }public static System.UInt64 Sandbox.Diagnostics.GpuProfilerStats.VideoMemoryBudget { get; set; }public static System.UInt64 Sandbox.Diagnostics.GpuProfilerStats.VideoMemoryFree { get; set; }public static System.Single Sandbox.Diagnostics.GpuProfilerStats.VideoMemoryUsageFraction { get; set; }public static System.UInt64 Sandbox.Diagnostics.GpuProfilerStats.VideoMemoryUsed { get; set; }Metadata