Implement identity, transform.
[guacamole-common-js.git] / src / main / resources / guacamole.js
1
2 /* ***** BEGIN LICENSE BLOCK *****
3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
4  *
5  * The contents of this file are subject to the Mozilla Public License Version
6  * 1.1 (the "License"); you may not use this file except in compliance with
7  * the License. You may obtain a copy of the License at
8  * http://www.mozilla.org/MPL/
9  *
10  * Software distributed under the License is distributed on an "AS IS" basis,
11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
12  * for the specific language governing rights and limitations under the
13  * License.
14  *
15  * The Original Code is guacamole-common-js.
16  *
17  * The Initial Developer of the Original Code is
18  * Michael Jumper.
19  * Portions created by the Initial Developer are Copyright (C) 2010
20  * the Initial Developer. All Rights Reserved.
21  *
22  * Contributor(s):
23  * Matt Hortman
24  *
25  * Alternatively, the contents of this file may be used under the terms of
26  * either the GNU General Public License Version 2 or later (the "GPL"), or
27  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
28  * in which case the provisions of the GPL or the LGPL are applicable instead
29  * of those above. If you wish to allow use of your version of this file only
30  * under the terms of either the GPL or the LGPL, and not to allow others to
31  * use your version of this file under the terms of the MPL, indicate your
32  * decision by deleting the provisions above and replace them with the notice
33  * and other provisions required by the GPL or the LGPL. If you do not delete
34  * the provisions above, a recipient may use your version of this file under
35  * the terms of any one of the MPL, the GPL or the LGPL.
36  *
37  * ***** END LICENSE BLOCK ***** */
38
39 // Guacamole namespace
40 var Guacamole = Guacamole || {};
41
42
43 /**
44  * Guacamole protocol client. Given a display element and {@link Guacamole.Tunnel},
45  * automatically handles incoming and outgoing Guacamole instructions via the
46  * provided tunnel, updating the display using one or more canvas elements.
47  * 
48  * @constructor
49  * @param {Guacamole.Tunnel} tunnel The tunnel to use to send and receive
50  *                                  Guacamole instructions.
51  */
52 Guacamole.Client = function(tunnel) {
53
54     var guac_client = this;
55
56     var STATE_IDLE          = 0;
57     var STATE_CONNECTING    = 1;
58     var STATE_WAITING       = 2;
59     var STATE_CONNECTED     = 3;
60     var STATE_DISCONNECTING = 4;
61     var STATE_DISCONNECTED  = 5;
62
63     var currentState = STATE_IDLE;
64     
65     var currentTimestamp = 0;
66     var pingInterval = null;
67
68     var displayWidth = 0;
69     var displayHeight = 0;
70
71     /**
72      * Translation from Guacamole protocol line caps to Layer line caps.
73      */
74     var lineCap = {
75         0: "butt",
76         1: "round",
77         2: "square"
78     };
79
80     /**
81      * Translation from Guacamole protocol line caps to Layer line caps.
82      */
83     var lineJoin = {
84         0: "bevel",
85         1: "miter",
86         2: "round"
87     };
88
89     // Create display
90     var display = document.createElement("div");
91     display.style.position = "relative";
92     display.style.width = displayWidth + "px";
93     display.style.height = displayHeight + "px";
94
95     // Create default layer
96     var default_layer_container = new Guacamole.Client.LayerContainer(displayWidth, displayHeight);
97
98     // Position default layer
99     var default_layer_container_element = default_layer_container.getElement();
100     default_layer_container_element.style.position = "absolute";
101     default_layer_container_element.style.left = "0px";
102     default_layer_container_element.style.top  = "0px";
103
104     // Create cursor layer
105     var cursor = new Guacamole.Client.LayerContainer(0, 0);
106     cursor.getLayer().setChannelMask(Guacamole.Layer.SRC);
107
108     // Position cursor layer
109     var cursor_element = cursor.getElement();
110     cursor_element.style.position = "absolute";
111     cursor_element.style.left = "0px";
112     cursor_element.style.top  = "0px";
113
114     // Add default layer and cursor to display
115     display.appendChild(default_layer_container.getElement());
116     display.appendChild(cursor.getElement());
117
118     // Initially, only default layer exists
119     var layers =  [default_layer_container];
120
121     // No initial buffers
122     var buffers = [];
123
124     tunnel.onerror = function(message) {
125         if (guac_client.onerror)
126             guac_client.onerror(message);
127     };
128
129     function setState(state) {
130         if (state != currentState) {
131             currentState = state;
132             if (guac_client.onstatechange)
133                 guac_client.onstatechange(currentState);
134         }
135     }
136
137     function isConnected() {
138         return currentState == STATE_CONNECTED
139             || currentState == STATE_WAITING;
140     }
141
142     var cursorHotspotX = 0;
143     var cursorHotspotY = 0;
144
145     var cursorX = 0;
146     var cursorY = 0;
147
148     function moveCursor(x, y) {
149
150         var element = cursor.getElement();
151
152         // Update rect
153         element.style.left = (x - cursorHotspotX) + "px";
154         element.style.top  = (y - cursorHotspotY) + "px";
155
156         // Update stored position
157         cursorX = x;
158         cursorY = y;
159
160     }
161
162     guac_client.getDisplay = function() {
163         return display;
164     };
165
166     guac_client.sendKeyEvent = function(pressed, keysym) {
167         // Do not send requests if not connected
168         if (!isConnected())
169             return;
170
171         tunnel.sendMessage("key", keysym, pressed);
172     };
173
174     guac_client.sendMouseState = function(mouseState) {
175
176         // Do not send requests if not connected
177         if (!isConnected())
178             return;
179
180         // Update client-side cursor
181         moveCursor(
182             mouseState.x,
183             mouseState.y
184         );
185
186         // Build mask
187         var buttonMask = 0;
188         if (mouseState.left)   buttonMask |= 1;
189         if (mouseState.middle) buttonMask |= 2;
190         if (mouseState.right)  buttonMask |= 4;
191         if (mouseState.up)     buttonMask |= 8;
192         if (mouseState.down)   buttonMask |= 16;
193
194         // Send message
195         tunnel.sendMessage("mouse", mouseState.x, mouseState.y, buttonMask);
196     };
197
198     guac_client.setClipboard = function(data) {
199
200         // Do not send requests if not connected
201         if (!isConnected())
202             return;
203
204         tunnel.sendMessage("clipboard", data);
205     };
206
207     // Handlers
208     guac_client.onstatechange = null;
209     guac_client.onname = null;
210     guac_client.onerror = null;
211     guac_client.onclipboard = null;
212
213     // Layers
214     function getBufferLayer(index) {
215
216         index = -1 - index;
217         var buffer = buffers[index];
218
219         // Create buffer if necessary
220         if (buffer == null) {
221             buffer = new Guacamole.Layer(0, 0);
222             buffer.autosize = 1;
223             buffers[index] = buffer;
224         }
225
226         return buffer;
227
228     }
229
230     function getLayerContainer(index) {
231
232         var layer = layers[index];
233         if (layer == null) {
234
235             // Add new layer
236             layer = new Guacamole.Client.LayerContainer(displayWidth, displayHeight);
237             layers[index] = layer;
238
239             // Get and position layer
240             var layer_element = layer.getElement();
241             layer_element.style.position = "absolute";
242             layer_element.style.left = "0px";
243             layer_element.style.top = "0px";
244
245             // Add to default layer container
246             default_layer_container.getElement().appendChild(layer_element);
247
248         }
249
250         return layer;
251
252     }
253
254     function getLayer(index) {
255        
256         // If buffer, just get layer
257         if (index < 0)
258             return getBufferLayer(index);
259
260         // Otherwise, retrieve layer from layer container
261         return getLayerContainer(index).getLayer();
262
263     }
264
265     var instructionHandlers = {
266
267         "arc": function(parameters) {
268
269             var layer = getLayer(parseInt(parameters[0]));
270             var x = parseInt(parameters[1]);
271             var y = parseInt(parameters[2]);
272             var radius = parseInt(parameters[3]);
273             var startAngle = parseFloat(parameters[4]);
274             var endAngle = parseFloat(parameters[5]);
275
276             layer.arc(x, y, radius, startAngle, endAngle);
277
278         },
279
280         "cfill": function(parameters) {
281
282             var channelMask = parseInt(parameters[0]);
283             var layer = getLayer(parseInt(parameters[1]));
284             var r = parseInt(parameters[2]);
285             var g = parseInt(parameters[3]);
286             var b = parseInt(parameters[4]);
287             var a = parseInt(parameters[5]);
288
289             layer.setChannelMask(channelMask);
290
291             layer.fillColor(r, g, b, a);
292
293         },
294
295         "clip": function(parameters) {
296
297             var layer = getLayer(parseInt(parameters[0]));
298
299             layer.clip();
300
301         },
302
303         "clipboard": function(parameters) {
304             if (guac_client.onclipboard) guac_client.onclipboard(parameters[0]);
305         },
306
307         "close": function(parameters) {
308
309             var layer = getLayer(parseInt(parameters[0]));
310
311             layer.close();
312
313         },
314
315         "copy": function(parameters) {
316
317             var srcL = getLayer(parseInt(parameters[0]));
318             var srcX = parseInt(parameters[1]);
319             var srcY = parseInt(parameters[2]);
320             var srcWidth = parseInt(parameters[3]);
321             var srcHeight = parseInt(parameters[4]);
322             var channelMask = parseInt(parameters[5]);
323             var dstL = getLayer(parseInt(parameters[6]));
324             var dstX = parseInt(parameters[7]);
325             var dstY = parseInt(parameters[8]);
326
327             dstL.setChannelMask(channelMask);
328
329             dstL.copy(
330                 srcL,
331                 srcX,
332                 srcY,
333                 srcWidth, 
334                 srcHeight, 
335                 dstX,
336                 dstY 
337             );
338
339         },
340
341         "cstroke": function(parameters) {
342
343             var channelMask = parseInt(parameters[0]);
344             var layer = getLayer(parseInt(parameters[1]));
345             var cap = lineCap[parseInt(parameters[2])];
346             var join = lineJoin[parseInt(parameters[3])];
347             var thickness = parseInt(parameters[4]);
348             var r = parseInt(parameters[5]);
349             var g = parseInt(parameters[6]);
350             var b = parseInt(parameters[7]);
351             var a = parseInt(parameters[8]);
352
353             layer.setChannelMask(channelMask);
354
355             layer.strokeColor(cap, join, thickness, r, g, b, a);
356
357         },
358
359         "cursor": function(parameters) {
360
361             cursorHotspotX = parseInt(parameters[0]);
362             cursorHotspotY = parseInt(parameters[1]);
363             var srcL = getLayer(parseInt(parameters[2]));
364             var srcX = parseInt(parameters[3]);
365             var srcY = parseInt(parameters[4]);
366             var srcWidth = parseInt(parameters[5]);
367             var srcHeight = parseInt(parameters[6]);
368
369             // Reset cursor size
370             cursor.resize(srcWidth, srcHeight);
371
372             // Draw cursor to cursor layer
373             cursor.getLayer().copy(
374                 srcL,
375                 srcX,
376                 srcY,
377                 srcWidth, 
378                 srcHeight, 
379                 0,
380                 0 
381             );
382
383             // Update cursor position (hotspot may have changed)
384             moveCursor(cursorX, cursorY);
385
386         },
387
388         "curve": function(parameters) {
389
390             var layer = getLayer(parseInt(parameters[0]));
391             var cp1x = parseInt(parameters[1]);
392             var cp1y = parseInt(parameters[2]);
393             var cp2x = parseInt(parameters[3]);
394             var cp2y = parseInt(parameters[4]);
395             var x = parseInt(parameters[5]);
396             var y = parseInt(parameters[6]);
397
398             layer.curveTo(cp1x, cp1y, cp2x, cp2y, x, y);
399
400         },
401
402         "dispose": function(parameters) {
403             
404             var layer_index = parseInt(parameters[0]);
405
406             // If visible layer, remove from parent
407             if (layer_index > 0) {
408
409                 // Get container element
410                 var layer_container = getLayerContainer(layer_index).getElement();
411
412                 // Remove from parent
413                 layer_container.parentNode.removeChild(layer_container);
414
415                 // Delete reference
416                 delete layers[layer_index];
417
418             }
419
420             // If buffer, just delete reference
421             else if (layer_index < 0)
422                 delete buffers[-1 - layer_index];
423
424             // Attempting to dispose the root layer currently has no effect.
425
426         },
427
428         "error": function(parameters) {
429             if (guac_client.onerror) guac_client.onerror(parameters[0]);
430             guac_client.disconnect();
431         },
432
433         "identity": function(parameters) {
434
435             var layer = getLayer(parseInt(parameters[0]));
436
437             layer.setTransform(
438                 1, 0, 0,
439                 0, 1, 0
440               /*0, 0, 1*/
441             );
442
443         },
444
445         "lfill": function(parameters) {
446
447             var channelMask = parseInt(parameters[0]);
448             var layer = getLayer(parseInt(parameters[1]));
449             var srcLayer = getLayer(parseInt(parameters[2]));
450
451             layer.setChannelMask(channelMask);
452
453             layer.fillLayer(srcLayer);
454
455         },
456
457         "line": function(parameters) {
458
459             var layer = getLayer(parseInt(parameters[0]));
460             var x = parseInt(parameters[1]);
461             var y = parseInt(parameters[2]);
462
463             layer.lineTo(x, y);
464
465         },
466
467         "lstroke": function(parameters) {
468
469             var channelMask = parseInt(parameters[0]);
470             var layer = getLayer(parseInt(parameters[1]));
471             var srcLayer = getLayer(parseInt(parameters[2]));
472
473             layer.setChannelMask(channelMask);
474
475             layer.strokeLayer(srcLayer);
476
477         },
478
479         "move": function(parameters) {
480             
481             var layer_index = parseInt(parameters[0]);
482             var parent_index = parseInt(parameters[1]);
483             var x = parseInt(parameters[2]);
484             var y = parseInt(parameters[3]);
485             var z = parseInt(parameters[4]);
486
487             // Only valid for non-default layers
488             if (layer_index > 0 && parent_index >= 0) {
489
490                 // Get container element
491                 var layer_container = getLayerContainer(layer_index).getElement();
492                 var parent = getLayerContainer(parent_index).getElement();
493
494                 // Set parent if necessary
495                 if (!(layer_container.parentNode === parent))
496                     parent.appendChild(layer_container);
497
498                 // Move layer
499                 layer_container.style.left   = x + "px";
500                 layer_container.style.top    = y + "px";
501                 layer_container.style.zIndex = z;
502
503             }
504
505         },
506
507         "name": function(parameters) {
508             if (guac_client.onname) guac_client.onname(parameters[0]);
509         },
510
511         "png": function(parameters) {
512
513             var channelMask = parseInt(parameters[0]);
514             var layer = getLayer(parseInt(parameters[1]));
515             var x = parseInt(parameters[2]);
516             var y = parseInt(parameters[3]);
517             var data = parameters[4];
518
519             layer.setChannelMask(channelMask);
520
521             layer.draw(
522                 x,
523                 y,
524                 "data:image/png;base64," + data
525             );
526
527             // If received first update, no longer waiting.
528             if (currentState == STATE_WAITING)
529                 setState(STATE_CONNECTED);
530
531         },
532
533         "rect": function(parameters) {
534
535             var layer = getLayer(parseInt(parameters[0]));
536             var x = parseInt(parameters[1]);
537             var y = parseInt(parameters[2]);
538             var w = parseInt(parameters[3]);
539             var h = parseInt(parameters[4]);
540
541             layer.rect(x, y, w, h);
542
543         },
544         
545         "reset": function(parameters) {
546
547             var layer = getLayer(parseInt(parameters[0]));
548
549             layer.reset();
550
551         },
552  
553         "size": function(parameters) {
554
555             var layer_index = parseInt(parameters[0]);
556             var width = parseInt(parameters[1]);
557             var height = parseInt(parameters[2]);
558
559             // Resize layer
560             var layer_container = getLayerContainer(layer_index);
561             layer_container.resize(width, height);
562
563             // If layer is default, resize display
564             if (layer_index == 0) {
565
566                 displayWidth = width;
567                 displayHeight = height;
568
569                 // Update (set) display size
570                 display.style.width = displayWidth + "px";
571                 display.style.height = displayHeight + "px";
572
573             }
574
575         },
576         
577         "start": function(parameters) {
578
579             var layer = getLayer(parseInt(parameters[0]));
580             var x = parseInt(parameters[1]);
581             var y = parseInt(parameters[2]);
582
583             layer.moveTo(x, y);
584
585         },
586
587         "sync": function(parameters) {
588
589             var timestamp = parameters[0];
590
591             // When all layers have finished rendering all instructions
592             // UP TO THIS POINT IN TIME, send sync response.
593
594             var layersToSync = 0;
595             function syncLayer() {
596
597                 layersToSync--;
598
599                 // Send sync response when layers are finished
600                 if (layersToSync == 0) {
601                     if (timestamp != currentTimestamp) {
602                         tunnel.sendMessage("sync", timestamp);
603                         currentTimestamp = timestamp;
604                     }
605                 }
606
607             }
608
609             // Count active, not-ready layers and install sync tracking hooks
610             for (var i=0; i<layers.length; i++) {
611
612                 var layer = layers[i].getLayer();
613                 if (layer && !layer.isReady()) {
614                     layersToSync++;
615                     layer.sync(syncLayer);
616                 }
617
618             }
619
620             // If all layers are ready, then we didn't install any hooks.
621             // Send sync message now,
622             if (layersToSync == 0) {
623                 if (timestamp != currentTimestamp) {
624                     tunnel.sendMessage("sync", timestamp);
625                     currentTimestamp = timestamp;
626                 }
627             }
628
629         },
630
631         "transfer": function(parameters) {
632
633             var srcL = getLayer(parseInt(parameters[0]));
634             var srcX = parseInt(parameters[1]);
635             var srcY = parseInt(parameters[2]);
636             var srcWidth = parseInt(parameters[3]);
637             var srcHeight = parseInt(parameters[4]);
638             var transferFunction = Guacamole.Client.DefaultTransferFunction[parameters[5]];
639             var dstL = getLayer(parseInt(parameters[6]));
640             var dstX = parseInt(parameters[7]);
641             var dstY = parseInt(parameters[8]);
642
643             dstL.transfer(
644                 srcL,
645                 srcX,
646                 srcY,
647                 srcWidth, 
648                 srcHeight, 
649                 dstX,
650                 dstY,
651                 transferFunction
652             );
653
654         },
655
656         "transform": function(parameters) {
657
658             var layer = getLayer(parseInt(parameters[0]));
659             var a = parseFloat(parameters[1]);
660             var b = parseFloat(parameters[2]);
661             var c = parseFloat(parameters[3]);
662             var d = parseFloat(parameters[4]);
663             var e = parseFloat(parameters[5]);
664             var f = parseFloat(parameters[6]);
665
666             layer.transform(a, b, c, d, e, f);
667
668         }
669       
670     };
671
672
673     tunnel.oninstruction = function(opcode, parameters) {
674
675         var handler = instructionHandlers[opcode];
676         if (handler)
677             handler(parameters);
678
679     };
680
681
682     guac_client.disconnect = function() {
683
684         // Only attempt disconnection not disconnected.
685         if (currentState != STATE_DISCONNECTED
686                 && currentState != STATE_DISCONNECTING) {
687
688             setState(STATE_DISCONNECTING);
689
690             // Stop ping
691             if (pingInterval)
692                 window.clearInterval(pingInterval);
693
694             // Send disconnect message and disconnect
695             tunnel.sendMessage("disconnect");
696             tunnel.disconnect();
697             setState(STATE_DISCONNECTED);
698
699         }
700
701     };
702     
703     guac_client.connect = function(data) {
704
705         setState(STATE_CONNECTING);
706
707         try {
708             tunnel.connect(data);
709         }
710         catch (e) {
711             setState(STATE_IDLE);
712             throw e;
713         }
714
715         // Ping every 5 seconds (ensure connection alive)
716         pingInterval = window.setInterval(function() {
717             tunnel.sendMessage("sync", currentTimestamp);
718         }, 5000);
719
720         setState(STATE_WAITING);
721     };
722
723 };
724
725
726 /**
727  * Simple container for Guacamole.Layer, allowing layers to be easily
728  * repositioned and nested. This allows certain operations to be accelerated
729  * through DOM manipulation, rather than raster operations.
730  * 
731  * @constructor
732  * 
733  * @param {Number} width The width of the Layer, in pixels. The canvas element
734  *                       backing this Layer will be given this width.
735  *                       
736  * @param {Number} height The height of the Layer, in pixels. The canvas element
737  *                        backing this Layer will be given this height.
738  */
739 Guacamole.Client.LayerContainer = function(width, height) {
740
741     /**
742      * Reference to this LayerContainer.
743      * @private
744      */
745     var layer_container = this;
746
747     // Create layer with given size
748     var layer = new Guacamole.Layer(width, height);
749
750     // Set layer position
751     var canvas = layer.getCanvas();
752     canvas.style.position = "absolute";
753     canvas.style.left = "0px";
754     canvas.style.top = "0px";
755
756     // Create div with given size
757     var div = document.createElement("div");
758     div.appendChild(canvas);
759     div.style.width = width + "px";
760     div.style.height = height + "px";
761
762     /**
763      * Changes the size of this LayerContainer and the contained Layer to the
764      * given width and height.
765      * 
766      * @param {Number} width The new width to assign to this Layer.
767      * @param {Number} height The new height to assign to this Layer.
768      */
769     layer_container.resize = function(width, height) {
770
771         // Resize layer
772         layer.resize(width, height);
773
774         // Resize containing div
775         div.style.width = width + "px";
776         div.style.height = height + "px";
777
778     };
779   
780     /**
781      * Returns the Layer contained within this LayerContainer.
782      * @returns {Guacamole.Layer} The Layer contained within this LayerContainer.
783      */
784     layer_container.getLayer = function() {
785         return layer;
786     };
787
788     /**
789      * Returns the element containing the Layer within this LayerContainer.
790      * @returns {Element} The element containing the Layer within this LayerContainer.
791      */
792     layer_container.getElement = function() {
793         return div;
794     };
795
796 };
797
798 /**
799  * Map of all Guacamole binary raster operations to transfer functions.
800  * @private
801  */
802 Guacamole.Client.DefaultTransferFunction = {
803
804     /* BLACK */
805     0x0: function (src, dst) {
806         dst.red = dst.green = dst.blue = 0x00;
807     },
808
809     /* WHITE */
810     0xF: function (src, dst) {
811         dst.red = dst.green = dst.blue = 0xFF;
812     },
813
814     /* SRC */
815     0x3: function (src, dst) {
816         dst.red   = src.red;
817         dst.green = src.green;
818         dst.blue  = src.blue;
819         dst.alpha = src.alpha;
820     },
821
822     /* DEST (no-op) */
823     0x5: function (src, dst) {
824         // Do nothing
825     },
826
827     /* Invert SRC */
828     0xC: function (src, dst) {
829         dst.red   = 0xFF & ~src.red;
830         dst.green = 0xFF & ~src.green;
831         dst.blue  = 0xFF & ~src.blue;
832         dst.alpha =  src.alpha;
833     },
834     
835     /* Invert DEST */
836     0xA: function (src, dst) {
837         dst.red   = 0xFF & ~dst.red;
838         dst.green = 0xFF & ~dst.green;
839         dst.blue  = 0xFF & ~dst.blue;
840     },
841
842     /* AND */
843     0x1: function (src, dst) {
844         dst.red   =  ( src.red   &  dst.red);
845         dst.green =  ( src.green &  dst.green);
846         dst.blue  =  ( src.blue  &  dst.blue);
847     },
848
849     /* NAND */
850     0xE: function (src, dst) {
851         dst.red   = 0xFF & ~( src.red   &  dst.red);
852         dst.green = 0xFF & ~( src.green &  dst.green);
853         dst.blue  = 0xFF & ~( src.blue  &  dst.blue);
854     },
855
856     /* OR */
857     0x7: function (src, dst) {
858         dst.red   =  ( src.red   |  dst.red);
859         dst.green =  ( src.green |  dst.green);
860         dst.blue  =  ( src.blue  |  dst.blue);
861     },
862
863     /* NOR */
864     0x8: function (src, dst) {
865         dst.red   = 0xFF & ~( src.red   |  dst.red);
866         dst.green = 0xFF & ~( src.green |  dst.green);
867         dst.blue  = 0xFF & ~( src.blue  |  dst.blue);
868     },
869
870     /* XOR */
871     0x6: function (src, dst) {
872         dst.red   =  ( src.red   ^  dst.red);
873         dst.green =  ( src.green ^  dst.green);
874         dst.blue  =  ( src.blue  ^  dst.blue);
875     },
876
877     /* XNOR */
878     0x9: function (src, dst) {
879         dst.red   = 0xFF & ~( src.red   ^  dst.red);
880         dst.green = 0xFF & ~( src.green ^  dst.green);
881         dst.blue  = 0xFF & ~( src.blue  ^  dst.blue);
882     },
883
884     /* AND inverted source */
885     0x4: function (src, dst) {
886         dst.red   =  0xFF & (~src.red   &  dst.red);
887         dst.green =  0xFF & (~src.green &  dst.green);
888         dst.blue  =  0xFF & (~src.blue  &  dst.blue);
889     },
890
891     /* OR inverted source */
892     0xD: function (src, dst) {
893         dst.red   =  0xFF & (~src.red   |  dst.red);
894         dst.green =  0xFF & (~src.green |  dst.green);
895         dst.blue  =  0xFF & (~src.blue  |  dst.blue);
896     },
897
898     /* AND inverted destination */
899     0x2: function (src, dst) {
900         dst.red   =  0xFF & ( src.red   & ~dst.red);
901         dst.green =  0xFF & ( src.green & ~dst.green);
902         dst.blue  =  0xFF & ( src.blue  & ~dst.blue);
903     },
904
905     /* OR inverted destination */
906     0xB: function (src, dst) {
907         dst.red   =  0xFF & ( src.red   | ~dst.red);
908         dst.green =  0xFF & ( src.green | ~dst.green);
909         dst.blue  =  0xFF & ( src.blue  | ~dst.blue);
910     }
911
912 };