From 1fda8b09a7dc0399474f3287bda18f36a78ac24aa2bcb725df43b8686d907997 Mon Sep 17 00:00:00 2001 From: copecone Date: Mon, 17 Aug 2026 21:46:14 +0900 Subject: [PATCH] Document `RenderSession` --- API/RenderSession.cs | 28 ++++++++++++++++++++++++++-- 1 file changed, 26 insertions(+), 2 deletions(-) diff --git a/API/RenderSession.cs b/API/RenderSession.cs index 2399faa..cc17849 100644 --- a/API/RenderSession.cs +++ b/API/RenderSession.cs @@ -1,4 +1,4 @@ -using System; +using System; using ADOFAIRenderer.Core; using ADOFAIRenderer.Data; @@ -11,7 +11,22 @@ public class RenderSession { private bool _auto = true; - public enum PatchType { Time, Screen } + /// + /// Specifies the types of patches that can be configured for a render session. + /// + public enum PatchType + { + /// + /// Time-related patch controlling frame timing and clock synchronization. + /// + Time, + + /// + /// Screen-related patch controlling screen resolution. + /// + Screen + } + private bool _timePatch = true; private bool _screenPatch = true; @@ -26,6 +41,13 @@ public class RenderSession return this; } + /// + /// Sets whether a specific patch type is enabled for the render session. + /// + /// The to configure. + /// true to enable the specified patch; otherwise, false. Default is true. + /// The current instance for method chaining. + /// Thrown when an unsupported is provided. public RenderSession WithPatch(PatchType patchType, bool enabled = true) { switch (patchType) @@ -41,6 +63,8 @@ public class RenderSession /// /// Applies the configured flags and initiates the render session. /// + /// The configuration settings for the render session. + /// The file path of the level to render. public void Start(RenderConfig renderConfig, string levelPath) { RenderContext.Auto = _auto;