Update doc gen
This commit is contained in:
parent
262ce6a5be
commit
b390a04667
4 changed files with 285 additions and 1398 deletions
|
|
@ -14,10 +14,10 @@
|
|||
<section class="tsd-panel tsd-comment">
|
||||
<div class="tsd-comment tsd-typography"><p>Used for containing the required information to compile drawables into
|
||||
shader code.</p>
|
||||
<p>Each [[Drawable]] must have a static property of this type, called descriptor.</p>
|
||||
<p>Each <a href="../classes/drawables_drawable.Drawable.html" class="tsd-kind-class">drawables/drawable!Drawable</a> must have a static property of this type, called descriptor.</p>
|
||||
<p>For more information on how to create your own DrawableDescriptors, look at the
|
||||
<a href="https://sdf-2d-docs.schmelczer.dev/index.html#custom-drawable-example">complete custom drawable example</a>,
|
||||
or the code of [[CircleFactory]] or [[InvertedTunnelFactory]].</p>
|
||||
or the code of <a href="../functions/drawables_shapes_circle-factory.CircleFactory.html" class="tsd-kind-function">drawables/shapes/circle-factory!CircleFactory</a> or <a href="../functions/drawables_shapes_inverted-tunnel-factory.InvertedTunnelFactory.html" class="tsd-kind-function">drawables/shapes/inverted-tunnel-factory!InvertedTunnelFactory</a>.</p>
|
||||
</div></section>
|
||||
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">DrawableDescriptor</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#empty">empty</a><span class="tsd-signature-symbol">:</span> <a href="../classes/drawables_drawable.Drawable.html" class="tsd-signature-type tsd-kind-class">Drawable</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#objectcountscaler">objectCountScaler</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#propertyuniformmapping">propertyUniformMapping</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-signature-symbol">[</span><span class="tsd-kind-index-signature">property</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#sdf">sdf</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">distanceFunctionName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">isInverted</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">shader</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#shadercombinationsteps">shaderCombinationSteps</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#uniformcountmacroname">uniformCountMacroName</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources">
|
||||
<ul>
|
||||
|
|
@ -59,7 +59,7 @@ the value of <code>empty</code> is used to pad out arrays.</p>
|
|||
<section class="tsd-panel tsd-member">
|
||||
<h3 class="tsd-anchor-link" id="propertyuniformmapping"><span>property<wbr/>Uniform<wbr/>Mapping</span><a href="#propertyuniformmapping" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
||||
<div class="tsd-signature"><span class="tsd-kind-property">propertyUniformMapping</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-signature-symbol">[</span><span class="tsd-kind-index-signature">property</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span></div>
|
||||
<div class="tsd-comment tsd-typography"><p>An object describing the relationship between the object returned by a [[Drawable]]'s
|
||||
<div class="tsd-comment tsd-typography"><p>An object describing the relationship between the object returned by a <a href="../classes/drawables_drawable.Drawable.html" class="tsd-kind-class">drawables/drawable!Drawable</a>'s
|
||||
getObjectToSerialize and the name of the arrays used in the GLSL code.</p>
|
||||
</div><aside class="tsd-sources">
|
||||
<ul>
|
||||
|
|
@ -76,7 +76,7 @@ getObjectToSerialize and the name of the arrays used in the GLSL code.</p>
|
|||
<h5><span class="tsd-kind-property">distanceFunctionName</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
||||
<div class="tsd-comment tsd-typography"><p>The name of the function defined in the value of <code>shader</code>.
|
||||
Its signature must be:</p>
|
||||
<pre><code class="glsl">float distanceFunction(in vec2 target, out vec4 color)
|
||||
<pre><code class="glsl"><span class="hl-4">float</span><span class="hl-1"> </span><span class="hl-8">distanceFunction</span><span class="hl-1">(in vec2 </span><span class="hl-2">target</span><span class="hl-1">, out vec4 </span><span class="hl-2">color</span><span class="hl-1">)</span>
|
||||
</code><button type="button">Copy</button></pre>
|
||||
|
||||
<p>Replace <code>distanceFunction</code> with the name given here. Return the signed
|
||||
|
|
|
|||
|
|
@ -87,7 +87,7 @@
|
|||
<ul class="tsd-parameter-list">
|
||||
<li><span><span class="tsd-kind-parameter">drawable</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#adddrawablet">T</a></span>
|
||||
<div class="tsd-comment tsd-typography"><p>Must be a subclass of drawable and its class must contain a
|
||||
static descriptor property of type [[DrawableDescriptor]].</p>
|
||||
static descriptor property of type <a href="drawables_drawable-descriptor.DrawableDescriptor.html" class="tsd-kind-interface">drawables/drawable-descriptor!DrawableDescriptor</a>.</p>
|
||||
</div></li></ul></div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
||||
<ul>
|
||||
|
|
|
|||
|
|
@ -14,9 +14,9 @@
|
|||
<section class="tsd-panel tsd-comment">
|
||||
<div class="tsd-comment tsd-typography"><p>Interface for a configuration object containing the settings
|
||||
that can be changed during runtime.</p>
|
||||
<p>The default values for RuntimeSettings can be found in [[defaultRuntimeSettings]].</p>
|
||||
<p>The default values for RuntimeSettings can be found in <a href="../variables/graphics_rendering_settings_default-runtime-settings.defaultRuntimeSettings.html" class="tsd-kind-variable">graphics/rendering/settings/default-runtime-settings!defaultRuntimeSettings</a>.</p>
|
||||
</div></section>
|
||||
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">RuntimeSettings</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#ambientlight">ambientLight</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">vec3</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#colorpalette">colorPalette</a><span class="tsd-signature-symbol">:</span> (<br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">IndexedCollection</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span><br/> )<span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#distancerenderscale">distanceRenderScale</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#enablehighdpirendering">enableHighDpiRendering</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#isworldinverted">isWorldInverted</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#lightcutoffdistance">lightCutoffDistance</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#lightsrenderscale">lightsRenderScale</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#motionblur">motionBlur</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#textures">textures</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-signature-symbol">[</span><span class="tsd-kind-index-signature">textureName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-type">TexImageSource</span> <span class="tsd-signature-symbol">|</span> <a href="../types/graphics_graphics-library_texture_texture-options.TextureWithOptions.html" class="tsd-signature-type tsd-kind-type-alias">TextureWithOptions</a> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#tilemultiplier">tileMultiplier</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources">
|
||||
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">RuntimeSettings</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#ambientlight">ambientLight</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">vec3</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#colorpalette">colorPalette</a><span class="tsd-signature-symbol">:</span> (<br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">IndexedCollection</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span><br/> )<span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#distancerenderscale">distanceRenderScale</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#enablehighdpirendering">enableHighDpiRendering</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#isworldinverted">isWorldInverted</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#lightcutoffdistance">lightCutoffDistance</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#lightsrenderscale">lightsRenderScale</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#motionblur">motionBlur</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#textures">textures</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-signature-symbol">[</span><span class="tsd-kind-index-signature">textureName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <a href="../types/graphics_graphics-library_texture_texture-options.TextureWithOptions.html" class="tsd-signature-type tsd-kind-type-alias">TextureWithOptions</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">TexImageSource</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#tilemultiplier">tileMultiplier</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in graphics/rendering/settings/runtime-settings.ts:10</li></ul></aside>
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
|
|
@ -52,7 +52,7 @@ that can be changed during runtime.</p>
|
|||
<div class="tsd-signature"><span class="tsd-kind-property">colorPalette</span><span class="tsd-signature-symbol">:</span> (<br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">IndexedCollection</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span><br/>)<span class="tsd-signature-symbol">[]</span></div>
|
||||
<div class="tsd-comment tsd-typography"><p>The possible colors for the objects. Each color is referenced by its index in the
|
||||
palette.</p>
|
||||
<p>Its length should be less than the <code>paletteSize</code> specified in [[StartupSettings]].</p>
|
||||
<p>Its length should be less than the <code>paletteSize</code> specified in <a href="graphics_rendering_settings_startup-settings.StartupSettings.html" class="tsd-kind-interface">graphics/rendering/settings/startup-settings!StartupSettings</a>.</p>
|
||||
<p>Colors can have transparency, but only if WebGL2 support is enabled.</p>
|
||||
</div><aside class="tsd-sources">
|
||||
<ul>
|
||||
|
|
@ -110,11 +110,11 @@ and values just below 1 mean an extreme amount of motion blur.</p>
|
|||
<li>Defined in graphics/rendering/settings/runtime-settings.ts:74</li></ul></aside></section>
|
||||
<section class="tsd-panel tsd-member">
|
||||
<h3 class="tsd-anchor-link" id="textures"><span>textures</span><a href="#textures" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
||||
<div class="tsd-signature"><span class="tsd-kind-property">textures</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-signature-symbol">[</span><span class="tsd-kind-index-signature">textureName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-type">TexImageSource</span> <span class="tsd-signature-symbol">|</span> <a href="../types/graphics_graphics-library_texture_texture-options.TextureWithOptions.html" class="tsd-signature-type tsd-kind-type-alias">TextureWithOptions</a> <span class="tsd-signature-symbol">}</span></div>
|
||||
<div class="tsd-signature"><span class="tsd-kind-property">textures</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-signature-symbol">[</span><span class="tsd-kind-index-signature">textureName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <a href="../types/graphics_graphics-library_texture_texture-options.TextureWithOptions.html" class="tsd-signature-type tsd-kind-type-alias">TextureWithOptions</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">TexImageSource</span> <span class="tsd-signature-symbol">}</span></div>
|
||||
<div class="tsd-comment tsd-typography"><p>It is possible to use your own textures in your SDF definitions.</p>
|
||||
<p>The keys of the object should be the names used to reference them in the GLSL code,
|
||||
and the values should be the textures themselves, or a TextureWithOptions specifying
|
||||
the texture's [[TextureOptions]].
|
||||
the texture's <a href="graphics_graphics-library_texture_texture-options.TextureOptions.html" class="tsd-kind-interface">graphics/graphics-library/texture/texture-options!TextureOptions</a>.
|
||||
A texture can be a canvas, an img element, an Image, and so on.</p>
|
||||
</div><aside class="tsd-sources">
|
||||
<ul>
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@
|
|||
<section class="tsd-panel tsd-comment">
|
||||
<div class="tsd-comment tsd-typography"><p>Interface for a configuration object containing the settings
|
||||
that need to be given before shader compilation.</p>
|
||||
<p>The default values for StartupSettings can be found in [[defaultStartupSettings]].</p>
|
||||
<p>The default values for StartupSettings can be found in <a href="../variables/graphics_rendering_settings_default-startup-settings.defaultStartupSettings.html" class="tsd-kind-variable">graphics/rendering/settings/default-startup-settings!defaultStartupSettings</a>.</p>
|
||||
</div></section>
|
||||
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">StartupSettings</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#backgroundcolor">backgroundColor</a><span class="tsd-signature-symbol">:</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">IndexedCollection</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#enablecontextlostsimulator">enableContextLostSimulator</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#enablestopwatch">enableStopwatch</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#ignorewebgl2">ignoreWebGL2</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#lightoverlapreduction">lightOverlapReduction</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#lightpenetrationratio">lightPenetrationRatio</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#palettesize">paletteSize</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#shadowtracecount">shadowTraceCount</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources">
|
||||
<ul>
|
||||
|
|
|
|||
Loading…
Reference in a new issue