Files
GhostEngine/doc/_site/docs/query-benchmark.html
Misaki d8a7b07624 feat(graphics): improve rendering pipeline and docs
- Refactor D3D12 backend and RenderGraph module
- Update graphics RHI and core rendering components
- Add Random.hlsl shader include
- Regenerate API documentation and update user guides
2026-03-27 22:23:44 +09:00

183 lines
7.1 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Query Benchmark | GhostEngine </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Query Benchmark | GhostEngine ">
<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="loc:inThisArticle" content="In this article">
<meta name="loc:searchResultsCount" content="{count} results for &quot;{query}&quot;">
<meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
<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="">
<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="../logo.svg" alt="GhostEngine">
GhostEngine
</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" 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="">
<h1 id="query-benchmark">Query Benchmark</h1>
<p>This page summarizes the query performance benchmark in <code>src/Test/Ghost.Entities.Test/QueryBenchmark.cs</code>.</p>
<h2 id="goal">Goal</h2>
<p>Compare update throughput between:</p>
<ul>
<li>Classic managed object array iteration (<code>GameObject[]</code>).</li>
<li>ECS chunk iteration through <code>EntityQuery</code>.</li>
</ul>
<p>The benchmark updates one million items in both paths.</p>
<h2 id="benchmark-setup">Benchmark Setup</h2>
<pre><code class="lang-csharp">[GlobalSetup]
public void Setup()
{
_world = World.Create(entityCapacity: 1_000_000);
_gameObjects = new GameObject[1_000_000];
using var scope = AllocationManager.CreateStackScope();
var componentSet = new ComponentSet(scope.AllocationHandle, ComponentTypeID&lt;Position&gt;.Value);
_world.EntityManager.CreateEntities(1_000_000, componentSet);
_queryIdentifier = new QueryBuilder().WithAllRW&lt;Position&gt;().Build(_world);
}
</code></pre>
<p>Two benchmark methods:</p>
<pre><code class="lang-csharp">[Benchmark]
public void QueryGameObjects()
{
for (var i = 0; i &lt; _gameObjects.Length; i++)
{
_gameObjects[i].Position += new Vector4(_dt, _dt, _dt, 0);
}
}
[Benchmark(Baseline = true)]
public void QueryEntities()
{
ref var query = ref _world.ComponentManager.GetEntityQueryReference(_queryIdentifier);
foreach (var chunkView in query.GetChunkIterator())
{
var positions = chunkView.GetComponentDataRW&lt;Position&gt;();
ref var address = ref MemoryMarshal.GetReference(positions);
for (var i = 0; i &lt; positions.Length; i++)
{
Unsafe.Add(ref address, i).value += new Vector4(_dt, _dt, _dt, 0);
}
}
}
</code></pre>
<h2 id="notes-on-measurement">Notes on Measurement</h2>
<ul>
<li>The benchmark enables hardware counters (<code>CacheMisses</code>, <code>LlcReference</code>, <code>InstructionRetired</code>) for deeper analysis.</li>
<li>ECS path uses chunk traversal and contiguous component storage.</li>
<li><code>Unsafe.Add</code> avoids bounds-check overhead inside the inner loop.</li>
</ul>
<h2 id="running-the-benchmark">Running the Benchmark</h2>
<p>From <code>src/</code>:</p>
<pre><code class="lang-shell">dotnet run --project Test/Ghost.Entities.Test/Ghost.Entities.Test.csproj -c Release
</code></pre>
<p>The current <code>Program.cs</code> already executes <code>BenchmarkRunner.Run&lt;QueryBenchmark&gt;()</code>.</p>
<h2 id="interpreting-results">Interpreting Results</h2>
<p>When comparing output, evaluate both runtime and counters:</p>
<ul>
<li>Lower execution time for target workload.</li>
<li>Lower cache miss rates under similar work.</li>
<li>Reasonable instruction count for equivalent behavior.</li>
</ul>
<p>Use this benchmark as a template for your own data-oriented workload comparisons.</p>
</article>
<div class="contribution d-print-none">
</div>
<div class="next-article d-print-none border-top" id="nextArticle"></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">
<span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span>
</div>
</div>
</footer>
</body>
</html>