UNPKG

scrawl-canvas

Version:
221 lines (188 loc) 14.1 kB
<!DOCTYPE html> <html> <head> <title>Scrawl-canvas</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <meta name="viewport" content="width=device-width, target-densitydpi=160dpi, initial-scale=1.0; maximum-scale=1.0; user-scalable=0;"> <link rel="stylesheet" media="all" href="../docco.css" /> </head> <body> <div id="container"> <div id="background"></div> <ul class="sections"> <li id="section-1"> <div class="annotation"> <div class="sswrap "> <a class="ss" href="#section-1">&#x00a7;</a> </div> <h1 id="scrawl-canvas">Scrawl-canvas</h1> <h4 id="version-894---19-nov-2022">Version 8.9.4 - 19 Nov 2022</h4> <hr> </div> </li> <li id="section-2"> <div class="annotation"> <div class="sswrap "> <a class="ss" href="#section-2">&#x00a7;</a> </div> <p>The MIT License (MIT)</p> <p>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:</p> <p>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.</p> <p>THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</p> <hr> </div> </li> <li id="section-3"> <div class="annotation"> <div class="sswrap "> <a class="ss" href="#section-3">&#x00a7;</a> </div> </div> </li> <li id="section-4"> <div class="annotation"> <div class="sswrap "> <a class="ss" href="#section-4">&#x00a7;</a> </div> <h2 id="initialize-scrawl-canvas">Initialize Scrawl-canvas</h2> </div> <div class="content"><div class='highlight'><pre><span class="hljs-keyword">import</span> { init <span class="hljs-keyword">as</span> _init } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./core/init.js&#x27;</span>; <span class="hljs-keyword">export</span> <span class="hljs-keyword">const</span> init = _init; <span class="hljs-keyword">if</span> (<span class="hljs-keyword">typeof</span> <span class="hljs-variable language_">window</span> !== <span class="hljs-string">&#x27;undefined&#x27;</span>) <span class="hljs-title function_">_init</span>();</pre></div></div> </li> <li id="section-5"> <div class="annotation"> <div class="sswrap "> <a class="ss" href="#section-5">&#x00a7;</a> </div> <h2 id="export-scrawl-canvas-module-functions">Export Scrawl-canvas module functions</h2> </div> <div class="content"><div class='highlight'><pre><span class="hljs-keyword">export</span> { startCoreAnimationLoop, stopCoreAnimationLoop, } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./core/animationloop.js&#x27;</span>; <span class="hljs-keyword">export</span> { addStack, getStack, addCanvas, getCanvas, setCurrentCanvas, clear, compile, show, render, } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./core/document.js&#x27;</span>; <span class="hljs-keyword">export</span> { addListener, removeListener, addNativeListener, removeNativeListener, makeAnimationObserver, getPixelRatio, setPixelRatioChangeAction, getIgnorePixelRatio, setIgnorePixelRatio, } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./core/events.js&#x27;</span>; <span class="hljs-keyword">export</span> * <span class="hljs-keyword">as</span> library <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./core/library.js&#x27;</span>; <span class="hljs-keyword">export</span> { seededRandomNumberGenerator } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./core/random-seed.js&#x27;</span>; <span class="hljs-keyword">export</span> { makeSnippet } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./core/snippets.js&#x27;</span>; <span class="hljs-keyword">export</span> { currentCorePosition, startCoreListeners, stopCoreListeners, observeAndUpdate, forceUpdate, makeDragZone, makeKeyboardZone, getTouchActionChoke, setTouchActionChoke, } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./core/userInteraction.js&#x27;</span>; <span class="hljs-keyword">export</span> { makeAction } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./factory/action.js&#x27;</span>; <span class="hljs-keyword">export</span> { makeAnimation } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./factory/animation.js&#x27;</span>; <span class="hljs-keyword">export</span> { makeBlock } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./factory/block.js&#x27;</span>; <span class="hljs-keyword">export</span> { makeBezier } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./factory/bezier.js&#x27;</span>; <span class="hljs-keyword">export</span> { makeCog } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./factory/cog.js&#x27;</span>; <span class="hljs-keyword">export</span> { makeColor } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./factory/color.js&#x27;</span>; <span class="hljs-keyword">export</span> { makeConicGradient } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./factory/conicGradient.js&#x27;</span>; <span class="hljs-keyword">export</span> { requestCoordinate, releaseCoordinate, } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./factory/coordinate.js&#x27;</span>; <span class="hljs-keyword">export</span> { makeCrescent } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./factory/crescent.js&#x27;</span>; <span class="hljs-keyword">export</span> { makeElement } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./factory/element.js&#x27;</span>; <span class="hljs-keyword">export</span> { makeEmitter } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./factory/emitter.js&#x27;</span>; <span class="hljs-keyword">export</span> { makeFilter } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./factory/filter.js&#x27;</span>; <span class="hljs-keyword">export</span> { setFilterMemoizationChoke } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./factory/filterEngine.js&#x27;</span>; <span class="hljs-keyword">export</span> { makeForce } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./factory/particleForce.js&#x27;</span>; <span class="hljs-keyword">export</span> { makeGradient } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./factory/gradient.js&#x27;</span>; <span class="hljs-keyword">export</span> { makeGrid } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./factory/grid.js&#x27;</span>; <span class="hljs-keyword">export</span> { makeGroup } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./factory/group.js&#x27;</span>; <span class="hljs-keyword">export</span> { importImage, importDomImage, createImageFromCell, createImageFromGroup, createImageFromEntity, } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./factory/imageAsset.js&#x27;</span>; <span class="hljs-keyword">export</span> { makeLine } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./factory/line.js&#x27;</span>; <span class="hljs-keyword">export</span> { makeLineSpiral } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./factory/lineSpiral.js&#x27;</span>; <span class="hljs-keyword">export</span> { makeLoom } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./factory/loom.js&#x27;</span>; <span class="hljs-keyword">export</span> { makeMesh } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./factory/mesh.js&#x27;</span>; <span class="hljs-keyword">export</span> { makeNet } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./factory/net.js&#x27;</span>; <span class="hljs-keyword">export</span> { makeNoise, makeNoiseAsset, } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./factory/noiseAsset.js&#x27;</span>; <span class="hljs-keyword">export</span> { makeOval } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./factory/oval.js&#x27;</span>; <span class="hljs-keyword">export</span> { makePattern } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./factory/pattern.js&#x27;</span>; <span class="hljs-keyword">export</span> { makePhrase } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./factory/phrase.js&#x27;</span>; <span class="hljs-keyword">export</span> { makePicture } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./factory/picture.js&#x27;</span>; <span class="hljs-keyword">export</span> { makePolygon } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./factory/polygon.js&#x27;</span>; <span class="hljs-keyword">export</span> { makePolyline } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./factory/polyline.js&#x27;</span>; <span class="hljs-keyword">export</span> { makeQuadratic } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./factory/quadratic.js&#x27;</span>; <span class="hljs-keyword">export</span> { requestQuaternion, releaseQuaternion, } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./factory/quaternion.js&#x27;</span>; <span class="hljs-keyword">export</span> { makeRadialGradient } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./factory/radialGradient.js&#x27;</span>; <span class="hljs-keyword">export</span> { makeRawAsset } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./factory/rawAsset.js&#x27;</span>; <span class="hljs-keyword">export</span> { makeReactionDiffusionAsset } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./factory/rdAsset.js&#x27;</span>; <span class="hljs-keyword">export</span> { makeRectangle } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./factory/rectangle.js&#x27;</span>; <span class="hljs-keyword">export</span> { makeRender } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./factory/renderAnimation.js&#x27;</span>; <span class="hljs-keyword">export</span> { makeShape } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./factory/shape.js&#x27;</span>; <span class="hljs-keyword">export</span> { makeSpiral } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./factory/spiral.js&#x27;</span>; <span class="hljs-keyword">export</span> { importSprite } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./factory/spriteAsset.js&#x27;</span>; <span class="hljs-keyword">export</span> { makeSpring } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./factory/particleSpring.js&#x27;</span>; <span class="hljs-keyword">export</span> { makeStar } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./factory/star.js&#x27;</span>; <span class="hljs-keyword">export</span> { makeTetragon } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./factory/tetragon.js&#x27;</span>; <span class="hljs-keyword">export</span> { makeTicker } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./factory/ticker.js&#x27;</span>; <span class="hljs-keyword">export</span> { makeTracer } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./factory/tracer.js&#x27;</span>; <span class="hljs-keyword">export</span> { makeTween } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./factory/tween.js&#x27;</span>; <span class="hljs-keyword">export</span> { requestVector, releaseVector, } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./factory/vector.js&#x27;</span>; <span class="hljs-keyword">export</span> { importDomVideo, importVideo, importMediaStream, } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./factory/videoAsset.js&#x27;</span>; <span class="hljs-keyword">export</span> { makeWheel } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./factory/wheel.js&#x27;</span>; <span class="hljs-keyword">export</span> { makeWorld } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;./factory/particleWorld.js&#x27;</span>;</pre></div></div> </li> </ul> </div> </body> </html>