-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
22a109d
commit e0aaab3
Showing
25 changed files
with
4,257 additions
and
3,306 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,342 @@ | ||
| <!DOCTYPE html> | ||
| <html> | ||
| <head> | ||
| <meta charset="utf-8"> | ||
| <title>Class GameExtensions | Stride Community Toolkit </title> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> | ||
| <meta name="title" content="Class GameExtensions | Stride Community Toolkit "> | ||
|
|
||
|
|
||
| <link rel="icon" href="../favicon.ico"> | ||
| <link rel="stylesheet" href="../public/docfx.min.css"> | ||
| <link rel="stylesheet" href="../public/main.css"> | ||
| <meta name="docfx:navrel" content="../toc.html"> | ||
| <meta name="docfx:tocrel" content="toc.html"> | ||
|
|
||
| <meta name="docfx:rel" content="../"> | ||
|
|
||
|
|
||
| <meta name="docfx:docurl" content="https://github.com/stride3d/stride-community-toolkit/new/main/apiSpec/new?filename=Stride_CommunityToolkit_Games_GameExtensions.md&value=---%0Auid%3A%20Stride.CommunityToolkit.Games.GameExtensions%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A"> | ||
| <meta name="loc:inThisArticle" content="In this article"> | ||
| <meta name="loc:searchResultsCount" content="{count} results for "{query}""> | ||
| <meta name="loc:searchNoResults" content="No results for "{query}""> | ||
| <meta name="loc:tocFilter" content="Filter by title"> | ||
| <meta name="loc:nextArticle" content="Next"> | ||
| <meta name="loc:prevArticle" content="Previous"> | ||
| <meta name="loc:themeLight" content="Light"> | ||
| <meta name="loc:themeDark" content="Dark"> | ||
| <meta name="loc:themeAuto" content="Auto"> | ||
| <meta name="loc:changeTheme" content="Change theme"> | ||
| <meta name="loc:copy" content="Copy"> | ||
| <meta name="loc:downloadPdf" content="Download PDF"> | ||
|
|
||
| <script type="module" src="./../public/docfx.min.js"></script> | ||
|
|
||
| <script> | ||
| const theme = localStorage.getItem('theme') || 'auto' | ||
| document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme) | ||
| </script> | ||
|
|
||
| </head> | ||
|
|
||
| <body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference"> | ||
| <header class="bg-body border-bottom"> | ||
| <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation"> | ||
| <div class="container-xxl flex-nowrap"> | ||
| <a class="navbar-brand" href="../index.html"> | ||
| <img id="logo" class="svg" src="../media/stride-logo-blue-toolkit.svg" alt=""> | ||
|
|
||
| </a> | ||
| <button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation"> | ||
| <i class="bi bi-three-dots"></i> | ||
| </button> | ||
| <div class="collapse navbar-collapse" id="navpanel"> | ||
| <div id="navbar"> | ||
| <form class="search" role="search" id="search"> | ||
| <i class="bi bi-search"></i> | ||
| <input class="form-control" id="search-query" type="search" disabled="" placeholder="Search" autocomplete="off" aria-label="Search"> | ||
| </form> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| </nav> | ||
| </header> | ||
|
|
||
| <main class="container-xxl"> | ||
| <div class="toc-offcanvas"> | ||
| <div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel"> | ||
| <div class="offcanvas-header"> | ||
| <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5> | ||
| <button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button> | ||
| </div> | ||
| <div class="offcanvas-body"> | ||
| <nav class="toc" id="toc"></nav> | ||
| </div> | ||
| </div> | ||
| </div> | ||
|
|
||
| <div class="content"> | ||
| <div class="actionbar"> | ||
| <button class="btn btn-lg border-0 d-md-none" style="margin-top: -.65em; margin-left: -.8em" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents"> | ||
| <i class="bi bi-list"></i> | ||
| </button> | ||
|
|
||
| <nav id="breadcrumb"></nav> | ||
| </div> | ||
|
|
||
| <article data-uid="Stride.CommunityToolkit.Games.GameExtensions"> | ||
|
|
||
|
|
||
|
|
||
| <h1 id="Stride_CommunityToolkit_Games_GameExtensions" data-uid="Stride.CommunityToolkit.Games.GameExtensions" class="text-break"> | ||
| Class GameExtensions <a class="header-action link-secondary" title="View source" href="https://github.com/stride3d/stride-community-toolkit/blob/main/src/Stride.CommunityToolkit/Games/GameExtensions.cs/#L5"><i class="bi bi-code-slash"></i></a> | ||
| </h1> | ||
|
|
||
| <div class="facts text-secondary"> | ||
| <dl><dt>Namespace</dt><dd><a class="xref" href="Stride.html">Stride</a>.<a class="xref" href="Stride.CommunityToolkit.html">CommunityToolkit</a>.<a class="xref" href="Stride.CommunityToolkit.Games.html">Games</a></dd></dl> | ||
| <dl><dt>Assembly</dt><dd>Stride.CommunityToolkit.dll</dd></dl> | ||
| </div> | ||
|
|
||
| <div class="markdown summary"></div> | ||
| <div class="markdown conceptual"></div> | ||
|
|
||
| <div class="codewrapper"> | ||
| <pre><code class="lang-csharp hljs">public static class GameExtensions</code></pre> | ||
| </div> | ||
|
|
||
|
|
||
|
|
||
|
|
||
| <dl class="typelist inheritance"> | ||
| <dt>Inheritance</dt> | ||
| <dd> | ||
| <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div> | ||
| <div><span class="xref">GameExtensions</span></div> | ||
| </dd> | ||
| </dl> | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| <h2 class="section" id="methods">Methods | ||
| </h2> | ||
|
|
||
|
|
||
| <a id="Stride_CommunityToolkit_Games_GameExtensions_DeltaTime_" data-uid="Stride.CommunityToolkit.Games.GameExtensions.DeltaTime*"></a> | ||
|
|
||
| <h3 id="Stride_CommunityToolkit_Games_GameExtensions_DeltaTime_Stride_Games_IGame_" data-uid="Stride.CommunityToolkit.Games.GameExtensions.DeltaTime(Stride.Games.IGame)"> | ||
| DeltaTime(IGame) | ||
| <a class="header-action link-secondary" title="View source" href="https://github.com/stride3d/stride-community-toolkit/blob/main/src/Stride.CommunityToolkit/Games/GameExtensions.cs/#L12"><i class="bi bi-code-slash"></i></a> | ||
| </h3> | ||
|
|
||
| <div class="markdown level1 summary"><p>Gets the time elapsed since the last game update in seconds as a single-precision floating-point number.</p> | ||
| </div> | ||
| <div class="markdown level1 conceptual"></div> | ||
|
|
||
| <div class="codewrapper"> | ||
| <pre><code class="lang-csharp hljs">public static float DeltaTime(this IGame gameTime)</code></pre> | ||
| </div> | ||
|
|
||
| <h4 class="section">Parameters</h4> | ||
| <dl class="parameters"> | ||
| <dt><code>gameTime</code> <a class="xref" href="api/Stride.Games.IGame.html">IGame</a></dt> | ||
| <dd><p>The IGame interface providing access to game timing information.</p> | ||
| </dd> | ||
| </dl> | ||
|
|
||
| <h4 class="section">Returns</h4> | ||
| <dl class="parameters"> | ||
| <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.single">float</a></dt> | ||
| <dd><p>The time elapsed since the last game update in seconds.</p> | ||
| </dd> | ||
| </dl> | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| <a id="Stride_CommunityToolkit_Games_GameExtensions_DeltaTimeAccurate_" data-uid="Stride.CommunityToolkit.Games.GameExtensions.DeltaTimeAccurate*"></a> | ||
|
|
||
| <h3 id="Stride_CommunityToolkit_Games_GameExtensions_DeltaTimeAccurate_Stride_Games_IGame_" data-uid="Stride.CommunityToolkit.Games.GameExtensions.DeltaTimeAccurate(Stride.Games.IGame)"> | ||
| DeltaTimeAccurate(IGame) | ||
| <a class="header-action link-secondary" title="View source" href="https://github.com/stride3d/stride-community-toolkit/blob/main/src/Stride.CommunityToolkit/Games/GameExtensions.cs/#L22"><i class="bi bi-code-slash"></i></a> | ||
| </h3> | ||
|
|
||
| <div class="markdown level1 summary"><p>Gets the time elapsed since the last game update in seconds as a double-precision floating-point number.</p> | ||
| </div> | ||
| <div class="markdown level1 conceptual"></div> | ||
|
|
||
| <div class="codewrapper"> | ||
| <pre><code class="lang-csharp hljs">public static double DeltaTimeAccurate(this IGame gameTime)</code></pre> | ||
| </div> | ||
|
|
||
| <h4 class="section">Parameters</h4> | ||
| <dl class="parameters"> | ||
| <dt><code>gameTime</code> <a class="xref" href="api/Stride.Games.IGame.html">IGame</a></dt> | ||
| <dd><p>The IGame interface providing access to game timing information.</p> | ||
| </dd> | ||
| </dl> | ||
|
|
||
| <h4 class="section">Returns</h4> | ||
| <dl class="parameters"> | ||
| <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt> | ||
| <dd><p>The time elapsed since the last game update in seconds with double precision.</p> | ||
| </dd> | ||
| </dl> | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| <a id="Stride_CommunityToolkit_Games_GameExtensions_FPS_" data-uid="Stride.CommunityToolkit.Games.GameExtensions.FPS*"></a> | ||
|
|
||
| <h3 id="Stride_CommunityToolkit_Games_GameExtensions_FPS_Stride_Games_IGame_" data-uid="Stride.CommunityToolkit.Games.GameExtensions.FPS(Stride.Games.IGame)"> | ||
| FPS(IGame) | ||
| <a class="header-action link-secondary" title="View source" href="https://github.com/stride3d/stride-community-toolkit/blob/main/src/Stride.CommunityToolkit/Games/GameExtensions.cs/#L32"><i class="bi bi-code-slash"></i></a> | ||
| </h3> | ||
|
|
||
| <div class="markdown level1 summary"><p>Retrieves the current frames per second (FPS) rate of the running game.</p> | ||
| </div> | ||
| <div class="markdown level1 conceptual"></div> | ||
|
|
||
| <div class="codewrapper"> | ||
| <pre><code class="lang-csharp hljs">public static float FPS(this IGame game)</code></pre> | ||
| </div> | ||
|
|
||
| <h4 class="section">Parameters</h4> | ||
| <dl class="parameters"> | ||
| <dt><code>game</code> <a class="xref" href="api/Stride.Games.IGame.html">IGame</a></dt> | ||
| <dd><p>The game instance from which to obtain the FPS rate.</p> | ||
| </dd> | ||
| </dl> | ||
|
|
||
| <h4 class="section">Returns</h4> | ||
| <dl class="parameters"> | ||
| <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.single">float</a></dt> | ||
| <dd><p>The current FPS rate of the game.</p> | ||
| </dd> | ||
| </dl> | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| <a id="Stride_CommunityToolkit_Games_GameExtensions_SetFocusLostFPS_" data-uid="Stride.CommunityToolkit.Games.GameExtensions.SetFocusLostFPS*"></a> | ||
|
|
||
| <h3 id="Stride_CommunityToolkit_Games_GameExtensions_SetFocusLostFPS_Stride_Games_IGame_System_Int32_" data-uid="Stride.CommunityToolkit.Games.GameExtensions.SetFocusLostFPS(Stride.Games.IGame,System.Int32)"> | ||
| SetFocusLostFPS(IGame, int) | ||
| <a class="header-action link-secondary" title="View source" href="https://github.com/stride3d/stride-community-toolkit/blob/main/src/Stride.CommunityToolkit/Games/GameExtensions.cs/#L40"><i class="bi bi-code-slash"></i></a> | ||
| </h3> | ||
|
|
||
| <div class="markdown level1 summary"><p>Sets the maximum frames per second (FPS) rate for the game when not in focus. | ||
| Set <param name="targetFPS"> to 0 for max possible FPS.</p> | ||
| </div> | ||
| <div class="markdown level1 conceptual"></div> | ||
|
|
||
| <div class="codewrapper"> | ||
| <pre><code class="lang-csharp hljs">public static void SetFocusLostFPS(this IGame game, int targetFPS)</code></pre> | ||
| </div> | ||
|
|
||
| <h4 class="section">Parameters</h4> | ||
| <dl class="parameters"> | ||
| <dt><code>game</code> <a class="xref" href="api/Stride.Games.IGame.html">IGame</a></dt> | ||
| <dd></dd> | ||
| <dt><code>targetFPS</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt> | ||
| <dd></dd> | ||
| </dl> | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| <a id="Stride_CommunityToolkit_Games_GameExtensions_SetMaxFPS_" data-uid="Stride.CommunityToolkit.Games.GameExtensions.SetMaxFPS*"></a> | ||
|
|
||
| <h3 id="Stride_CommunityToolkit_Games_GameExtensions_SetMaxFPS_Stride_Games_IGame_System_Int32_" data-uid="Stride.CommunityToolkit.Games.GameExtensions.SetMaxFPS(Stride.Games.IGame,System.Int32)"> | ||
| SetMaxFPS(IGame, int) | ||
| <a class="header-action link-secondary" title="View source" href="https://github.com/stride3d/stride-community-toolkit/blob/main/src/Stride.CommunityToolkit/Games/GameExtensions.cs/#L52"><i class="bi bi-code-slash"></i></a> | ||
| </h3> | ||
|
|
||
| <div class="markdown level1 summary"><p>Sets the maximum frames per second (FPS) rate for the game. | ||
| Set <param name="targetFPS"> to 0 for max possible FPS.</p> | ||
| </div> | ||
| <div class="markdown level1 conceptual"></div> | ||
|
|
||
| <div class="codewrapper"> | ||
| <pre><code class="lang-csharp hljs">public static void SetMaxFPS(this IGame game, int targetFPS)</code></pre> | ||
| </div> | ||
|
|
||
| <h4 class="section">Parameters</h4> | ||
| <dl class="parameters"> | ||
| <dt><code>game</code> <a class="xref" href="api/Stride.Games.IGame.html">IGame</a></dt> | ||
| <dd></dd> | ||
| <dt><code>targetFPS</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt> | ||
| <dd></dd> | ||
| </dl> | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| </article> | ||
|
|
||
| <div class="contribution d-print-none"> | ||
| <a href="https://github.com/stride3d/stride-community-toolkit/blob/main/src/Stride.CommunityToolkit/Games/GameExtensions.cs/#L5" class="edit-link">Edit this page</a> | ||
| </div> | ||
|
|
||
|
|
||
| </div> | ||
|
|
||
| <div class="affix"> | ||
| <nav id="affix"></nav> | ||
| </div> | ||
| </main> | ||
|
|
||
| <div class="container-xxl search-results" id="search-results"></div> | ||
|
|
||
| <footer class="border-top text-secondary"> | ||
| <div class="container-xxl"> | ||
| <div class="flex-fill"> | ||
| <div class="d-flex flex-column flex-sm-row justify-content-between pt-1 text-center small"><p>Supported by the <a href="https://dotnetfoundation.org/" target="_blank" rel="noopener">.NET Foundation</a></p><p>Made with <a href="https://dotnet.github.io/docfx">docfx</a></p><p>Stride Community Toolkit Website v.1.0.0.2</p><p>© .NET Foundation and Contributors</p></div> | ||
| </div> | ||
| </div> | ||
| </footer> | ||
| </body> | ||
| </html> |
Oops, something went wrong.