@prachwal/mandelbrot-generator
Version:
Professional Mandelbrot fractal generator with TypeScript support, interactive web interface, and multiple output formats
21 lines (19 loc) • 11.6 kB
HTML
<html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>generateMandelbrotData | @prachwal/mandelbrot-generator - v1.0.0</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></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.0.0</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">generateMandelbrotData</a></li></ul><h1>Function generateMandelbrotData</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="generatemandelbrotdata"><span class="tsd-kind-call-signature">generateMandelbrotData</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/MandelbrotConfig.html" class="tsd-signature-type tsd-kind-interface">MandelbrotConfig</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Uint8ClampedArray</span><a href="#generatemandelbrotdata" 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>Generates RGBA image data for the complete Mandelbrot fractal</p>
<p>This function creates a pixel-by-pixel representation of the Mandelbrot set
by sampling each point in the complex plane and computing its escape time.
The resulting iteration counts are mapped to colors using the specified palette.</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">config</span>: <a href="../interfaces/MandelbrotConfig.html" class="tsd-signature-type tsd-kind-interface">MandelbrotConfig</a></span><div class="tsd-comment tsd-typography"><p>Complete configuration object for fractal generation</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Uint8ClampedArray</span></h4><p>Uint8ClampedArray containing RGBA pixel data (4 bytes per pixel)</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">generateMandelbrotData</span><span class="hl-2"> } </span><span class="hl-6">from</span><span class="hl-2"> </span><span class="hl-3">'./mandelbrot.js'</span><span class="hl-2">;</span><br/><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-8">config</span><span class="hl-2">: </span><span class="hl-9">MandelbrotConfig</span><span class="hl-2"> = {</span><br/><span class="hl-2"> </span><span class="hl-7">width:</span><span class="hl-2"> </span><span class="hl-5">800</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-7">height:</span><span class="hl-2"> </span><span class="hl-5">600</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-7">centerX:</span><span class="hl-2"> -</span><span class="hl-5">0.5</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-7">centerY:</span><span class="hl-2"> </span><span class="hl-5">0</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-7">zoom:</span><span class="hl-2"> </span><span class="hl-5">1</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-7">maxIterations:</span><span class="hl-2"> </span><span class="hl-5">100</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-7">escapeRadius:</span><span class="hl-2"> </span><span class="hl-5">2</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-7">colorPalette:</span><span class="hl-2"> </span><span class="hl-3">'classic'</span><br/><span class="hl-2">};</span><br/><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-8">imageData</span><span class="hl-2"> = </span><span class="hl-1">generateMandelbrotData</span><span class="hl-2">(</span><span class="hl-7">config</span><span class="hl-2">);</span><br/><span class="hl-0">// imageData is ready to be used with Canvas ImageData constructor</span><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-8">canvas</span><span class="hl-2"> = </span><span class="hl-7">document</span><span class="hl-2">.</span><span class="hl-1">getElementById</span><span class="hl-2">(</span><span class="hl-3">'canvas'</span><span class="hl-2">) </span><span class="hl-6">as</span><span class="hl-2"> </span><span class="hl-9">HTMLCanvasElement</span><span class="hl-2">;</span><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-8">ctx</span><span class="hl-2"> = </span><span class="hl-7">canvas</span><span class="hl-2">.</span><span class="hl-1">getContext</span><span class="hl-2">(</span><span class="hl-3">'2d'</span><span class="hl-2">)!;</span><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-8">imgData</span><span class="hl-2"> = </span><span class="hl-4">new</span><span class="hl-2"> </span><span class="hl-1">ImageData</span><span class="hl-2">(</span><span class="hl-7">imageData</span><span class="hl-2">, </span><span class="hl-7">config</span><span class="hl-2">.</span><span class="hl-7">width</span><span class="hl-2">, </span><span class="hl-7">config</span><span class="hl-2">.</span><span class="hl-7">height</span><span class="hl-2">);</span><br/><span class="hl-7">ctx</span><span class="hl-2">.</span><span class="hl-1">putImageData</span><span class="hl-2">(</span><span class="hl-7">imgData</span><span class="hl-2">, </span><span class="hl-5">0</span><span class="hl-2">, </span><span class="hl-5">0</span><span class="hl-2">);</span>
</code><button type="button">Copy</button></pre>
</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><ul>
<li>Time complexity: O(width × height × average_iterations)</li>
<li>Space complexity: O(width × height) for output array</li>
<li>Optimized for typical fractal viewing with escape radius = 2</li>
</ul>
</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="calculateBounds.html" class="tsd-kind-function">calculateBounds</a> for coordinate system mapping</li>
<li><a href="getColor.html" class="tsd-kind-function">getColor</a> for color palette application</li>
<li><a href="mandelbrotIteration.html" class="tsd-kind-function">mandelbrotIteration</a> for core iteration algorithm</li>
</ul>
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/prachwal/mandelbrot-generator/blob/ae4cb4d8557fb6cf7109ede31bd9f1389eec74e6/src/mandelbrot.ts#L125">mandelbrot.ts:125</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.0.0</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>