doc/0.9.4/guacamole-common-js/symbols/Guacamole.Display.html (1,780 lines of code) (raw):
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<meta name="generator" content="JsDoc Toolkit" />
<title>JsDoc Reference - Guacamole.Display</title>
<style type="text/css">
/* default.css */
body
{
font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
width: 800px;
}
.header
{
clear: both;
background-color: #ccc;
padding: 8px;
}
h1
{
font-size: 150%;
font-weight: bold;
padding: 0;
margin: 1em 0 0 .3em;
}
hr
{
border: none 0;
border-top: 1px solid #7F8FB1;
height: 1px;
}
pre.code
{
display: block;
padding: 8px;
border: 1px dashed #ccc;
}
#index
{
margin-top: 24px;
float: left;
width: 160px;
position: absolute;
left: 8px;
background-color: #F3F3F3;
padding: 8px;
}
#content
{
margin-left: 190px;
width: 600px;
}
.classList
{
list-style-type: none;
padding: 0;
margin: 0 0 0 8px;
font-family: arial, sans-serif;
font-size: 1em;
overflow: auto;
}
.classList li
{
padding: 0;
margin: 0 0 8px 0;
}
.summaryTable { width: 100%; }
h1.classTitle
{
font-size:170%;
line-height:130%;
}
h2 { font-size: 110%; }
caption, div.sectionTitle
{
background-color: #7F8FB1;
color: #fff;
font-size:130%;
text-align: left;
padding: 2px 6px 2px 6px;
border: 1px #7F8FB1 solid;
}
div.sectionTitle { margin-bottom: 8px; }
.summaryTable thead { display: none; }
.summaryTable td
{
vertical-align: top;
padding: 4px;
border-bottom: 1px #7F8FB1 solid;
border-right: 1px #7F8FB1 solid;
}
/*col#summaryAttributes {}*/
.summaryTable td.attributes
{
border-left: 1px #7F8FB1 solid;
width: 140px;
text-align: right;
}
td.attributes, .fixedFont
{
line-height: 15px;
color: #002EBE;
font-family: "Courier New",Courier,monospace;
font-size: 13px;
}
.summaryTable td.nameDescription
{
text-align: left;
font-size: 13px;
line-height: 15px;
}
.summaryTable td.nameDescription, .description
{
line-height: 15px;
padding: 4px;
padding-left: 4px;
}
.summaryTable { margin-bottom: 8px; }
ul.inheritsList
{
list-style: square;
margin-left: 20px;
padding-left: 0;
}
.detailList {
margin-left: 20px;
line-height: 15px;
}
.detailList dt { margin-left: 20px; }
.detailList .heading
{
font-weight: bold;
padding-bottom: 6px;
margin-left: 0;
}
.light, td.attributes, .light a:link, .light a:visited
{
color: #777;
font-style: italic;
}
.fineprint
{
text-align: right;
font-size: 10px;
}
</style>
</head>
<body>
<!-- ============================== header ================================= -->
<!-- begin static/header.html -->
<div id="header">
</div>
<!-- end static/header.html -->
<!-- ============================== classes index ============================ -->
<div id="index">
<!-- begin publish.classesIndex -->
<div align="center"><a href="../index.html">Class Index</a>
| <a href="../files.html">File Index</a></div>
<hr />
<h2>Classes</h2>
<ul class="classList">
<li><i><a href="../symbols/_global_.html">_global_</a></i></li>
<li><a href="../symbols/Guacamole.ArrayBufferReader.html">Guacamole.ArrayBufferReader</a></li>
<li><a href="../symbols/Guacamole.ArrayBufferWriter.html">Guacamole.ArrayBufferWriter</a></li>
<li><a href="../symbols/Guacamole.AudioChannel.html">Guacamole.AudioChannel</a></li>
<li><a href="../symbols/Guacamole.AudioChannel.Packet.html">Guacamole.AudioChannel.Packet</a></li>
<li><a href="../symbols/Guacamole.BlobReader.html">Guacamole.BlobReader</a></li>
<li><a href="../symbols/Guacamole.ChainedTunnel.html">Guacamole.ChainedTunnel</a></li>
<li><a href="../symbols/Guacamole.Client.html">Guacamole.Client</a></li>
<li><a href="../symbols/Guacamole.Display.html">Guacamole.Display</a></li>
<li><a href="../symbols/Guacamole.Display.VisibleLayer.html">Guacamole.Display.VisibleLayer</a></li>
<li><a href="../symbols/Guacamole.HTTPTunnel.html">Guacamole.HTTPTunnel</a></li>
<li><a href="../symbols/Guacamole.InputStream.html">Guacamole.InputStream</a></li>
<li><a href="../symbols/Guacamole.IntegerPool.html">Guacamole.IntegerPool</a></li>
<li><a href="../symbols/Guacamole.Keyboard.html">Guacamole.Keyboard</a></li>
<li><a href="../symbols/Guacamole.Keyboard.ModifierState.html">Guacamole.Keyboard.ModifierState</a></li>
<li><a href="../symbols/Guacamole.Layer.html">Guacamole.Layer</a></li>
<li><a href="../symbols/Guacamole.Layer.Pixel.html">Guacamole.Layer.Pixel</a></li>
<li><a href="../symbols/Guacamole.Mouse.html">Guacamole.Mouse</a></li>
<li><a href="../symbols/Guacamole.Mouse.State.html">Guacamole.Mouse.State</a></li>
<li><a href="../symbols/Guacamole.Mouse.Touchpad.html">Guacamole.Mouse.Touchpad</a></li>
<li><a href="../symbols/Guacamole.Mouse.Touchscreen.html">Guacamole.Mouse.Touchscreen</a></li>
<li><a href="../symbols/Guacamole.OnScreenKeyboard.html">Guacamole.OnScreenKeyboard</a></li>
<li><a href="../symbols/Guacamole.OnScreenKeyboard.Cap.html">Guacamole.OnScreenKeyboard.Cap</a></li>
<li><a href="../symbols/Guacamole.OnScreenKeyboard.Key.html">Guacamole.OnScreenKeyboard.Key</a></li>
<li><a href="../symbols/Guacamole.OutputStream.html">Guacamole.OutputStream</a></li>
<li><a href="../symbols/Guacamole.Parser.html">Guacamole.Parser</a></li>
<li><a href="../symbols/Guacamole.StringReader.html">Guacamole.StringReader</a></li>
<li><a href="../symbols/Guacamole.StringWriter.html">Guacamole.StringWriter</a></li>
<li><a href="../symbols/Guacamole.Tunnel.html">Guacamole.Tunnel</a></li>
<li><a href="../symbols/Guacamole.WebSocketTunnel.html">Guacamole.WebSocketTunnel</a></li>
</ul>
<hr />
<!-- end publish.classesIndex -->
</div>
<div id="content">
<!-- ============================== class title ============================ -->
<h1 class="classTitle">
Class Guacamole.Display
</h1>
<!-- ============================== class summary ========================== -->
<p class="description">
<br /><i>Defined in: </i> <a href="../symbols/src/src_main_webapp_modules_Display.js.html">Display.js</a>.
</p>
<!-- ============================== constructor summary ==================== -->
<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class Guacamole.Display.">
<caption>Class Summary</caption>
<thead>
<tr>
<th scope="col">Constructor Attributes</th>
<th scope="col">Constructor Name and Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="attributes"> </td>
<td class="nameDescription" >
<div class="fixedFont">
<b><a href="../symbols/Guacamole.Display.html#constructor">Guacamole.Display</a></b>()
</div>
<div class="description">The Guacamole display.</div>
</td>
</tr>
</tbody>
</table>
<!-- ============================== properties summary ===================== -->
<table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class Guacamole.Display.">
<caption>Field Summary</caption>
<thead>
<tr>
<th scope="col">Field Attributes</th>
<th scope="col">Field Name and Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont">
<b><a href="../symbols/Guacamole.Display.html#cursorHotspotX">cursorHotspotX</a></b>
</div>
<div class="description">The X coordinate of the hotspot of the mouse cursor.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont">
<b><a href="../symbols/Guacamole.Display.html#cursorHotspotY">cursorHotspotY</a></b>
</div>
<div class="description">The Y coordinate of the hotspot of the mouse cursor.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont">
<b><a href="../symbols/Guacamole.Display.html#cursorX">cursorX</a></b>
</div>
<div class="description">The current X coordinate of the local mouse cursor.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont">
<b><a href="../symbols/Guacamole.Display.html#cursorY">cursorY</a></b>
</div>
<div class="description">The current X coordinate of the local mouse cursor.</div>
</td>
</tr>
</tbody>
</table>
<!-- ============================== methods summary ======================== -->
<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class Guacamole.Display.">
<caption>Method Summary</caption>
<thead>
<tr>
<th scope="col">Method Attributes</th>
<th scope="col">Method Name and Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Display.html#arc">arc</a></b>(layer, x, y, radius, startAngle, endAngle, negative)
</div>
<div class="description">Add the specified arc to the current path.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Display.html#clip">clip</a></b>(layer)
</div>
<div class="description">Clip all future drawing operations by the current path.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Display.html#close">close</a></b>(layer)
</div>
<div class="description">Closes the current path by connecting the end point with the start
point (if any) with a straight line.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Display.html#copy">copy</a></b>(srcLayer, srcx, srcy, srcw, srch, dstLayer, x, y)
</div>
<div class="description">Copy a rectangle of image data from one Layer to this Layer.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Display.html#createBuffer">createBuffer</a></b>()
</div>
<div class="description">Creates a new buffer.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Display.html#createLayer">createLayer</a></b>()
</div>
<div class="description">Creates a new layer.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Display.html#curveTo">curveTo</a></b>(layer, cp1x, cp1y, cp2x, cp2y, x, y)
</div>
<div class="description">Starts a new path at the specified point.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Display.html#draw">draw</a></b>(layer, x, y, url)
</div>
<div class="description">Draws the image at the specified URL at the given coordinates.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Display.html#drawImage">drawImage</a></b>(layer, x, y, image)
</div>
<div class="description">Draws the specified image at the given coordinates.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Display.html#fillColor">fillColor</a></b>(layer, r, g, b, a)
</div>
<div class="description">Fills the current path with the specified color.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Display.html#fillLayer">fillLayer</a></b>(layer, srcLayer)
</div>
<div class="description">Fills the current path with the image within the specified layer.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Display.html#flatten">flatten</a></b>()
</div>
<div class="description">Returns a canvas element containing the entire display, with all child
layers composited within.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Display.html#flush">flush</a></b>(callback)
</div>
<div class="description">Flush all pending draw tasks, if possible, as a new frame.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Display.html#getCursorLayer">getCursorLayer</a></b>()
</div>
<div class="description">Returns the cursor layer of this display.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Display.html#getDefaultLayer">getDefaultLayer</a></b>()
</div>
<div class="description">Returns the default layer of this display.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Display.html#getElement">getElement</a></b>()
</div>
<div class="description">Returns the element which contains the Guacamole display.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Display.html#getHeight">getHeight</a></b>()
</div>
<div class="description">Returns the height of this display.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Display.html#getScale">getScale</a></b>()
</div>
<div class="description">Returns the scale of the display.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Display.html#getWidth">getWidth</a></b>()
</div>
<div class="description">Returns the width of this display.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Display.html#lineTo">lineTo</a></b>(layer, x, y)
</div>
<div class="description">Add the specified line to the current path.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Display.html#moveCursor">moveCursor</a></b>(x, y)
</div>
<div class="description">Sets the location of the local cursor to the given coordinates.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Display.html#moveTo">moveTo</a></b>(layer, x, y)
</div>
<div class="description">Starts a new path at the specified point.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Display.html#play">play</a></b>(layer, mimetype, duration, url)
</div>
<div class="description">Plays the video at the specified URL within this layer.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Display.html#pop">pop</a></b>(layer)
</div>
<div class="description">Pop layer state off stack.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Display.html#push">push</a></b>(layer)
</div>
<div class="description">Push current layer state onto stack.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Display.html#put">put</a></b>(srcLayer, srcx, srcy, srcw, srch, dstLayer, x, y)
</div>
<div class="description">Put a rectangle of image data from one Layer to this Layer directly
without performing any alpha blending.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Display.html#rect">rect</a></b>(layer, x, y, w, h)
</div>
<div class="description">Add the specified rectangle to the current path.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Display.html#reset">reset</a></b>(layer)
</div>
<div class="description">Reset the layer, clearing the stack, the current path, and any transform
matrix.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Display.html#resize">resize</a></b>(layer, width, height)
</div>
<div class="description">Changes the size of the given Layer to the given width and height.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Display.html#scale">scale</a></b>(scale)
</div>
<div class="description">Sets the scale of the client display element such that it renders at
a relatively smaller or larger size, without affecting the true
resolution of the display.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Display.html#setChannelMask">setChannelMask</a></b>(layer, mask)
</div>
<div class="description">Sets the channel mask for future operations on this Layer.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Display.html#setCursor">setCursor</a></b>(hotspotX, hotspotY, layer, srcx, srcy, srcw, srch)
</div>
<div class="description">Sets the hotspot and image of the mouse cursor displayed within the
Guacamole display.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Display.html#setMiterLimit">setMiterLimit</a></b>(layer, limit)
</div>
<div class="description">Sets the miter limit for stroke operations using the miter join.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Display.html#setTransform">setTransform</a></b>(layer, a, b, c, d, e, f)
</div>
<div class="description">Sets the given affine transform (defined with six values from the
transform's matrix).</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Display.html#showCursor">showCursor</a></b>(shown)
</div>
<div class="description">Sets whether the software-rendered cursor is shown.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Display.html#strokeColor">strokeColor</a></b>(layer, cap, join, thickness, r, g, b, a)
</div>
<div class="description">Stroke the current path with the specified color.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Display.html#strokeLayer">strokeLayer</a></b>(layer, cap, join, thickness, srcLayer)
</div>
<div class="description">Stroke the current path with the image within the specified layer.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Display.html#transfer">transfer</a></b>(srcLayer, srcx, srcy, srcw, srch, dstLayer, x, y, transferFunction)
</div>
<div class="description">Transfer a rectangle of image data from one Layer to this Layer using the
specified transfer function.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Display.html#transform">transform</a></b>(layer, a, b, c, d, e, f)
</div>
<div class="description">Applies the given affine transform (defined with six values from the
transform's matrix).</div>
</td>
</tr>
</tbody>
</table>
<!-- ============================== events summary ======================== -->
<table class="summaryTable" cellspacing="0" summary="A summary of the events documented in the class Guacamole.Display.">
<caption>Event Summary</caption>
<thead>
<tr>
<th scope="col">Event Attributes</th>
<th scope="col">Event Name and Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Display.html#event:oncursor">oncursor</a></b>(canvas, x, y)
</div>
<div class="description">Fired whenever the local cursor image is changed.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/Guacamole.Display.html#event:onresize">onresize</a></b>(width, height)
</div>
<div class="description">Fired when the default layer (and thus the entire Guacamole display)
is resized.</div>
</td>
</tr>
</tbody>
</table>
<!-- ============================== constructor details ==================== -->
<div class="details"><a name="constructor"> </a>
<div class="sectionTitle">
Class Detail
</div>
<div class="fixedFont">
<b>Guacamole.Display</b>()
</div>
<div class="description">
The Guacamole display. The display does not deal with the Guacamole
protocol, and instead implements a set of graphical operations which
embody the set of operations present in the protocol. The order operations
are executed is guaranteed to be in the same order as their corresponding
functions are called.
</div>
</div>
<!-- ============================== field details ========================== -->
<div class="sectionTitle">
Field Detail
</div>
<a name="cursorHotspotX"> </a>
<div class="fixedFont">
<span class="light">{Number}</span>
<b>cursorHotspotX</b>
</div>
<div class="description">
The X coordinate of the hotspot of the mouse cursor. The hotspot is
the relative location within the image of the mouse cursor at which
each click occurs.
</div>
<hr />
<a name="cursorHotspotY"> </a>
<div class="fixedFont">
<span class="light">{Number}</span>
<b>cursorHotspotY</b>
</div>
<div class="description">
The Y coordinate of the hotspot of the mouse cursor. The hotspot is
the relative location within the image of the mouse cursor at which
each click occurs.
</div>
<hr />
<a name="cursorX"> </a>
<div class="fixedFont">
<span class="light">{Number}</span>
<b>cursorX</b>
</div>
<div class="description">
The current X coordinate of the local mouse cursor. This is not
necessarily the location of the actual mouse - it refers only to
the location of the cursor image within the Guacamole display, as
last set by moveCursor().
</div>
<hr />
<a name="cursorY"> </a>
<div class="fixedFont">
<span class="light">{Number}</span>
<b>cursorY</b>
</div>
<div class="description">
The current X coordinate of the local mouse cursor. This is not
necessarily the location of the actual mouse - it refers only to
the location of the cursor image within the Guacamole display, as
last set by moveCursor().
</div>
<!-- ============================== method details ========================= -->
<div class="sectionTitle">
Method Detail
</div>
<a name="arc"> </a>
<div class="fixedFont">
<b>arc</b>(layer, x, y, radius, startAngle, endAngle, negative)
</div>
<div class="description">
Add the specified arc to the current path.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{<a href="../symbols/Guacamole.Layer.html">Guacamole.Layer</a>}</span> <b>layer</b>
</dt>
<dd>The layer to draw upon.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>x</b>
</dt>
<dd>The X coordinate of the center of the circle which
will contain the arc.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>y</b>
</dt>
<dd>The Y coordinate of the center of the circle which
will contain the arc.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>radius</b>
</dt>
<dd>The radius of the circle.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>startAngle</b>
</dt>
<dd>The starting angle of the arc, in radians.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>endAngle</b>
</dt>
<dd>The ending angle of the arc, in radians.</dd>
<dt>
<span class="light fixedFont">{Boolean}</span> <b>negative</b>
</dt>
<dd>Whether the arc should be drawn in order of
decreasing angle.</dd>
</dl>
<hr />
<a name="clip"> </a>
<div class="fixedFont">
<b>clip</b>(layer)
</div>
<div class="description">
Clip all future drawing operations by the current path. The current path
is implicitly closed. The current path can continue to be reused
for other operations (such as fillColor()) but a new path will be started
once a path drawing operation (path() or rect()) is used.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{<a href="../symbols/Guacamole.Layer.html">Guacamole.Layer</a>}</span> <b>layer</b>
</dt>
<dd>The layer to affect.</dd>
</dl>
<hr />
<a name="close"> </a>
<div class="fixedFont">
<b>close</b>(layer)
</div>
<div class="description">
Closes the current path by connecting the end point with the start
point (if any) with a straight line.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{<a href="../symbols/Guacamole.Layer.html">Guacamole.Layer</a>}</span> <b>layer</b>
</dt>
<dd>The layer to draw upon.</dd>
</dl>
<hr />
<a name="copy"> </a>
<div class="fixedFont">
<b>copy</b>(srcLayer, srcx, srcy, srcw, srch, dstLayer, x, y)
</div>
<div class="description">
Copy a rectangle of image data from one Layer to this Layer. This
operation will copy exactly the image data that will be drawn once all
operations of the source Layer that were pending at the time this
function was called are complete. This operation will not alter the
size of the source Layer even if its autosize property is set to true.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{<a href="../symbols/Guacamole.Layer.html">Guacamole.Layer</a>}</span> <b>srcLayer</b>
</dt>
<dd>The Layer to copy image data from.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>srcx</b>
</dt>
<dd>The X coordinate of the upper-left corner of the
rectangle within the source Layer's coordinate
space to copy data from.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>srcy</b>
</dt>
<dd>The Y coordinate of the upper-left corner of the
rectangle within the source Layer's coordinate
space to copy data from.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>srcw</b>
</dt>
<dd>The width of the rectangle within the source Layer's
coordinate space to copy data from.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>srch</b>
</dt>
<dd>The height of the rectangle within the source
Layer's coordinate space to copy data from.</dd>
<dt>
<span class="light fixedFont">{<a href="../symbols/Guacamole.Layer.html">Guacamole.Layer</a>}</span> <b>dstLayer</b>
</dt>
<dd>The layer to draw upon.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>x</b>
</dt>
<dd>The destination X coordinate.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>y</b>
</dt>
<dd>The destination Y coordinate.</dd>
</dl>
<hr />
<a name="createBuffer"> </a>
<div class="fixedFont">
<span class="light">{<a href="../symbols/Guacamole.Layer.html">Guacamole.Layer</a>}</span>
<b>createBuffer</b>()
</div>
<div class="description">
Creates a new buffer. Buffers are invisible, off-screen surfaces. They
are implemented in the same manner as layers, but do not provide the
same nesting semantics.
</div>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{<a href="../symbols/Guacamole.Layer.html">Guacamole.Layer</a>}</span> The newly-created buffer.</dd>
</dl>
<hr />
<a name="createLayer"> </a>
<div class="fixedFont">
<span class="light">{<a href="../symbols/Guacamole.Display.VisibleLayer.html">Guacamole.Display.VisibleLayer</a>}</span>
<b>createLayer</b>()
</div>
<div class="description">
Creates a new layer. The new layer will be a direct child of the default
layer, but can be moved to be a child of any other layer. Layers returned
by this function are visible.
</div>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{<a href="../symbols/Guacamole.Display.VisibleLayer.html">Guacamole.Display.VisibleLayer</a>}</span> The newly-created layer.</dd>
</dl>
<hr />
<a name="curveTo"> </a>
<div class="fixedFont">
<b>curveTo</b>(layer, cp1x, cp1y, cp2x, cp2y, x, y)
</div>
<div class="description">
Starts a new path at the specified point.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{<a href="../symbols/Guacamole.Layer.html">Guacamole.Layer</a>}</span> <b>layer</b>
</dt>
<dd>The layer to draw upon.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>cp1x</b>
</dt>
<dd>The X coordinate of the first control point.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>cp1y</b>
</dt>
<dd>The Y coordinate of the first control point.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>cp2x</b>
</dt>
<dd>The X coordinate of the second control point.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>cp2y</b>
</dt>
<dd>The Y coordinate of the second control point.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>x</b>
</dt>
<dd>The X coordinate of the endpoint of the curve.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>y</b>
</dt>
<dd>The Y coordinate of the endpoint of the curve.</dd>
</dl>
<hr />
<a name="draw"> </a>
<div class="fixedFont">
<b>draw</b>(layer, x, y, url)
</div>
<div class="description">
Draws the image at the specified URL at the given coordinates. The image
will be loaded automatically, and this and any future operations will
wait for the image to finish loading.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{<a href="../symbols/Guacamole.Layer.html">Guacamole.Layer</a>}</span> <b>layer</b>
</dt>
<dd>The layer to draw upon.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>x</b>
</dt>
<dd>The destination X coordinate.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>y</b>
</dt>
<dd>The destination Y coordinate.</dd>
<dt>
<span class="light fixedFont">{String}</span> <b>url</b>
</dt>
<dd>The URL of the image to draw.</dd>
</dl>
<hr />
<a name="drawImage"> </a>
<div class="fixedFont">
<b>drawImage</b>(layer, x, y, image)
</div>
<div class="description">
Draws the specified image at the given coordinates. The image specified
must already be loaded.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{<a href="../symbols/Guacamole.Layer.html">Guacamole.Layer</a>}</span> <b>layer</b>
</dt>
<dd>The layer to draw upon.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>x</b>
</dt>
<dd>The destination X coordinate.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>y</b>
</dt>
<dd>The destination Y coordinate.</dd>
<dt>
<span class="light fixedFont">{Image}</span> <b>image</b>
</dt>
<dd>The image to draw. Note that this is an Image
object - not a URL.</dd>
</dl>
<hr />
<a name="fillColor"> </a>
<div class="fixedFont">
<b>fillColor</b>(layer, r, g, b, a)
</div>
<div class="description">
Fills the current path with the specified color. The current path
is implicitly closed. The current path can continue to be reused
for other operations (such as clip()) but a new path will be started
once a path drawing operation (path() or rect()) is used.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{<a href="../symbols/Guacamole.Layer.html">Guacamole.Layer</a>}</span> <b>layer</b>
</dt>
<dd>The layer to draw upon.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>r</b>
</dt>
<dd>The red component of the color to fill.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>g</b>
</dt>
<dd>The green component of the color to fill.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>b</b>
</dt>
<dd>The blue component of the color to fill.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>a</b>
</dt>
<dd>The alpha component of the color to fill.</dd>
</dl>
<hr />
<a name="fillLayer"> </a>
<div class="fixedFont">
<b>fillLayer</b>(layer, srcLayer)
</div>
<div class="description">
Fills the current path with the image within the specified layer. The
image data will be tiled infinitely within the stroke. The current path
is implicitly closed. The current path can continue to be reused
for other operations (such as clip()) but a new path will be started
once a path drawing operation (path() or rect()) is used.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{<a href="../symbols/Guacamole.Layer.html">Guacamole.Layer</a>}</span> <b>layer</b>
</dt>
<dd>The layer to draw upon.</dd>
<dt>
<span class="light fixedFont">{<a href="../symbols/Guacamole.Layer.html">Guacamole.Layer</a>}</span> <b>srcLayer</b>
</dt>
<dd>The layer to use as a repeating pattern
within the fill.</dd>
</dl>
<hr />
<a name="flatten"> </a>
<div class="fixedFont">
<span class="light">{HTMLCanvasElement}</span>
<b>flatten</b>()
</div>
<div class="description">
Returns a canvas element containing the entire display, with all child
layers composited within.
</div>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{HTMLCanvasElement}</span> A new canvas element containing a copy of
the display.</dd>
</dl>
<hr />
<a name="flush"> </a>
<div class="fixedFont">
<b>flush</b>(callback)
</div>
<div class="description">
Flush all pending draw tasks, if possible, as a new frame. If the entire
frame is not ready, the flush will wait until all required tasks are
unblocked.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{function}</span> <b>callback</b>
</dt>
<dd>The function to call when this frame is
flushed. This may happen immediately, or
later when blocked tasks become unblocked.</dd>
</dl>
<hr />
<a name="getCursorLayer"> </a>
<div class="fixedFont">
<span class="light">{<a href="../symbols/Guacamole.Display.VisibleLayer.html">Guacamole.Display.VisibleLayer</a>}</span>
<b>getCursorLayer</b>()
</div>
<div class="description">
Returns the cursor layer of this display. Each Guacamole display contains
a layer for the image of the mouse cursor. This layer is a special case
and exists above all other layers, similar to the hardware mouse cursor.
</div>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{<a href="../symbols/Guacamole.Display.VisibleLayer.html">Guacamole.Display.VisibleLayer</a>}</span> The cursor layer.</dd>
</dl>
<hr />
<a name="getDefaultLayer"> </a>
<div class="fixedFont">
<span class="light">{<a href="../symbols/Guacamole.Display.VisibleLayer.html">Guacamole.Display.VisibleLayer</a>}</span>
<b>getDefaultLayer</b>()
</div>
<div class="description">
Returns the default layer of this display. Each Guacamole display always
has at least one layer. Other layers can optionally be created within
this layer, but the default layer cannot be removed and is the absolute
ancestor of all other layers.
</div>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{<a href="../symbols/Guacamole.Display.VisibleLayer.html">Guacamole.Display.VisibleLayer</a>}</span> The default layer.</dd>
</dl>
<hr />
<a name="getElement"> </a>
<div class="fixedFont">
<span class="light">{Element}</span>
<b>getElement</b>()
</div>
<div class="description">
Returns the element which contains the Guacamole display.
</div>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{Element}</span> The element containing the Guacamole display.</dd>
</dl>
<hr />
<a name="getHeight"> </a>
<div class="fixedFont">
<span class="light">{Number}</span>
<b>getHeight</b>()
</div>
<div class="description">
Returns the height of this display.
</div>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{Number}</span> The height of this display;</dd>
</dl>
<hr />
<a name="getScale"> </a>
<div class="fixedFont">
<span class="light">{Number}</span>
<b>getScale</b>()
</div>
<div class="description">
Returns the scale of the display.
</div>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{Number}</span> The scale of the display.</dd>
</dl>
<hr />
<a name="getWidth"> </a>
<div class="fixedFont">
<span class="light">{Number}</span>
<b>getWidth</b>()
</div>
<div class="description">
Returns the width of this display.
</div>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{Number}</span> The width of this display;</dd>
</dl>
<hr />
<a name="lineTo"> </a>
<div class="fixedFont">
<b>lineTo</b>(layer, x, y)
</div>
<div class="description">
Add the specified line to the current path.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{<a href="../symbols/Guacamole.Layer.html">Guacamole.Layer</a>}</span> <b>layer</b>
</dt>
<dd>The layer to draw upon.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>x</b>
</dt>
<dd>The X coordinate of the endpoint of the line to draw.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>y</b>
</dt>
<dd>The Y coordinate of the endpoint of the line to draw.</dd>
</dl>
<hr />
<a name="moveCursor"> </a>
<div class="fixedFont">
<b>moveCursor</b>(x, y)
</div>
<div class="description">
Sets the location of the local cursor to the given coordinates. For the
sake of responsiveness, this function performs its action immediately.
Cursor motion is not maintained within atomic frames.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{Number}</span> <b>x</b>
</dt>
<dd>The X coordinate to move the cursor to.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>y</b>
</dt>
<dd>The Y coordinate to move the cursor to.</dd>
</dl>
<hr />
<a name="moveTo"> </a>
<div class="fixedFont">
<b>moveTo</b>(layer, x, y)
</div>
<div class="description">
Starts a new path at the specified point.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{<a href="../symbols/Guacamole.Layer.html">Guacamole.Layer</a>}</span> <b>layer</b>
</dt>
<dd>The layer to draw upon.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>x</b>
</dt>
<dd>The X coordinate of the point to draw.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>y</b>
</dt>
<dd>The Y coordinate of the point to draw.</dd>
</dl>
<hr />
<a name="play"> </a>
<div class="fixedFont">
<b>play</b>(layer, mimetype, duration, url)
</div>
<div class="description">
Plays the video at the specified URL within this layer. The video
will be loaded automatically, and this and any future operations will
wait for the video to finish loading. Future operations will not be
executed until the video finishes playing.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{<a href="../symbols/Guacamole.Layer.html">Guacamole.Layer</a>}</span> <b>layer</b>
</dt>
<dd>The layer to draw upon.</dd>
<dt>
<span class="light fixedFont">{String}</span> <b>mimetype</b>
</dt>
<dd>The mimetype of the video to play.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>duration</b>
</dt>
<dd>The duration of the video in milliseconds.</dd>
<dt>
<span class="light fixedFont">{String}</span> <b>url</b>
</dt>
<dd>The URL of the video to play.</dd>
</dl>
<hr />
<a name="pop"> </a>
<div class="fixedFont">
<b>pop</b>(layer)
</div>
<div class="description">
Pop layer state off stack.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{<a href="../symbols/Guacamole.Layer.html">Guacamole.Layer</a>}</span> <b>layer</b>
</dt>
<dd>The layer to draw upon.</dd>
</dl>
<hr />
<a name="push"> </a>
<div class="fixedFont">
<b>push</b>(layer)
</div>
<div class="description">
Push current layer state onto stack.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{<a href="../symbols/Guacamole.Layer.html">Guacamole.Layer</a>}</span> <b>layer</b>
</dt>
<dd>The layer to draw upon.</dd>
</dl>
<hr />
<a name="put"> </a>
<div class="fixedFont">
<b>put</b>(srcLayer, srcx, srcy, srcw, srch, dstLayer, x, y)
</div>
<div class="description">
Put a rectangle of image data from one Layer to this Layer directly
without performing any alpha blending. Simply copy the data.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{<a href="../symbols/Guacamole.Layer.html">Guacamole.Layer</a>}</span> <b>srcLayer</b>
</dt>
<dd>The Layer to copy image data from.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>srcx</b>
</dt>
<dd>The X coordinate of the upper-left corner of the
rectangle within the source Layer's coordinate
space to copy data from.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>srcy</b>
</dt>
<dd>The Y coordinate of the upper-left corner of the
rectangle within the source Layer's coordinate
space to copy data from.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>srcw</b>
</dt>
<dd>The width of the rectangle within the source Layer's
coordinate space to copy data from.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>srch</b>
</dt>
<dd>The height of the rectangle within the source
Layer's coordinate space to copy data from.</dd>
<dt>
<span class="light fixedFont">{<a href="../symbols/Guacamole.Layer.html">Guacamole.Layer</a>}</span> <b>dstLayer</b>
</dt>
<dd>The layer to draw upon.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>x</b>
</dt>
<dd>The destination X coordinate.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>y</b>
</dt>
<dd>The destination Y coordinate.</dd>
</dl>
<hr />
<a name="rect"> </a>
<div class="fixedFont">
<b>rect</b>(layer, x, y, w, h)
</div>
<div class="description">
Add the specified rectangle to the current path.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{<a href="../symbols/Guacamole.Layer.html">Guacamole.Layer</a>}</span> <b>layer</b>
</dt>
<dd>The layer to draw upon.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>x</b>
</dt>
<dd>The X coordinate of the upper-left corner of the
rectangle to draw.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>y</b>
</dt>
<dd>The Y coordinate of the upper-left corner of the
rectangle to draw.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>w</b>
</dt>
<dd>The width of the rectangle to draw.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>h</b>
</dt>
<dd>The height of the rectangle to draw.</dd>
</dl>
<hr />
<a name="reset"> </a>
<div class="fixedFont">
<b>reset</b>(layer)
</div>
<div class="description">
Reset the layer, clearing the stack, the current path, and any transform
matrix.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{<a href="../symbols/Guacamole.Layer.html">Guacamole.Layer</a>}</span> <b>layer</b>
</dt>
<dd>The layer to draw upon.</dd>
</dl>
<hr />
<a name="resize"> </a>
<div class="fixedFont">
<b>resize</b>(layer, width, height)
</div>
<div class="description">
Changes the size of the given Layer to the given width and height.
Resizing is only attempted if the new size provided is actually different
from the current size.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{<a href="../symbols/Guacamole.Layer.html">Guacamole.Layer</a>}</span> <b>layer</b>
</dt>
<dd>The layer to resize.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>width</b>
</dt>
<dd>The new width.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>height</b>
</dt>
<dd>The new height.</dd>
</dl>
<hr />
<a name="scale"> </a>
<div class="fixedFont">
<b>scale</b>(scale)
</div>
<div class="description">
Sets the scale of the client display element such that it renders at
a relatively smaller or larger size, without affecting the true
resolution of the display.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{Number}</span> <b>scale</b>
</dt>
<dd>The scale to resize to, where 1.0 is normal
size (1:1 scale).</dd>
</dl>
<hr />
<a name="setChannelMask"> </a>
<div class="fixedFont">
<b>setChannelMask</b>(layer, mask)
</div>
<div class="description">
Sets the channel mask for future operations on this Layer.
The channel mask is a Guacamole-specific compositing operation identifier
with a single bit representing each of four channels (in order): source
image where destination transparent, source where destination opaque,
destination where source transparent, and destination where source
opaque.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{<a href="../symbols/Guacamole.Layer.html">Guacamole.Layer</a>}</span> <b>layer</b>
</dt>
<dd>The layer to modify.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>mask</b>
</dt>
<dd>The channel mask for future operations on this
Layer.</dd>
</dl>
<hr />
<a name="setCursor"> </a>
<div class="fixedFont">
<b>setCursor</b>(hotspotX, hotspotY, layer, srcx, srcy, srcw, srch)
</div>
<div class="description">
Sets the hotspot and image of the mouse cursor displayed within the
Guacamole display.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{Number}</span> <b>hotspotX</b>
</dt>
<dd>The X coordinate of the cursor hotspot.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>hotspotY</b>
</dt>
<dd>The Y coordinate of the cursor hotspot.</dd>
<dt>
<span class="light fixedFont">{<a href="../symbols/Guacamole.Layer.html">Guacamole.Layer</a>}</span> <b>layer</b>
</dt>
<dd>The source layer containing the data which
should be used as the mouse cursor image.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>srcx</b>
</dt>
<dd>The X coordinate of the upper-left corner of the
rectangle within the source layer's coordinate
space to copy data from.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>srcy</b>
</dt>
<dd>The Y coordinate of the upper-left corner of the
rectangle within the source layer's coordinate
space to copy data from.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>srcw</b>
</dt>
<dd>The width of the rectangle within the source layer's
coordinate space to copy data from.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>srch</b>
</dt>
<dd>The height of the rectangle within the source
layer's coordinate space to copy data from.</dd>
</dl>
<hr />
<a name="setMiterLimit"> </a>
<div class="fixedFont">
<b>setMiterLimit</b>(layer, limit)
</div>
<div class="description">
Sets the miter limit for stroke operations using the miter join. This
limit is the maximum ratio of the size of the miter join to the stroke
width. If this ratio is exceeded, the miter will not be drawn for that
joint of the path.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{<a href="../symbols/Guacamole.Layer.html">Guacamole.Layer</a>}</span> <b>layer</b>
</dt>
<dd>The layer to modify.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>limit</b>
</dt>
<dd>The miter limit for stroke operations using the
miter join.</dd>
</dl>
<hr />
<a name="setTransform"> </a>
<div class="fixedFont">
<b>setTransform</b>(layer, a, b, c, d, e, f)
</div>
<div class="description">
Sets the given affine transform (defined with six values from the
transform's matrix).
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{<a href="../symbols/Guacamole.Layer.html">Guacamole.Layer</a>}</span> <b>layer</b>
</dt>
<dd>The layer to modify.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>a</b>
</dt>
<dd>The first value in the affine transform's matrix.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>b</b>
</dt>
<dd>The second value in the affine transform's matrix.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>c</b>
</dt>
<dd>The third value in the affine transform's matrix.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>d</b>
</dt>
<dd>The fourth value in the affine transform's matrix.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>e</b>
</dt>
<dd>The fifth value in the affine transform's matrix.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>f</b>
</dt>
<dd>The sixth value in the affine transform's matrix.</dd>
</dl>
<hr />
<a name="showCursor"> </a>
<div class="fixedFont">
<b>showCursor</b>(shown)
</div>
<div class="description">
Sets whether the software-rendered cursor is shown. This cursor differs
from the hardware cursor in that it is built into the Guacamole.Display,
and relies on its own Guacamole layer to render.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{Boolean}</span> <b>shown</b>
<i>Optional, Default: true</i>
</dt>
<dd>Whether to show the software cursor.</dd>
</dl>
<hr />
<a name="strokeColor"> </a>
<div class="fixedFont">
<b>strokeColor</b>(layer, cap, join, thickness, r, g, b, a)
</div>
<div class="description">
Stroke the current path with the specified color. The current path
is implicitly closed. The current path can continue to be reused
for other operations (such as clip()) but a new path will be started
once a path drawing operation (path() or rect()) is used.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{<a href="../symbols/Guacamole.Layer.html">Guacamole.Layer</a>}</span> <b>layer</b>
</dt>
<dd>The layer to draw upon.</dd>
<dt>
<span class="light fixedFont">{String}</span> <b>cap</b>
</dt>
<dd>The line cap style. Can be "round", "square",
or "butt".</dd>
<dt>
<span class="light fixedFont">{String}</span> <b>join</b>
</dt>
<dd>The line join style. Can be "round", "bevel",
or "miter".</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>thickness</b>
</dt>
<dd>The line thickness in pixels.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>r</b>
</dt>
<dd>The red component of the color to fill.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>g</b>
</dt>
<dd>The green component of the color to fill.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>b</b>
</dt>
<dd>The blue component of the color to fill.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>a</b>
</dt>
<dd>The alpha component of the color to fill.</dd>
</dl>
<hr />
<a name="strokeLayer"> </a>
<div class="fixedFont">
<b>strokeLayer</b>(layer, cap, join, thickness, srcLayer)
</div>
<div class="description">
Stroke the current path with the image within the specified layer. The
image data will be tiled infinitely within the stroke. The current path
is implicitly closed. The current path can continue to be reused
for other operations (such as clip()) but a new path will be started
once a path drawing operation (path() or rect()) is used.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{<a href="../symbols/Guacamole.Layer.html">Guacamole.Layer</a>}</span> <b>layer</b>
</dt>
<dd>The layer to draw upon.</dd>
<dt>
<span class="light fixedFont">{String}</span> <b>cap</b>
</dt>
<dd>The line cap style. Can be "round", "square",
or "butt".</dd>
<dt>
<span class="light fixedFont">{String}</span> <b>join</b>
</dt>
<dd>The line join style. Can be "round", "bevel",
or "miter".</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>thickness</b>
</dt>
<dd>The line thickness in pixels.</dd>
<dt>
<span class="light fixedFont">{<a href="../symbols/Guacamole.Layer.html">Guacamole.Layer</a>}</span> <b>srcLayer</b>
</dt>
<dd>The layer to use as a repeating pattern
within the stroke.</dd>
</dl>
<hr />
<a name="transfer"> </a>
<div class="fixedFont">
<b>transfer</b>(srcLayer, srcx, srcy, srcw, srch, dstLayer, x, y, transferFunction)
</div>
<div class="description">
Transfer a rectangle of image data from one Layer to this Layer using the
specified transfer function.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{<a href="../symbols/Guacamole.Layer.html">Guacamole.Layer</a>}</span> <b>srcLayer</b>
</dt>
<dd>The Layer to copy image data from.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>srcx</b>
</dt>
<dd>The X coordinate of the upper-left corner of the
rectangle within the source Layer's coordinate
space to copy data from.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>srcy</b>
</dt>
<dd>The Y coordinate of the upper-left corner of the
rectangle within the source Layer's coordinate
space to copy data from.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>srcw</b>
</dt>
<dd>The width of the rectangle within the source Layer's
coordinate space to copy data from.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>srch</b>
</dt>
<dd>The height of the rectangle within the source
Layer's coordinate space to copy data from.</dd>
<dt>
<span class="light fixedFont">{<a href="../symbols/Guacamole.Layer.html">Guacamole.Layer</a>}</span> <b>dstLayer</b>
</dt>
<dd>The layer to draw upon.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>x</b>
</dt>
<dd>The destination X coordinate.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>y</b>
</dt>
<dd>The destination Y coordinate.</dd>
<dt>
<span class="light fixedFont">{Function}</span> <b>transferFunction</b>
</dt>
<dd>The transfer function to use to
transfer data from source to
destination.</dd>
</dl>
<hr />
<a name="transform"> </a>
<div class="fixedFont">
<b>transform</b>(layer, a, b, c, d, e, f)
</div>
<div class="description">
Applies the given affine transform (defined with six values from the
transform's matrix).
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{<a href="../symbols/Guacamole.Layer.html">Guacamole.Layer</a>}</span> <b>layer</b>
</dt>
<dd>The layer to modify.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>a</b>
</dt>
<dd>The first value in the affine transform's matrix.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>b</b>
</dt>
<dd>The second value in the affine transform's matrix.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>c</b>
</dt>
<dd>The third value in the affine transform's matrix.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>d</b>
</dt>
<dd>The fourth value in the affine transform's matrix.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>e</b>
</dt>
<dd>The fifth value in the affine transform's matrix.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>f</b>
</dt>
<dd>The sixth value in the affine transform's matrix.</dd>
</dl>
<!-- ============================== event details ========================= -->
<div class="sectionTitle">
Event Detail
</div>
<a name="event:oncursor"> </a>
<div class="fixedFont">
<b>oncursor</b>(canvas, x, y)
</div>
<div class="description">
Fired whenever the local cursor image is changed. This can be used to
implement special handling of the client-side cursor, or to override
the default use of a software cursor layer.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{HTMLCanvasElement}</span> <b>canvas</b>
</dt>
<dd>The cursor image.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>x</b>
</dt>
<dd>The X-coordinate of the cursor hotspot.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>y</b>
</dt>
<dd>The Y-coordinate of the cursor hotspot.</dd>
</dl>
<hr />
<a name="event:onresize"> </a>
<div class="fixedFont">
<b>onresize</b>(width, height)
</div>
<div class="description">
Fired when the default layer (and thus the entire Guacamole display)
is resized.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{Number}</span> <b>width</b>
</dt>
<dd>The new width of the Guacamole display.</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>height</b>
</dt>
<dd>The new height of the Guacamole display.</dd>
</dl>
<hr />
</div>
<!-- ============================== footer ================================= -->
<div class="fineprint" style="clear:both">
Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0 on Thu Jan 08 2015 04:14:44 GMT-0800 (PST)
</div>
</body>
</html>