Patch - Doc Update - V12.8.1

This commit is contained in:
2025-07-28 17:37:15 +02:00
parent 9431552316
commit ccd0d045f9
201 changed files with 9244 additions and 3316 deletions

View File

@@ -136,9 +136,15 @@ Public Member Functions</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Builder for <a class="el" href="classfps__limiter.html">fps_limiter</a> class This class is used to limit the execution rate of a loop based on a target frames per second (FPS). </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">target_fps</td><td>Target frames per second for the limiter. The default is 60.0f FPS. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="fps__limiter_8h_source.html#l00006">6</a> of file <a class="el" href="fps__limiter_8h_source.html">fps_limiter.h</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 7</span> : min_delta_(1.0f / target_fps), last_time_(std::chrono::high_resolution_clock::now()) {}</div>
<p class="definition">Definition at line <a class="el" href="fps__limiter_8h_source.html#l00012">12</a> of file <a class="el" href="fps__limiter_8h_source.html">fps_limiter.h</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 13</span> : min_delta_(1.0f / target_fps), last_time_(std::chrono::high_resolution_clock::now()) {}</div>
</div><!-- fragment -->
</div>
</div>
@@ -165,16 +171,17 @@ Public Member Functions</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Function to check if enough time has passed since the last execution. </p><dl class="section return"><dt>Returns</dt><dd>True if the time since the last call is greater than or equal to the minimum delta time, otherwise false. </dd></dl>
<p class="definition">Definition at line <a class="el" href="fps__limiter_8h_source.html#l00010">10</a> of file <a class="el" href="fps__limiter_8h_source.html">fps_limiter.h</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 10</span> {</div>
<div class="line"><span class="lineno"> 11</span> <span class="keyword">const</span> <span class="keyword">auto</span> now = std::chrono::high_resolution_clock::now();</div>
<div class="line"><span class="lineno"> 12</span> <span class="keywordflow">if</span> (<span class="keyword">const</span> <span class="keywordtype">float</span> elapsed = std::chrono::duration&lt;float&gt;(now - last_time_).count(); elapsed &gt;= min_delta_) {</div>
<div class="line"><span class="lineno"> 13</span> last_time_ = now;</div>
<div class="line"><span class="lineno"> 14</span> <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><span class="lineno"> 15</span> }</div>
<div class="line"><span class="lineno"> 16</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><span class="lineno"> 17</span> }</div>
<p class="definition">Definition at line <a class="el" href="fps__limiter_8h_source.html#l00019">19</a> of file <a class="el" href="fps__limiter_8h_source.html">fps_limiter.h</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 19</span> {</div>
<div class="line"><span class="lineno"> 20</span> <span class="keyword">const</span> <span class="keyword">auto</span> now = std::chrono::high_resolution_clock::now();</div>
<div class="line"><span class="lineno"> 21</span> <span class="keywordflow">if</span> (<span class="keyword">const</span> <span class="keywordtype">float</span> elapsed = std::chrono::duration&lt;float&gt;(now - last_time_).count(); elapsed &gt;= min_delta_) {</div>
<div class="line"><span class="lineno"> 22</span> last_time_ = now;</div>
<div class="line"><span class="lineno"> 23</span> <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><span class="lineno"> 24</span> }</div>
<div class="line"><span class="lineno"> 25</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><span class="lineno"> 26</span> }</div>
</div><!-- fragment -->
</div>
</div>