safebox/guacamole-client
4
0
Fork 0
mirror of https://github.com/gyurix1968/guacamole-client.git synced 2025-09-06 13:17:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

More JSDoc, renamed Update to Task, fixed wording.

Browse Source
This commit is contained in:
Michael Jumper
2011-07-06 13:14:40 -07:00
parent c7b880d1bc
commit 086192f414
1 changed files with 87 additions and 71 deletions
Download Patch File Download Diff File Expand all files Collapse all files

158
guacamole-common-js/src/main/resources/layer.js
View File

@@ -37,14 +37,45 @@ var Guacamole = Guacamole || {};
*/ */
Guacamole.Layer = function(width, height) { Guacamole.Layer = function(width, height) {
// Reference to this Layer /**
* Reference to this Layer.
* @private
*/
var layer = this; var layer = this;
// Off-screen buffer (canvas element) and corresponding /**
// context. * The canvas element backing this Layer.
* @private
*/
var display = document.createElement("canvas"); var display = document.createElement("canvas");
/**
* The 2D display context of the canvas element backing this Layer.
* @private
*/
var displayContext = display.getContext("2d"); var displayContext = display.getContext("2d");
var tasks = new Array();
var compositeOperation = {
/* 0x0 NOT IMPLEMENTED */
0x1: "destination-in",
0x2: "destination-out",
/* 0x3 NOT IMPLEMENTED */
0x4: "source-in",
/* 0x5 NOT IMPLEMENTED */
0x6: "source-atop",
/* 0x7 NOT IMPLEMENTED */
0x8: "source-out",
0x9: "destination-atop",
0xA: "xor",
0xB: "destination-over",
0xC: "copy",
/* 0xD NOT IMPLEMENTED */
0xE: "source-over",
0xF: "lighter"
};
/** /**
* Returns the canvas element backing this Layer. * Returns the canvas element backing this Layer.
* @returns {Element} The canvas element backing this Layer. * @returns {Element} The canvas element backing this Layer.
@@ -128,9 +159,6 @@ Guacamole.Layer = function(width, height) {
} }
// Initialize canvas dimensions
resize(width, height);
/** /**
* Set to true if this Layer should resize itself to accomodate the * Set to true if this Layer should resize itself to accomodate the
* dimensions of any drawing operation, and false (the default) otherwise. * dimensions of any drawing operation, and false (the default) otherwise.
@@ -152,47 +180,51 @@ Guacamole.Layer = function(width, height) {
*/ */
this.autosize = false; this.autosize = false;
var updates = new Array(); /**
* A container for an task handler. Each operation which must be ordered
function Update(updateHandler) { * is associated with a Task that goes into a task queue. Tasks in this
* queue are executed in order once their handlers are set, while Tasks
this.setHandler = function(handler) { * without handlers block themselves and any following Tasks from running.
updateHandler = handler; *
}; * @constructor
* @private
this.hasHandler = function() { * @param {function} taskHandler The function to call when this task
return updateHandler != null; * runs, if any.
}; */
function Task(taskHandler) {
this.handle = function() {
updateHandler(); /**
}; * The handler this Task is associated with, if any.
*
* @type function
*/
this.handler = taskHandler;
} }
function reserveJob(handler) { function scheduleTask(handler) {
// If no pending updates, just call (if available) and exit // If no pending tasks, just call (if available) and exit
if (layer.isReady() && handler != null) { if (layer.isReady() && handler != null) {
handler(); handler();
return null; return null;
} }
// If updates are pending/executing, schedule a pending update // If tasks are pending/executing, schedule a pending task
// and return a reference to it. // and return a reference to it.
var update = new Update(handler); var task = new Task(handler);
updates.push(update); tasks.push(task);
return update; return task;
} }
function handlePendingUpdates() { function handlePendingTasks() {
// Draw all pending updates. // Draw all pending tasks.
var update; var task;
while ((update = updates[0]) != null && update.hasHandler()) { while ((task = tasks[0]) != null && task.handler) {
update.handle(); task.handler();
updates.shift(); tasks.shift();
} }
} }
@@ -204,7 +236,7 @@ Guacamole.Layer = function(width, height) {
* @returns {Boolean} true if this Layer is ready, false otherwise. * @returns {Boolean} true if this Layer is ready, false otherwise.
*/ */
this.isReady = function() { this.isReady = function() {
return updates.length == 0; return tasks.length == 0;
}; };
/** /**
@@ -217,7 +249,7 @@ Guacamole.Layer = function(width, height) {
* object - not a URL. * object - not a URL.
*/ */
this.drawImage = function(x, y, image) { this.drawImage = function(x, y, image) {
reserveJob(function() { scheduleTask(function() {
if (autosize != 0) fitRect(x, y, image.width, image.height); if (autosize != 0) fitRect(x, y, image.width, image.height);
displayContext.drawImage(image, x, y); displayContext.drawImage(image, x, y);
}); });
@@ -233,19 +265,19 @@ Guacamole.Layer = function(width, height) {
* @param {String} url The URL of the image to draw. * @param {String} url The URL of the image to draw.
*/ */
this.draw = function(x, y, url) { this.draw = function(x, y, url) {
var update = reserveJob(null); var task = scheduleTask(null);
var image = new Image(); var image = new Image();
image.onload = function() { image.onload = function() {
update.setHandler(function() { task.handler = function() {
if (autosize != 0) fitRect(x, y, image.width, image.height); if (autosize != 0) fitRect(x, y, image.width, image.height);
displayContext.drawImage(image, x, y); displayContext.drawImage(image, x, y);
}); };
// As this update originally had no handler and may have blocked // As this task originally had no handler and may have blocked
// other updates, handle any blocked updates. // other tasks, handle any blocked tasks.
handlePendingUpdates(); handlePendingTasks();
}; };
image.src = url; image.src = url;
@@ -260,7 +292,7 @@ Guacamole.Layer = function(width, height) {
* pending operations are complete. * pending operations are complete.
*/ */
this.sync = function(handler) { this.sync = function(handler) {
reserveJob(handler); scheduleTask(handler);
}; };
/** /**
@@ -294,18 +326,18 @@ Guacamole.Layer = function(width, height) {
// If we ARE the source layer, no need to sync. // If we ARE the source layer, no need to sync.
// Syncing would result in deadlock. // Syncing would result in deadlock.
if (layer === srcLayer) if (layer === srcLayer)
reserveJob(doCopyRect); scheduleTask(doCopyRect);
// Otherwise synchronize copy operation with source layer // Otherwise synchronize copy operation with source layer
else { else {
var update = reserveJob(null); var task = scheduleTask(null);
srcLayer.sync(function() { srcLayer.sync(function() {
update.setHandler(doCopyRect); task.handler = doCopyRect;
// As this update originally had no handler and may have blocked // As this task originally had no handler and may have blocked
// other updates, handle any blocked updates. // other tasks, handle any blocked tasks.
handlePendingUpdates(); handlePendingTasks();
}); });
} }
@@ -313,44 +345,28 @@ Guacamole.Layer = function(width, height) {
}; };
this.clearRect = function(x, y, w, h) { this.clearRect = function(x, y, w, h) {
reserveJob(function() { scheduleTask(function() {
if (autosize != 0) fitRect(x, y, w, h); if (autosize != 0) fitRect(x, y, w, h);
displayContext.clearRect(x, y, w, h); displayContext.clearRect(x, y, w, h);
}); });
}; };
this.filter = function(filter) { this.filter = function(filter) {
reserveJob(function() { scheduleTask(function() {
var imageData = displayContext.getImageData(0, 0, width, height); var imageData = displayContext.getImageData(0, 0, width, height);
filter(imageData.data, width, height); filter(imageData.data, width, height);
displayContext.putImageData(imageData, 0, 0); displayContext.putImageData(imageData, 0, 0);
}); });
}; };
var compositeOperation = {
/* 0x0 NOT IMPLEMENTED */
0x1: "destination-in",
0x2: "destination-out",
/* 0x3 NOT IMPLEMENTED */
0x4: "source-in",
/* 0x5 NOT IMPLEMENTED */
0x6: "source-atop",
/* 0x7 NOT IMPLEMENTED */
0x8: "source-out",
0x9: "destination-atop",
0xA: "xor",
0xB: "destination-over",
0xC: "copy",
/* 0xD NOT IMPLEMENTED */
0xE: "source-over",
0xF: "lighter"
};
this.setChannelMask = function(mask) { this.setChannelMask = function(mask) {
reserveJob(function() { scheduleTask(function() {
displayContext.globalCompositeOperation = compositeOperation[mask]; displayContext.globalCompositeOperation = compositeOperation[mask];
}); });
}; };
// Initialize canvas dimensions
resize(width, height);
} }