<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
                   "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<!-- lifted from troff+man by doclifter -->
<refentry id='xcopyareaman'>
<!--  Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium -->

<!--  Permission is hereby granted, free of charge, to any person obtaining -->
<!--  a copy of this software and associated documentation files (the -->
<!--  "Software"), to deal in the Software without restriction, including -->
<!--  without limitation the rights to use, copy, modify, merge, publish, -->
<!--  distribute, sublicense, and/or sell copies of the Software, and to -->
<!--  permit persons to whom the Software is furnished to do so, subject to -->
<!--  the following conditions: -->

<!--  The above copyright notice and this permission notice shall be included -->
<!--  in all copies or substantial portions of the Software. -->

<!--  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS -->
<!--  OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -->
<!--  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -->
<!--  IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR -->
<!--  OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, -->
<!--  ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR -->
<!--  OTHER DEALINGS IN THE SOFTWARE. -->

<!--  Except as contained in this notice, the name of the X Consortium shall -->
<!--  not be used in advertising or otherwise to promote the sale, use or -->
<!--  other dealings in this Software without prior written authorization -->
<!--  from the X Consortium. -->

<!--  Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991 by -->
<!--  Digital Equipment Corporation -->

<!--  Portions Copyright \(co 1990, 1991 by -->
<!--  Tektronix, Inc. -->

<!--  Permission to use, copy, modify and distribute this documentation for -->
<!--  any purpose and without fee is hereby granted, provided that the above -->
<!--  copyright notice appears in all copies and that both that copyright notice -->
<!--  and this permission notice appear in all copies, and that the names of -->
<!--  Digital and Tektronix not be used in in advertising or publicity pertaining -->
<!--  to this documentation without specific, written prior permission. -->
<!--  Digital and Tektronix makes no representations about the suitability -->
<!--  of this documentation for any purpose. -->
<!--  It is provided ``as is'' without express or implied warranty. -->
<!--   -->
<!--  $XFree86: xc/doc/man/X11/XCopyArea.man,v 1.4 2003/04/28 22:17:54 herrb Exp $ -->

<!-- .na -->
<!-- Ds listing suppressed (not used) -->
<!-- De listing suppressed (not used) -->
<!-- FD listing suppressed (not used) -->
<!-- FN listing suppressed (not used) -->
<!-- IN listing suppressed (not used) -->
<!-- C{ listing suppressed (not used) -->
<!-- C} listing suppressed (not used) -->
<!-- Pn listing suppressed (not used) -->
<!-- hN listing suppressed (not used) -->
<!-- NT listing suppressed (not used) -->
<!-- .		\" Note End \-\- doug kraft 3/85 -->
<!-- NE listing suppressed (not used) -->
<!-- .ny0 -->
<refmeta>
<refentrytitle>XCopyArea</refentrytitle>
<manvolnum>3X11</manvolnum>
<refmiscinfo class='date'>__xorgversion__</refmiscinfo>
<refmiscinfo class='source'>XLIB FUNCTIONS</refmiscinfo>
</refmeta>
<refnamediv id='name'>
<refname>XCopyArea</refname>
<refname>XCopyPlane</refname>
<refpurpose>copy areas</refpurpose>
</refnamediv>
<!-- body begins here -->

<refsect1 id='syntax'><title>SYNTAX</title>

<para>int XCopyArea&hairsp;(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;, Drawable <emphasis remap='I'>src</emphasis>&hairsp;, Drawable
<emphasis remap='I'>dest</emphasis>&hairsp;, GC <emphasis remap='I'>gc</emphasis>&hairsp;, int <emphasis remap='I'>src_x</emphasis>&hairsp;, int <emphasis remap='I'>src_y</emphasis>&hairsp;, unsigned
int <emphasis remap='I'>width</emphasis>&hairsp;, unsigned <emphasis remap='I'>height</emphasis>&hairsp;, int <emphasis remap='I'>dest_x</emphasis>&hairsp;, int
<emphasis remap='I'>dest_y</emphasis>&hairsp;);</para>

<para>int XCopyPlane&hairsp;(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;, Drawable <emphasis remap='I'>src</emphasis>&hairsp;, Drawable
<emphasis remap='I'>dest</emphasis>&hairsp;, GC <emphasis remap='I'>gc</emphasis>&hairsp;, int <emphasis remap='I'>src_x</emphasis>&hairsp;, int <emphasis remap='I'>src_y</emphasis>&hairsp;, unsigned
<emphasis remap='I'>width</emphasis>&hairsp;, int <emphasis remap='I'>height</emphasis>&hairsp;, int <emphasis remap='I'>dest_x</emphasis>&hairsp;, int <emphasis remap='I'>dest_y</emphasis>&hairsp;,
unsigned long <emphasis remap='I'>plane</emphasis>&hairsp;);</para> 
</refsect1>

<refsect1 id='arguments'><title>ARGUMENTS</title>
<para>and specify its upper-left corner</para>
<variablelist remap='IP'>
  <varlistentry>
  <term><emphasis remap='I'>dest_x</emphasis></term>
<!-- .br -->
<!-- .ns -->
  <term><emphasis remap='I'>dest_y</emphasis></term>
  <listitem>
<para>Specify the x and y coordinates, which are relative to the origin of the destination rectangle.</para> 
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>display</emphasis></term>
  <listitem>
<para>Specifies the connection to the X server.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>gc</emphasis></term>
  <listitem>
<para>Specifies the GC.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>plane</emphasis></term>
  <listitem>
<para>Specifies the bit plane.
You must set exactly one bit to 1.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>src</emphasis></term>
<!-- .br -->
<!-- .ns -->
  <term><emphasis remap='I'>dest</emphasis></term>
  <listitem>
<para>Specify the source and destination rectangles to be combined.</para> 
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>src_x</emphasis></term>
<!-- .br -->
<!-- .ns -->
  <term><emphasis remap='I'>src_y</emphasis></term>
  <listitem>
<para>Specify the x and y coordinates, 
which are relative to the origin of the source rectangle
and specify its upper-left corner.
and destination rectangles</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>width</emphasis></term>
<!-- .br -->
<!-- .ns -->
  <term><emphasis remap='I'>height</emphasis></term>
  <listitem>
<para>Specify the width and height, which are the dimensions of both the source.</para>
  </listitem>
  </varlistentry>
</variablelist>
</refsect1>

<refsect1 id='description'><title>DESCRIPTION</title>
<para>The
<emphasis remap='I'>&hairsp;XCopyArea&hairsp;</emphasis>
function combines the specified rectangle of src with the specified rectangle 
of dest.
The drawables must have the same root and depth,
or a
<emphasis remap='I'>&hairsp;BadMatch&hairsp;</emphasis>
error results.</para>

<para>If regions of the source rectangle are obscured and have not been
retained in backing store 
or if regions outside the boundaries of the source drawable are specified, 
those regions are not copied. 
Instead, the 
following occurs on all corresponding destination regions that are either
visible or are retained in backing store.  
If the destination is a window with a background other than 
<emphasis remap='I'>&hairsp;None&hairsp;</emphasis>,
corresponding regions
of the destination are tiled with that background
(with plane-mask of all ones and
<emphasis remap='I'>&hairsp;GXcopy&hairsp;</emphasis>
function).
Regardless of tiling or whether the destination is a window or a pixmap,
if graphics-exposures is 
<emphasis remap='I'>&hairsp;True&hairsp;</emphasis>,
then
<emphasis remap='I'>&hairsp;GraphicsExpose&hairsp;</emphasis>
events for all corresponding destination regions are generated.
If graphics-exposures is 
<emphasis remap='I'>&hairsp;True&hairsp;</emphasis>
but no
<emphasis remap='I'>&hairsp;GraphicsExpose&hairsp;</emphasis>
events are generated, a
<emphasis remap='I'>&hairsp;NoExpose&hairsp;</emphasis>
event is generated.
Note that by default graphics-exposures is
<emphasis remap='I'>&hairsp;True&hairsp;</emphasis>
in new GCs.</para>

<para>This function uses these GC components: function, plane-mask, 
subwindow-mode, graphics-exposures, clip-x-origin,
clip-y-origin, and clip-mask.</para>

<para><emphasis remap='I'>&hairsp;XCopyArea&hairsp;</emphasis>
can generate
<emphasis remap='I'>&hairsp;BadDrawable&hairsp;</emphasis>,
<emphasis remap='I'>&hairsp;BadGC&hairsp;</emphasis>,
and
<emphasis remap='I'>&hairsp;BadMatch&hairsp;</emphasis>
errors.</para>

<para>The
<emphasis remap='I'>&hairsp;XCopyPlane&hairsp;</emphasis>
function uses a single bit plane of the specified source rectangle
combined with the specified GC to modify the specified rectangle of dest.
The drawables must have the same root but need not have the same depth.
If the drawables do not have the same root, a
<emphasis remap='I'>&hairsp;BadMatch&hairsp;</emphasis>
error results.
If plane does not have exactly one bit set to 1 and the value of plane
is not less than %2 sup n%, where <emphasis remap='I'>n</emphasis> is the depth of src, a
<emphasis remap='I'>&hairsp;BadValue&hairsp;</emphasis>
error results.</para>

<para>Effectively, 
<emphasis remap='I'>&hairsp;XCopyPlane&hairsp;</emphasis>
forms a pixmap of the same depth as the rectangle of dest and with a
size specified by the source region. 
It uses the foreground/background pixels in the GC (foreground
everywhere the bit plane in src contains a bit set to 1,
background everywhere the bit plane in src contains a bit set to 0)
and the equivalent of a 
<emphasis remap='I'>&hairsp;CopyArea&hairsp;</emphasis>
protocol request is performed with all the same exposure semantics.
This can also be thought of as using the specified region of the source 
bit plane as a stipple with a fill-style of
<emphasis remap='I'>&hairsp;FillOpaqueStippled&hairsp;</emphasis>
for filling a rectangular area of the destination.</para>

<para>This function uses these GC components: function, plane-mask, foreground,
background, subwindow-mode, graphics-exposures, clip-x-origin, clip-y-origin,
and clip-mask.</para>

<para><emphasis remap='I'>&hairsp;XCopyPlane&hairsp;</emphasis>
can generate
<emphasis remap='I'>&hairsp;BadDrawable&hairsp;</emphasis>,
<emphasis remap='I'>&hairsp;BadGC&hairsp;</emphasis>,
<emphasis remap='I'>&hairsp;BadMatch&hairsp;</emphasis>,
and
<emphasis remap='I'>&hairsp;BadValue&hairsp;</emphasis>
errors.</para>
</refsect1>

<refsect1 id='diagnostics'><title>DIAGNOSTICS</title>
<variablelist remap='TP'>
  <varlistentry>
  <term><emphasis remap='I'>&hairsp;BadDrawable&hairsp;</emphasis></term>
  <listitem>
<para>A value for a Drawable argument does not name a defined Window or Pixmap.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>&hairsp;BadGC&hairsp;</emphasis></term>
  <listitem>
<para>A value for a GContext argument does not name a defined GContext.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>&hairsp;BadMatch&hairsp;</emphasis></term>
  <listitem>
<para>An
<emphasis remap='I'>&hairsp;InputOnly&hairsp;</emphasis>
window is used as a Drawable.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>&hairsp;BadMatch&hairsp;</emphasis></term>
  <listitem>
<para>Some argument or pair of arguments has the correct type and range but fails
to match in some other way required by the request.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>&hairsp;BadValue&hairsp;</emphasis></term>
  <listitem>
<para>Some numeric value falls outside the range of values accepted by the request.
Unless a specific range is specified for an argument, the full range defined
by the argument's type is accepted.  Any argument defined as a set of
alternatives can generate this error.</para>
  </listitem>
  </varlistentry>
</variablelist>
</refsect1>

<refsect1 id='see_also'><title>SEE ALSO</title>
<para>XClearArea(3X11)
<!-- .br -->
<userinput>Xlib - C Language X Interface</userinput></para>
</refsect1>
</refentry>

