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
495 lines
16 KiB
HTML
495 lines
16 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>Struct ComponentSet | GhostEngine </title>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<meta name="title" content="Struct ComponentSet | GhostEngine ">
|
|
|
|
<meta name="description" content="Represents an immutable set of component identifiers used to define a group of components within an entity or system.">
|
|
<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="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="../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="Ghost.Entities.ComponentSet">
|
|
|
|
|
|
|
|
<h1 id="Ghost_Entities_ComponentSet" data-uid="Ghost.Entities.ComponentSet" class="text-break">
|
|
Struct ComponentSet
|
|
</h1>
|
|
|
|
<div class="facts text-secondary">
|
|
<dl><dt>Namespace</dt><dd><a class="xref" href="Ghost.html">Ghost</a>.<a class="xref" href="Ghost.Entities.html">Entities</a></dd></dl>
|
|
<dl><dt>Assembly</dt><dd>Ghost.Entities.dll</dd></dl>
|
|
</div>
|
|
|
|
<div class="markdown summary"><p>Represents an immutable set of component identifiers used to define a group of components within an entity or system.</p>
|
|
</div>
|
|
<div class="markdown conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public struct ComponentSet : IDisposable, IEquatable<ComponentSet></code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="typelist implements">
|
|
<dt>Implements</dt>
|
|
<dd>
|
|
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.idisposable">IDisposable</a></div>
|
|
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iequatable-1">IEquatable</a><<a class="xref" href="Ghost.Entities.ComponentSet.html">ComponentSet</a>></div>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<dl class="typelist inheritedMembers">
|
|
<dt>Inherited Members</dt>
|
|
<dd>
|
|
<div>
|
|
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.valuetype.tostring">ValueType.ToString()</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
|
|
</div>
|
|
</dd></dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 class="section" id="constructors">Constructors
|
|
</h2>
|
|
|
|
|
|
<a id="Ghost_Entities_ComponentSet__ctor_" data-uid="Ghost.Entities.ComponentSet.#ctor*"></a>
|
|
|
|
<h3 id="Ghost_Entities_ComponentSet__ctor_Misaki_HighPerformance_LowLevel_Buffer_AllocationHandle_System_ReadOnlySpan_Ghost_Core_Identifier_Ghost_Entities_IComponent___" data-uid="Ghost.Entities.ComponentSet.#ctor(Misaki.HighPerformance.LowLevel.Buffer.AllocationHandle,System.ReadOnlySpan{Ghost.Core.Identifier{Ghost.Entities.IComponent}})">
|
|
ComponentSet(AllocationHandle, params ReadOnlySpan<Identifier<IComponent>>)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public ComponentSet(AllocationHandle allocationHandle, params ReadOnlySpan<Identifier<IComponent>> components)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>allocationHandle</code> <span class="xref">AllocationHandle</span></dt>
|
|
<dd></dd>
|
|
<dt><code>components</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.readonlyspan-1">ReadOnlySpan</a><<span class="xref">Identifier</span><<a class="xref" href="Ghost.Entities.IComponent.html">IComponent</a>>></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Ghost_Entities_ComponentSet__ctor_" data-uid="Ghost.Entities.ComponentSet.#ctor*"></a>
|
|
|
|
<h3 id="Ghost_Entities_ComponentSet__ctor_Misaki_HighPerformance_LowLevel_Buffer_Allocator_System_ReadOnlySpan_Ghost_Core_Identifier_Ghost_Entities_IComponent___" data-uid="Ghost.Entities.ComponentSet.#ctor(Misaki.HighPerformance.LowLevel.Buffer.Allocator,System.ReadOnlySpan{Ghost.Core.Identifier{Ghost.Entities.IComponent}})">
|
|
ComponentSet(Allocator, params ReadOnlySpan<Identifier<IComponent>>)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public ComponentSet(Allocator allocator, params ReadOnlySpan<Identifier<IComponent>> components)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>allocator</code> <span class="xref">Allocator</span></dt>
|
|
<dd></dd>
|
|
<dt><code>components</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.readonlyspan-1">ReadOnlySpan</a><<span class="xref">Identifier</span><<a class="xref" href="Ghost.Entities.IComponent.html">IComponent</a>>></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 class="section" id="properties">Properties
|
|
</h2>
|
|
|
|
|
|
<a id="Ghost_Entities_ComponentSet_Components_" data-uid="Ghost.Entities.ComponentSet.Components*"></a>
|
|
|
|
<h3 id="Ghost_Entities_ComponentSet_Components" data-uid="Ghost.Entities.ComponentSet.Components">
|
|
Components
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public readonly ReadOnlySpan<Identifier<IComponent>> Components { get; }</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Property Value</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.readonlyspan-1">ReadOnlySpan</a><<span class="xref">Identifier</span><<a class="xref" href="Ghost.Entities.IComponent.html">IComponent</a>>></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 class="section" id="methods">Methods
|
|
</h2>
|
|
|
|
|
|
<a id="Ghost_Entities_ComponentSet_Dispose_" data-uid="Ghost.Entities.ComponentSet.Dispose*"></a>
|
|
|
|
<h3 id="Ghost_Entities_ComponentSet_Dispose" data-uid="Ghost.Entities.ComponentSet.Dispose">
|
|
Dispose()
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void Dispose()</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Ghost_Entities_ComponentSet_Equals_" data-uid="Ghost.Entities.ComponentSet.Equals*"></a>
|
|
|
|
<h3 id="Ghost_Entities_ComponentSet_Equals_Ghost_Entities_ComponentSet_" data-uid="Ghost.Entities.ComponentSet.Equals(Ghost.Entities.ComponentSet)">
|
|
Equals(ComponentSet)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Indicates whether the current object is equal to another object of the same type.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public readonly bool Equals(ComponentSet other)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>other</code> <a class="xref" href="Ghost.Entities.ComponentSet.html">ComponentSet</a></dt>
|
|
<dd><p>An object to compare with this object.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h4 class="section">Returns</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
|
<dd><p><a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> if the current object is equal to the <code class="paramref">other</code> parameter; otherwise, <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a>.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Ghost_Entities_ComponentSet_Equals_" data-uid="Ghost.Entities.ComponentSet.Equals*"></a>
|
|
|
|
<h3 id="Ghost_Entities_ComponentSet_Equals_System_Object_" data-uid="Ghost.Entities.ComponentSet.Equals(System.Object)">
|
|
Equals(object?)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Indicates whether this instance and a specified object are equal.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public override readonly bool Equals(object? obj)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>obj</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
|
|
<dd><p>The object to compare with the current instance.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<h4 class="section">Returns</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
|
<dd><p><a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> if <code class="paramref">obj</code> and this instance are the same type and represent the same value; otherwise, <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a>.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Ghost_Entities_ComponentSet_GetHashCode_" data-uid="Ghost.Entities.ComponentSet.GetHashCode*"></a>
|
|
|
|
<h3 id="Ghost_Entities_ComponentSet_GetHashCode" data-uid="Ghost.Entities.ComponentSet.GetHashCode">
|
|
GetHashCode()
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Returns the hash code for this instance.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public override int GetHashCode()</code></pre>
|
|
</div>
|
|
|
|
|
|
<h4 class="section">Returns</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
|
<dd><p>A 32-bit signed integer that is the hash code for this instance.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 class="section" id="operators">Operators
|
|
</h2>
|
|
|
|
|
|
<a id="Ghost_Entities_ComponentSet_op_Equality_" data-uid="Ghost.Entities.ComponentSet.op_Equality*"></a>
|
|
|
|
<h3 id="Ghost_Entities_ComponentSet_op_Equality_Ghost_Entities_ComponentSet_Ghost_Entities_ComponentSet_" data-uid="Ghost.Entities.ComponentSet.op_Equality(Ghost.Entities.ComponentSet,Ghost.Entities.ComponentSet)">
|
|
operator ==(ComponentSet, ComponentSet)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static bool operator ==(ComponentSet left, ComponentSet right)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>left</code> <a class="xref" href="Ghost.Entities.ComponentSet.html">ComponentSet</a></dt>
|
|
<dd></dd>
|
|
<dt><code>right</code> <a class="xref" href="Ghost.Entities.ComponentSet.html">ComponentSet</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
<h4 class="section">Returns</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="Ghost_Entities_ComponentSet_op_Inequality_" data-uid="Ghost.Entities.ComponentSet.op_Inequality*"></a>
|
|
|
|
<h3 id="Ghost_Entities_ComponentSet_op_Inequality_Ghost_Entities_ComponentSet_Ghost_Entities_ComponentSet_" data-uid="Ghost.Entities.ComponentSet.op_Inequality(Ghost.Entities.ComponentSet,Ghost.Entities.ComponentSet)">
|
|
operator !=(ComponentSet, ComponentSet)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static bool operator !=(ComponentSet left, ComponentSet right)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>left</code> <a class="xref" href="Ghost.Entities.ComponentSet.html">ComponentSet</a></dt>
|
|
<dd></dd>
|
|
<dt><code>right</code> <a class="xref" href="Ghost.Entities.ComponentSet.html">ComponentSet</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
<h4 class="section">Returns</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
|
|
<div class="contribution d-print-none">
|
|
</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>
|