mask_Mask.js.html 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>JSDoc: Source: mask/Mask.js</title>
  6. <script src="scripts/prettify/prettify.js"> </script>
  7. <script src="scripts/prettify/lang-css.js"> </script>
  8. <!--[if lt IE 9]>
  9. <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
  10. <![endif]-->
  11. <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
  12. <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
  13. </head>
  14. <body>
  15. <div id="main">
  16. <h1 class="page-title">Source: mask/Mask.js</h1>
  17. <section>
  18. <article>
  19. <pre class="prettyprint source linenums"><code>"use strict";
  20. import {Object2D} from "../Object2D.js";
  21. import {Vector2} from "../math/Vector2.js";
  22. import {Box2} from "../math/Box2.js";
  23. /**
  24. * A mask can be used to set the drawing region.
  25. *
  26. * Masks are treated as objects their shape is used to filter other objects shape.
  27. *
  28. * Multiple mask objects can be active simulatenously, they have to be attached to the object mask list to filter the render region.
  29. *
  30. * @class
  31. */
  32. function Mask()
  33. {
  34. Object2D.call(this);
  35. }
  36. Mask.prototype = Object.create(Object2D.prototype);
  37. Mask.prototype.isMask = true;
  38. /**
  39. * Clip the canvas context, to ensure that next objects being drawn are cliped to the path stored here.
  40. *
  41. * @param {CanvasContext} context Canvas 2d drawing context.
  42. * @param {Viewport} viewport Viewport applied to the canvas.
  43. * @param {DOM} canvas DOM canvas element where the content is being drawn.
  44. */
  45. Mask.prototype.clip = function(context, viewport, canvas){};
  46. export {Mask};</code></pre>
  47. </article>
  48. </section>
  49. </div>
  50. <nav>
  51. <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>
  52. </nav>
  53. <br class="clear">
  54. <footer>
  55. Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.2</a> on Fri Jun 07 2019 11:44:40 GMT+0100 (Western European Summer Time)
  56. </footer>
  57. <script> prettyPrint(); </script>
  58. <script src="scripts/linenumber.js"> </script>
  59. </body>
  60. </html>