1 line
14 KiB
JavaScript
1 line
14 KiB
JavaScript
import{_ as a,c as r,a0 as t,o as i}from"./chunks/framework.P9qPzDnn.js";const p=JSON.parse('{"title":"Interface: Particles","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/features/particles/particles/interfaces/Particles.md","filePath":"api/features/particles/particles/interfaces/Particles.md","lastUpdated":null}'),o={name:"api/features/particles/particles/interfaces/Particles.md"};function n(s,e,c,l,d,h){return i(),r("div",null,e[0]||(e[0]=[t('<p><a href="./../../../../">Profectus</a> / <a href="./../">features/particles/particles</a> / Particles</p><h1 id="interface-particles" tabindex="-1">Interface: Particles <a class="header-anchor" href="#interface-particles" aria-label="Permalink to "Interface: Particles""></a></h1><p>An object that represents a feature that display particle effects on the screen. The config should typically be gotten by designing the effect using the <a href="https://pixijs.io/pixi-particles-editor/" target="_blank" rel="noreferrer">online particle effect editor</a> and passing it into the <a href="./../../../../main/interfaces/Window">upgradeConfig</a> from @pixi/particle-emitter.</p><h2 id="extends" tabindex="-1">Extends <a class="header-anchor" href="#extends" aria-label="Permalink to "Extends""></a></h2><ul><li><a href="./../../../../util/vue/interfaces/VueFeature"><code>VueFeature</code></a></li></ul><h2 id="properties" tabindex="-1">Properties <a class="header-anchor" href="#properties" aria-label="Permalink to "Properties""></a></h2><h3 id="vuefeature" tabindex="-1">[VueFeature] <a class="header-anchor" href="#vuefeature" aria-label="Permalink to "\\[VueFeature\\]""></a></h3><blockquote><p><strong>[VueFeature]</strong>: <code>true</code></p></blockquote><p>Used to identify Vue Features</p><h4 id="inherited-from" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from" aria-label="Permalink to "Inherited from""></a></h4><p><a href="./../../../../util/vue/interfaces/VueFeature"><code>VueFeature</code></a>.<a href="./../../../../util/vue/interfaces/VueFeature#[vuefeature]"><code>[VueFeature]</code></a></p><h4 id="defined-in" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/util/vue.tsx#L43" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:43</a></p><hr><h3 id="addemitter" tabindex="-1">addEmitter() <a class="header-anchor" href="#addemitter" aria-label="Permalink to "addEmitter()""></a></h3><blockquote><p><strong>addEmitter</strong>: (<code>config</code>) => <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" target="_blank" rel="noreferrer"><code>Promise</code></a><<code>Emitter</code>></p></blockquote><p>A function to asynchronously add an emitter to the canvas. The returned emitter can then be positioned as appropriate and started.</p><h4 id="parameters" tabindex="-1">Parameters <a class="header-anchor" href="#parameters" aria-label="Permalink to "Parameters""></a></h4><h5 id="config" tabindex="-1">config <a class="header-anchor" href="#config" aria-label="Permalink to "config""></a></h5><p><code>EmitterConfigV3</code></p><h4 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-label="Permalink to "Returns""></a></h4><p><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" target="_blank" rel="noreferrer"><code>Promise</code></a><<code>Emitter</code>></p><h4 id="see" tabindex="-1">See <a class="header-anchor" href="#see" aria-label="Permalink to "See""></a></h4><p><a href="./Particles">Particles</a></p><h4 id="defined-in-1" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-1" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/features/particles/particles.tsx#L39" target="_blank" rel="noreferrer">profectus/src/features/particles/particles.tsx:39</a></p><hr><h3 id="app" tabindex="-1">app <a class="header-anchor" href="#app" aria-label="Permalink to "app""></a></h3><blockquote><p><strong>app</strong>: <a href="https://vuejs.org/guide/typescript/composition-api.html#typing-ref" target="_blank" rel="noreferrer"><code>Ref</code></a><<code>null</code> | <code>Application</code>, <code>null</code> | <code>Application</code>></p></blockquote><p>The Pixi.JS Application powering this particles canvas.</p><h4 id="defined-in-2" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-2" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/features/particles/particles.tsx#L33" target="_blank" rel="noreferrer">profectus/src/features/particles/particles.tsx:33</a></p><hr><h3 id="classes" tabindex="-1">classes? <a class="header-anchor" href="#classes" aria-label="Permalink to "classes?""></a></h3><blockquote><p><code>optional</code> <strong>classes</strong>: <a href="https://vuejs.org/api/utility-types.html#mayberef" target="_blank" rel="noreferrer"><code>MaybeRef</code></a><<a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type" target="_blank" rel="noreferrer"><code>Record</code></a><<code>string</code>, <code>boolean</code>>></p></blockquote><p>Dictionary of CSS classes to apply to this feature.</p><h4 id="inherited-from-1" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from-1" aria-label="Permalink to "Inherited from""></a></h4><p><a href="./../../../../util/vue/interfaces/VueFeature"><code>VueFeature</code></a>.<a href="./../../../../util/vue/interfaces/VueFeature#classes"><code>classes</code></a></p><h4 id="defined-in-3" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-3" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/util/vue.tsx#L35" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:35</a></p><hr><h3 id="components" tabindex="-1">components <a class="header-anchor" href="#components" aria-label="Permalink to "components""></a></h3><blockquote><p><strong>components</strong>: <a href="./../../../../util/computed/type-aliases/MaybeGetter"><code>MaybeGetter</code></a><<a href="./../../../../util/vue/type-aliases/Renderable"><code>Renderable</code></a>>[]</p></blockquote><p>The components to render inside the vue feature</p><h4 id="inherited-from-2" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from-2" aria-label="Permalink to "Inherited from""></a></h4><p><a href="./../../../../util/vue/interfaces/VueFeature"><code>VueFeature</code></a>.<a href="./../../../../util/vue/interfaces/VueFeature#components"><code>components</code></a></p><h4 id="defined-in-4" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-4" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/util/vue.tsx#L39" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:39</a></p><hr><h3 id="id" tabindex="-1">id <a class="header-anchor" href="#id" aria-label="Permalink to "id""></a></h3><blockquote><p><strong>id</strong>: <code>string</code></p></blockquote><p>An auto-generated ID for identifying features that appear in the DOM. Will not persist between refreshes or updates.</p><h4 id="inherited-from-3" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from-3" aria-label="Permalink to "Inherited from""></a></h4><p><a href="./../../../../util/vue/interfaces/VueFeature"><code>VueFeature</code></a>.<a href="./../../../../util/vue/interfaces/VueFeature#id"><code>id</code></a></p><h4 id="defined-in-5" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-5" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/util/vue.tsx#L31" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:31</a></p><hr><h3 id="oncontainerresized" tabindex="-1">onContainerResized()? <a class="header-anchor" href="#oncontainerresized" aria-label="Permalink to "onContainerResized()?""></a></h3><blockquote><p><code>optional</code> <strong>onContainerResized</strong>: (<code>boundingRect</code>) => <code>void</code></p></blockquote><p>A function that is called when the particles canvas is resized.</p><h4 id="parameters-1" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-1" aria-label="Permalink to "Parameters""></a></h4><h5 id="boundingrect" tabindex="-1">boundingRect <a class="header-anchor" href="#boundingrect" aria-label="Permalink to "boundingRect""></a></h5><p><a href="https://developer.mozilla.org/docs/Web/API/DOMRect" target="_blank" rel="noreferrer"><code>DOMRect</code></a></p><h4 id="returns-1" tabindex="-1">Returns <a class="header-anchor" href="#returns-1" aria-label="Permalink to "Returns""></a></h4><p><code>void</code></p><h4 id="defined-in-6" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-6" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/features/particles/particles.tsx#L29" target="_blank" rel="noreferrer">profectus/src/features/particles/particles.tsx:29</a></p><hr><h3 id="onhotreload" tabindex="-1">onHotReload? <a class="header-anchor" href="#onhotreload" aria-label="Permalink to "onHotReload?""></a></h3><blockquote><p><code>optional</code> <strong>onHotReload</strong>: <code>VoidFunction</code></p></blockquote><p>A function that is called whenever the particles element is reloaded during development. For restarting particle effects.</p><h4 id="defined-in-7" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-7" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/features/particles/particles.tsx#L31" target="_blank" rel="noreferrer">profectus/src/features/particles/particles.tsx:31</a></p><hr><h3 id="style" tabindex="-1">style? <a class="header-anchor" href="#style" aria-label="Permalink to "style?""></a></h3><blockquote><p><code>optional</code> <strong>style</strong>: <a href="https://vuejs.org/api/utility-types.html#mayberef" target="_blank" rel="noreferrer"><code>MaybeRef</code></a><<a href="https://vuejs.org/api/utility-types.html#cssproperties" target="_blank" rel="noreferrer"><code>CSSProperties</code></a>></p></blockquote><p>CSS to apply to this feature.</p><h4 id="inherited-from-4" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from-4" aria-label="Permalink to "Inherited from""></a></h4><p><a href="./../../../../util/vue/interfaces/VueFeature"><code>VueFeature</code></a>.<a href="./../../../../util/vue/interfaces/VueFeature#style"><code>style</code></a></p><h4 id="defined-in-8" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-8" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/util/vue.tsx#L37" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:37</a></p><hr><h3 id="type" tabindex="-1">type <a class="header-anchor" href="#type" aria-label="Permalink to "type""></a></h3><blockquote><p><strong>type</strong>: <em>typeof</em> <a href="./../variables/ParticlesType"><code>ParticlesType</code></a></p></blockquote><p>A symbol that helps identify features of the same type.</p><h4 id="defined-in-9" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-9" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/features/particles/particles.tsx#L41" target="_blank" rel="noreferrer">profectus/src/features/particles/particles.tsx:41</a></p><hr><h3 id="visibility" tabindex="-1">visibility? <a class="header-anchor" href="#visibility" aria-label="Permalink to "visibility?""></a></h3><blockquote><p><code>optional</code> <strong>visibility</strong>: <a href="https://vuejs.org/api/utility-types.html#mayberef" target="_blank" rel="noreferrer"><code>MaybeRef</code></a><boolean | Visibility></p></blockquote><p>Whether this feature should be visible.</p><h4 id="inherited-from-5" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from-5" aria-label="Permalink to "Inherited from""></a></h4><p><a href="./../../../../util/vue/interfaces/VueFeature"><code>VueFeature</code></a>.<a href="./../../../../util/vue/interfaces/VueFeature#visibility"><code>visibility</code></a></p><h4 id="defined-in-10" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-10" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/util/vue.tsx#L33" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:33</a></p><hr><h3 id="wrappers" tabindex="-1">wrappers <a class="header-anchor" href="#wrappers" aria-label="Permalink to "wrappers""></a></h3><blockquote><p><strong>wrappers</strong>: <a href="./../../../../util/vue/type-aliases/Wrapper"><code>Wrapper</code></a>[]</p></blockquote><p>The components to render wrapped around the vue feature</p><h4 id="inherited-from-6" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from-6" aria-label="Permalink to "Inherited from""></a></h4><p><a href="./../../../../util/vue/interfaces/VueFeature"><code>VueFeature</code></a>.<a href="./../../../../util/vue/interfaces/VueFeature#wrappers"><code>wrappers</code></a></p><h4 id="defined-in-11" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-11" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/util/vue.tsx#L41" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:41</a></p>',103)]))}const f=a(o,[["render",n]]);export{p as __pageData,f as default};
|