src/references/instructions/server/drawing/transfer.xml

<?xml version="1.0" encoding="UTF-8"?>

<section xml:id="transfer-instruction" 
    xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en"
    xmlns:xi="http://www.w3.org/2001/XInclude">
    <title>transfer</title>

    <indexterm>
        <primary>transfer</primary>
    </indexterm>
    <para>Transfers image data from the specified rectangle of the specified layer or buffer to a
        different location of another specified layer or buffer, using the specified transfer
        function. </para>
    <para>For a list of available functions, see the definition of
            <classname>guac_transfer_function</classname> within the <link
            xmlns:xlink="http://www.w3.org/1999/xlink"
            xlink:href="https://github.com/apache/incubator-guacamole-server/blob/master/src/libguac/guacamole/protocol-types.h"
                ><filename>guacamole/protocol-types.h</filename></link> header included with
        libguac.</para>
    <variablelist>
        <varlistentry>
            <term><parameter>srclayer</parameter></term>
            <listitem>
                <para>The index of the layer to transfer image data from.</para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>srcx</parameter></term>
            <listitem>
                <para>The X coordinate of the upper-left corner of the source
                    rectangle within the source layer.</para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>srcy</parameter></term>
            <listitem>
                <para>The Y coordinate of the upper-left corner of the source
                    rectangle within the source layer.</para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>srcwidth</parameter></term>
            <listitem>
                <para>The width of the source rectangle within the source
                    layer.</para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>srcheight</parameter></term>
            <listitem>
                <para>The height of the source rectangle within the source
                    layer.</para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>function</parameter></term>
            <listitem>
                <para>The index of the transfer function to use.</para>
                <para>For a list of available functions, see the definition of
                        <classname>guac_transfer_function</classname> within the <link
                        xmlns:xlink="http://www.w3.org/1999/xlink"
                        xlink:href="https://github.com/apache/incubator-guacamole-server/blob/master/src/libguac/guacamole/protocol-types.h"
                            ><filename>guacamole/protocol-types.h</filename></link> header included
                    with libguac.</para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>dstlayer</parameter></term>
            <listitem>
                <para>The index of the layer to draw the image data to.</para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>dstx</parameter></term>
            <listitem>
                <para>The X coordinate of the upper-left corner of the
                    destination within the destination layer.</para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>dsty</parameter></term>
            <listitem>
                <para>The Y coordinate of the upper-left corner of the
                    destination within the destination layer.</para>
            </listitem>
        </varlistentry>
    </variablelist>

</section>