From 6649c5d3340224bc4245673903b9f5cb341dc065 Mon Sep 17 00:00:00 2001 From: Michael Jumper Date: Sun, 29 Sep 2019 22:13:19 -0700 Subject: [PATCH] GUACAMOLE-884: Document implications of using drawStream() vs. the other drawing functions. --- guacamole-common-js/src/main/webapp/modules/Display.js | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/guacamole-common-js/src/main/webapp/modules/Display.js b/guacamole-common-js/src/main/webapp/modules/Display.js index 0bc569f0a..853c69acc 100644 --- a/guacamole-common-js/src/main/webapp/modules/Display.js +++ b/guacamole-common-js/src/main/webapp/modules/Display.js @@ -595,7 +595,10 @@ Guacamole.Display = function() { /** * Draws the image within the given stream at the given coordinates. The * image will be loaded automatically, and this and any future operations - * will wait for the image to finish loading. + * will wait for the image to finish loading. This function will + * automatically choose an approriate method for reading and decoding the + * given image stream, and should be preferred for received streams except + * where manual decoding of the stream is unavoidable. * * @param {Guacamole.Layer} layer * The layer to draw upon.