Add basic xmldoc on interface type

This commit is contained in:
Dean Herbert 2024-02-27 20:46:25 +08:00
parent 069b400dd0
commit 189c680555
No known key found for this signature in database
1 changed files with 11 additions and 0 deletions

View File

@ -5,8 +5,19 @@
namespace osu.Game.Performance
{
/// <summary>
/// Allows creating a temporary "high performance" session, with the goal of optimising runtime
/// performance for gameplay purposes.
///
/// On desktop platforms, this will set a low latency GC mode which collects more frequently to avoid
/// GC spikes.
/// </summary>
public interface IHighPerformanceSessionManager
{
/// <summary>
/// Start a new high performance session.
/// </summary>
/// <returns>An <see cref="IDisposable"/> which will end the session when disposed.</returns>
IDisposable BeginSession();
}
}