@prachwal/mandelbrot-generator
Version:
Professional Mandelbrot fractal generator with TypeScript support, interactive web interface, and multiple output formats
25 lines (23 loc) • 12.4 kB
HTML
<html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>getColor | @prachwal/mandelbrot-generator - v1.1.1</title><meta name="description" content="Documentation for @prachwal/mandelbrot-generator"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@prachwal/mandelbrot-generator - v1.1.1</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">getColor</a></li></ul><h1>Function getColor</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getcolor"><span class="tsd-kind-call-signature">getColor</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">iterations</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">maxIterations</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">paletteType</span><span class="tsd-signature-symbol">?:</span> <a href="../types/PaletteType.html" class="tsd-signature-type tsd-kind-type-alias">PaletteType</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../types/RGBColor.html" class="tsd-signature-type tsd-kind-type-alias">RGBColor</a><a href="#getcolor" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Maps iteration count to RGB color using the specified palette</p>
<p>This is the primary function for converting Mandelbrot iteration results into
visual colors. It handles both set membership (black) and iteration-based coloring
with smooth palette transitions.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">iterations</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Number of iterations before the point escaped (0 to maxIterations)</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">maxIterations</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Maximum iterations used in the fractal calculation</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">paletteType</span>: <a href="../types/PaletteType.html" class="tsd-signature-type tsd-kind-type-alias">PaletteType</a><span class="tsd-signature-symbol"> = 'rainbow'</span></span><div class="tsd-comment tsd-typography"><p>Name of the color palette to use (default: 'rainbow')</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../types/RGBColor.html" class="tsd-signature-type tsd-kind-type-alias">RGBColor</a></h4><p>RGB color as [red, green, blue] array with values 0-255</p>
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example">Example<a href="#example" 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></h4><pre><code class="typescript"><span class="hl-6">import</span><span class="hl-2"> { </span><span class="hl-7">getColor</span><span class="hl-2"> } </span><span class="hl-6">from</span><span class="hl-2"> </span><span class="hl-3">'./colors.js'</span><span class="hl-2">;</span><br/><br/><span class="hl-0">// Points in the set are black</span><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-8">setColor</span><span class="hl-2"> = </span><span class="hl-1">getColor</span><span class="hl-2">(</span><span class="hl-5">1000</span><span class="hl-2">, </span><span class="hl-5">1000</span><span class="hl-2">, </span><span class="hl-3">'rainbow'</span><span class="hl-2">); </span><span class="hl-0">// [0, 0, 0]</span><br/><br/><span class="hl-0">// Points outside get colored by iteration count</span><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-8">escapeColor</span><span class="hl-2"> = </span><span class="hl-1">getColor</span><span class="hl-2">(</span><span class="hl-5">50</span><span class="hl-2">, </span><span class="hl-5">1000</span><span class="hl-2">, </span><span class="hl-3">'fire'</span><span class="hl-2">); </span><span class="hl-0">// Warm color</span><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-8">quickEscape</span><span class="hl-2"> = </span><span class="hl-1">getColor</span><span class="hl-2">(</span><span class="hl-5">5</span><span class="hl-2">, </span><span class="hl-5">1000</span><span class="hl-2">, </span><span class="hl-3">'cool'</span><span class="hl-2">); </span><span class="hl-0">// Cool color</span><br/><br/><span class="hl-0">// Different palettes for same iteration</span><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-8">rainbow</span><span class="hl-2"> = </span><span class="hl-1">getColor</span><span class="hl-2">(</span><span class="hl-5">100</span><span class="hl-2">, </span><span class="hl-5">500</span><span class="hl-2">, </span><span class="hl-3">'rainbow'</span><span class="hl-2">);</span><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-8">fire</span><span class="hl-2"> = </span><span class="hl-1">getColor</span><span class="hl-2">(</span><span class="hl-5">100</span><span class="hl-2">, </span><span class="hl-5">500</span><span class="hl-2">, </span><span class="hl-3">'fire'</span><span class="hl-2">);</span><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-8">ocean</span><span class="hl-2"> = </span><span class="hl-1">getColor</span><span class="hl-2">(</span><span class="hl-5">100</span><span class="hl-2">, </span><span class="hl-5">500</span><span class="hl-2">, </span><span class="hl-3">'ocean'</span><span class="hl-2">);</span>
</code><button type="button">Copy</button></pre>
</div><div class="tsd-tag-algorithm"><h4 class="tsd-anchor-link" id="algorithm">Algorithm<a href="#algorithm" 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></h4><ol>
<li>If iterations >= maxIterations, return black (point in set)</li>
<li>Calculate normalized position in palette (0.0 to 1.0)</li>
<li>Map to palette index and return corresponding color</li>
<li>Handle edge cases and palette boundaries</li>
</ol>
</div><div class="tsd-tag-performance"><h4 class="tsd-anchor-link" id="performance">Performance<a href="#performance" 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></h4><p>O(1) - constant time color lookup</p>
</div><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see">See<a href="#see" 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></h4><ul>
<li><a href="../variables/colorPalettes.html" class="tsd-kind-variable">colorPalettes</a> for available palette options</li>
<li><a href="getColorHex.html" class="tsd-kind-function">getColorHex</a> for hexadecimal color output</li>
</ul>
</div><div class="tsd-tag-since"><h4 class="tsd-anchor-link" id="since">Since<a href="#since" 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></h4><p>1.0.0</p>
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/prachwal/mandelbrot-generator/blob/da157e1b866785501d38ccb7552859d4482dd1a8/src/colors.ts#L288">colors.ts:288</a></li></ul></aside></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@prachwal/mandelbrot-generator - v1.1.1</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>