123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357 |
- <!DOCTYPE html>
- <html lang="en">
- <head>
- <meta charset="utf-8">
- <title>JSDoc: Class: Mask</title>
- <script src="scripts/prettify/prettify.js"> </script>
- <script src="scripts/prettify/lang-css.js"> </script>
- <!--[if lt IE 9]>
- <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
- <![endif]-->
- <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
- <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
- </head>
- <body>
- <div id="main">
- <h1 class="page-title">Class: Mask</h1>
-
- <section>
- <header>
-
- <h2><span class="attribs"><span class="type-signature"></span></span>Mask<span class="signature">()</span><span class="type-signature"></span></h2>
-
-
- </header>
- <article>
- <div class="container-overview">
-
-
-
-
- <h4 class="name" id="Mask"><span class="type-signature"></span>new Mask<span class="signature">()</span><span class="type-signature"></span></h4>
-
-
- <div class="description">
- A mask can be used to set the drawing region.
Masks are treated as objects their shape is used to filter other objects shape.
Multiple mask objects can be active simulatenously, they have to be attached to the object mask list to filter the render region.
- </div>
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="mask_Mask.js.html">mask/Mask.js</a>, <a href="mask_Mask.js.html#line16">line 16</a>
- </li></ul></dd>
-
-
-
-
- </dl>
-
- </div>
-
-
-
-
-
-
-
-
- <h3 class="subsection-title">Methods</h3>
-
-
-
-
- <h4 class="name" id="clip"><span class="type-signature"></span>clip<span class="signature">(context, viewport, canvas)</span><span class="type-signature"></span></h4>
-
-
- <div class="description">
- Clip the canvas context, to ensure that next objects being drawn are cliped to the path stored here.
- </div>
- <h5>Parameters:</h5>
-
- <table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>context</code></td>
-
- <td class="type">
-
-
- <span class="param-type">CanvasContext</span>
-
- </td>
-
-
- <td class="description last">Canvas 2d drawing context.</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>viewport</code></td>
-
- <td class="type">
-
-
- <span class="param-type"><a href="Viewport.html">Viewport</a></span>
-
- </td>
-
-
- <td class="description last">Viewport applied to the canvas.</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>canvas</code></td>
-
- <td class="type">
-
-
- <span class="param-type"><a href="DOM.html">DOM</a></span>
-
- </td>
-
-
- <td class="description last">DOM canvas element where the content is being drawn.</td>
- </tr>
-
- </tbody>
- </table>
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="mask_Mask.js.html">mask/Mask.js</a>, <a href="mask_Mask.js.html#line32">line 32</a>
- </li></ul></dd>
-
-
-
-
- </dl>
-
-
-
-
- </article>
- </section>
- </div>
- <nav>
- <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Box.html">Box</a></li><li><a href="Box2.html">Box2</a></li><li><a href="BoxMask.html">BoxMask</a></li><li><a href="Circle.html">Circle</a></li><li><a href="DOM.html">DOM</a></li><li><a href="EventManager.html">EventManager</a></li><li><a href="Helpers.html">Helpers</a></li><li><a href="Image.html">Image</a></li><li><a href="Key.html">Key</a></li><li><a href="Line.html">Line</a></li><li><a href="Mask.html">Mask</a></li><li><a href="Matrix.html">Matrix</a></li><li><a href="Object2D.html">Object2D</a></li><li><a href="Pattern.html">Pattern</a></li><li><a href="Pointer.html">Pointer</a></li><li><a href="Renderer.html">Renderer</a></li><li><a href="Text.html">Text</a></li><li><a href="UUID.html">UUID</a></li><li><a href="Vector2.html">Vector2</a></li><li><a href="Viewport.html">Viewport</a></li></ul>
- </nav>
- <br class="clear">
- <footer>
- Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.2</a> on Fri Jun 07 2019 11:44:41 GMT+0100 (Western European Summer Time)
- </footer>
- <script> prettyPrint(); </script>
- <script src="scripts/linenumber.js"> </script>
- </body>
- </html>
|