GUACAMOLE-884: Document implications of using drawStream() vs. the other drawing functions.

This commit is contained in:
Michael Jumper
2019-09-29 22:13:19 -07:00
parent 4e130d2afd
commit 6649c5d334

View File

@@ -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.