<?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='xcrefcurman'>
<!--  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/XCreFCur.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>XCreateFontCursor</refentrytitle>
<manvolnum>3X11</manvolnum>
<refmiscinfo class='date'>__xorgversion__</refmiscinfo>
<refmiscinfo class='source'>XLIB FUNCTIONS</refmiscinfo>
</refmeta>
<refnamediv id='name'>
<refname>XCreateFontCursor</refname>
<refname>XCreatePixmapCursor</refname>
<refname>XCreateGlyphCursor</refname>
<refpurpose>create cursors</refpurpose>
</refnamediv>
<!-- body begins here -->

<refsect1 id='syntax'><title>SYNTAX</title>
<para>#include &lt;X11/cursorfont.h&gt;</para>

<para>Cursor XCreateFontCursor&hairsp;(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;, unsigned int
<emphasis remap='I'>shape</emphasis>&hairsp;);</para> 

<para>Cursor XCreatePixmapCursor&hairsp;(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;, Pixmap
<emphasis remap='I'>source</emphasis>&hairsp;, Pixmap <emphasis remap='I'>mask</emphasis>&hairsp;, XColor *<emphasis remap='I'>foreground_color</emphasis>&hairsp;, XColor
*<emphasis remap='I'>background_color</emphasis>&hairsp;, unsigned int <emphasis remap='I'>x</emphasis>&hairsp;, <emphasis remap='I'>y</emphasis>&hairsp;);</para> 

<para>Cursor XCreateGlyphCursor&hairsp;(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;, Font
<emphasis remap='I'>source_font</emphasis>&hairsp;, Font <emphasis remap='I'>mask_font</emphasis>&hairsp;, unsigned int <emphasis remap='I'>source_char</emphasis>&hairsp;,
unsigned int <emphasis remap='I'>mask_char</emphasis>&hairsp;, XColor *<emphasis remap='I'>foreground_color</emphasis>&hairsp;, XColor
*<emphasis remap='I'>background_color</emphasis>&hairsp;);</para> 
</refsect1>

<refsect1 id='arguments'><title>ARGUMENTS</title>
<variablelist remap='IP'>
  <varlistentry>
  <term><emphasis remap='I'>background_color</emphasis></term>
  <listitem>
<para>Specifies the RGB values for the background of the source.</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'>foreground_color</emphasis></term>
  <listitem>
<para>Specifies the RGB values for the foreground of the source.</para> 
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>mask</emphasis></term>
  <listitem>
<para>Specifies the cursor's source bits to be displayed or
<emphasis remap='I'>&hairsp;None&hairsp;</emphasis>.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>mask_char</emphasis></term>
  <listitem>
<para>Specifies the glyph character for the mask.</para> 
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>mask_font</emphasis></term>
  <listitem>
<para>Specifies the font for the mask glyph or
<emphasis remap='I'>&hairsp;None&hairsp;</emphasis>.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>shape</emphasis></term>
  <listitem>
<para>Specifies the shape of the cursor.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>source</emphasis></term>
  <listitem>
<para>Specifies the shape of the source cursor.</para>
<!--  *** JIM: NEED TO CHECK THIS. *** -->
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>source_char</emphasis></term>
  <listitem>
<para>Specifies the character glyph for the source.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>source_font</emphasis></term>
  <listitem>
<para>Specifies the font for the source glyph.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>x</emphasis></term>
<!-- .br -->
<!-- .ns -->
  <term><emphasis remap='I'>y</emphasis></term>
  <listitem>
<para>Specify the x and y coordinates, which indicate the hotspot relative to the source's origin.</para>
  </listitem>
  </varlistentry>
</variablelist>
</refsect1>

<refsect1 id='description'><title>DESCRIPTION</title>
<para>X provides a set of standard cursor shapes in a special font named
cursor.
Applications are encouraged to use this interface for their cursors
because the font can be customized for the individual display type.
The shape argument specifies which glyph of the standard fonts
to use.</para>

<para>The hotspot comes from the information stored in the cursor font.
The initial colors of a cursor are a black foreground and a white
background (see
<emphasis remap='I'>&hairsp;XRecolorCursor&hairsp;</emphasis>).</para>

<para><emphasis remap='I'>&hairsp;XCreateFontCursor&hairsp;</emphasis>
can generate
<emphasis remap='I'>&hairsp;BadAlloc&hairsp;</emphasis>
and
<emphasis remap='I'>&hairsp;BadValue&hairsp;</emphasis>
errors.</para>

<para>The
<emphasis remap='I'>&hairsp;XCreatePixmapCursor&hairsp;</emphasis>
function creates a cursor and returns the cursor ID associated with it.
The foreground and background RGB values must be specified using
foreground_color and background_color,
even if the X server only has a
<emphasis remap='I'>&hairsp;StaticGray&hairsp;</emphasis>
or
<emphasis remap='I'>&hairsp;GrayScale&hairsp;</emphasis>
screen.
The foreground color is used for the pixels set to 1 in the
source, and the background color is used for the pixels set to 0.
Both source and mask, if specified, must have depth one (or a 
<emphasis remap='I'>&hairsp;BadMatch&hairsp;</emphasis>
error results) but can have any root.
The mask argument defines the shape of the cursor.
The pixels set to 1 in the mask define which source pixels are displayed,
and the pixels set to 0 define which pixels are ignored.
If no mask is given, 
all pixels of the source are displayed.
The mask, if present, must be the same size as the pixmap defined by the 
source argument, or a
<emphasis remap='I'>&hairsp;BadMatch&hairsp;</emphasis>
error results.
The hotspot must be a point within the source,
or a
<emphasis remap='I'>&hairsp;BadMatch&hairsp;</emphasis>
error results.</para>

<para>The components of the cursor can be transformed arbitrarily to meet
display limitations.
The pixmaps can be freed immediately if no further explicit references
to them are to be made.
Subsequent drawing in the source or mask pixmap has an undefined effect on the
cursor.
The X server might or might not make a copy of the pixmap.</para>

<para><emphasis remap='I'>&hairsp;XCreatePixmapCursor&hairsp;</emphasis>
can generate
<emphasis remap='I'>&hairsp;BadAlloc&hairsp;</emphasis>
and
<emphasis remap='I'>&hairsp;BadPixmap&hairsp;</emphasis>
errors.</para>

<para>The
<emphasis remap='I'>&hairsp;XCreateGlyphCursor&hairsp;</emphasis>
function is similar to
<emphasis remap='I'>&hairsp;XCreatePixmapCursor&hairsp;</emphasis>
except that the source and mask bitmaps are obtained from the specified 
font glyphs.
The source_char must be a defined glyph in source_font, 
or a
<emphasis remap='I'>&hairsp;BadValue&hairsp;</emphasis>
error results.
If mask_font is given, 
mask_char must be a defined glyph in mask_font,
or a
<emphasis remap='I'>&hairsp;BadValue&hairsp;</emphasis>
error results.
The mask_font and character are optional.
The origins of the source_char and mask_char (if defined) glyphs are
positioned coincidently and define the hotspot. 
The source_char and mask_char need not have the same bounding box metrics, 
and there is no restriction on the placement of the hotspot relative to the bounding
boxes. 
If no mask_char is given, all pixels of the source are displayed.
You can free the fonts immediately by calling
<emphasis remap='I'>&hairsp;XFreeFont&hairsp;</emphasis>
if no further explicit references to them are to be made.</para> 

<para>For 2-byte matrix fonts, 
the 16-bit value should be formed with the byte1
member in the most significant byte and the byte2 member in the 
least significant byte.</para>

<para><emphasis remap='I'>&hairsp;XCreateGlyphCursor&hairsp;</emphasis>
can generate
<emphasis remap='I'>&hairsp;BadAlloc&hairsp;</emphasis>,
<emphasis remap='I'>&hairsp;BadFont&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;BadAlloc&hairsp;</emphasis></term>
  <listitem>
<para>The server failed to allocate the requested resource or server memory.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>&hairsp;BadFont&hairsp;</emphasis></term>
  <listitem>
<para>A value for a Font or GContext argument does not name a defined Font.</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;BadPixmap&hairsp;</emphasis></term>
  <listitem>
<para>A value for a Pixmap argument does not name a defined Pixmap.</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>XDefineCursor(3X11),
XLoadFont(3X11),
XRecolorCursor(3X11)
<!-- .br -->
<userinput>Xlib - C Language X Interface</userinput></para>
</refsect1>
</refentry>

