Misaki
d8a7b07624
- 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
157 lines
6.1 KiB
HTML
157 lines
6.1 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>Entity Command Buffer | GhostEngine </title>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<meta name="title" content="Entity Command Buffer | 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 "{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="">
|
|
<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="entity-command-buffer">Entity Command Buffer</h1>
|
|
|
|
<p><code>EntityCommandBuffer</code> (ECB) records structural operations and replays them later.</p>
|
|
<p>Use it when you cannot safely mutate structure immediately (for example, while iterating query results or inside parallel jobs).</p>
|
|
<h2 id="why-use-ecb">Why Use ECB</h2>
|
|
<ul>
|
|
<li>Avoid structural modifications during active iteration.</li>
|
|
<li>Batch operations into one playback phase.</li>
|
|
<li>Use thread-local command buffers in multithreaded jobs.</li>
|
|
</ul>
|
|
<h2 id="recorded-operations">Recorded Operations</h2>
|
|
<p>The ECB supports recording:</p>
|
|
<ul>
|
|
<li>create entity,</li>
|
|
<li>create entity with component set,</li>
|
|
<li>destroy entity,</li>
|
|
<li>add component,</li>
|
|
<li>remove component,</li>
|
|
<li>set component.</li>
|
|
</ul>
|
|
<h2 id="basic-usage">Basic Usage</h2>
|
|
<pre><code class="lang-csharp">var world = World.Create();
|
|
var ecb = world.EntityCommandBuffer;
|
|
|
|
ecb.CreateEntity(count: 100);
|
|
|
|
var entity = world.EntityManager.CreateEntity();
|
|
ecb.AddComponent(entity, new Velocity { X = 1, Y = 0, Z = 0 });
|
|
ecb.SetComponent(entity, new Velocity { X = 2, Y = 0, Z = 0 });
|
|
</code></pre>
|
|
<h2 id="thread-local-ecb">Thread-Local ECB</h2>
|
|
<p>When a world has a <code>JobScheduler</code>, obtain per-thread buffers:</p>
|
|
<pre><code class="lang-csharp">var threadLocal = world.GetThreadLocalEntityCommandBuffer(threadIndex);
|
|
threadLocal.DestroyEntity(entity);
|
|
</code></pre>
|
|
<p>Then playback all buffers at a sync point:</p>
|
|
<p>Playback is performed by the world/runtime update flow at synchronization points.</p>
|
|
<h2 id="notes">Notes</h2>
|
|
<ul>
|
|
<li>Playback executes in recording order per buffer.</li>
|
|
<li>Playback clears internal command data (<code>Reset</code>) after execution.</li>
|
|
<li>ECB does not replace dependency handling; you still need proper job synchronization before playback.</li>
|
|
</ul>
|
|
|
|
</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>
|