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
163 lines
6.8 KiB
HTML
163 lines
6.8 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>Components Overview | GhostEngine </title>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<meta name="title" content="Components Overview | 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="components-overview">Components Overview</h1>
|
|
|
|
<p>In GhostEngine, components are strict, unmanaged data structures. They must implement the empty interface <code>IComponent</code> (or its derivations). This ensures AOT compatibility and zero GC allocation overhead when iterating over millions of entities.</p>
|
|
<h2 id="defining-a-component">Defining a Component</h2>
|
|
<p>To define a standard component, create an unmanaged struct implementing <code>IComponent</code>:</p>
|
|
<pre><code class="lang-csharp">using Ghost.Entities;
|
|
using System.Numerics;
|
|
|
|
public struct TransformComponent : IComponent
|
|
{
|
|
public Vector3 Position;
|
|
public Quaternion Rotation;
|
|
public Vector3 Scale;
|
|
}
|
|
</code></pre>
|
|
<h2 id="enableable-components">Enableable Components</h2>
|
|
<p>Sometimes you need to toggle a component on or off without incurring the heavy structural cost of removing and re-adding the component from an entity. GhostEngine supports this via <code>IEnableableComponent</code>.</p>
|
|
<pre><code class="lang-csharp">public struct Renderable : IEnableableComponent
|
|
{
|
|
public int MeshID;
|
|
public int MaterialID;
|
|
}
|
|
</code></pre>
|
|
<p>When iterating over an archetype chunk, you can check the bitmask to see if an entity's enableable component is currently active:</p>
|
|
<pre><code class="lang-csharp">// During a query chunk iteration:
|
|
var renderables = chunkView.GetComponentData<Renderable>();
|
|
var enableBits = chunkView.GetEnableBits<Renderable>();
|
|
|
|
for (int i = 0; i < chunkView.EntityCount; i++)
|
|
{
|
|
if (chunkView.IsComponentEnabled<Renderable>(i))
|
|
{
|
|
// Process active renderable
|
|
}
|
|
}
|
|
</code></pre>
|
|
<h2 id="component-type-ids">Component Type IDs</h2>
|
|
<p>The engine assigns a unique runtime ID to each unmanaged component type. You can retrieve this identifier using the <code>ComponentTypeID<T>.Value</code> generic cache:</p>
|
|
<pre><code class="lang-csharp">Identifier<IComponent> id = ComponentTypeID<TransformComponent>.Value;
|
|
</code></pre>
|
|
<p>This ID is heavily used under the hood for query masking, archetype matching, and memory offset calculations inside a chunk.</p>
|
|
<h2 id="requirecomponent-attribute">RequireComponent Attribute</h2>
|
|
<p>You can enforce dependencies between components using the <code>[RequireComponentAttribute<T>]</code>. While this is mostly semantic, it helps structure dependencies for complex systems.</p>
|
|
<pre><code class="lang-csharp">[RequireComponent<TransformComponent>]
|
|
public struct PhysicsCollider : IComponent
|
|
{
|
|
public float Radius;
|
|
}
|
|
</code></pre>
|
|
|
|
</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>
|