dwww Home | Manual pages | Find package

XRecolorCursor(3)                XLIB FUNCTIONS               XRecolorCursor(3)

NAME
       XRecolorCursor, XFreeCursor, XQueryBestCursor - manipulate cursors

SYNTAX

       int   XRecolorCursor(Display  *display,  Cursor  cursor,  XColor  *fore-
              ground_color, XColor *background_color);

       int XFreeCursor(Display *display, Cursor cursor);

       Status  XQueryBestCursor(Display  *display,  Drawable  d,  unsigned  int
              width,  unsigned int height, unsigned int *width_return, unsigned
              int *height_return);

ARGUMENTS
       background_color
                 Specifies the RGB values for the background of the source.

       cursor    Specifies the cursor.

       d         Specifies the drawable, which indicates the screen.

       display   Specifies the connection to the X server.

       foreground_color
                 Specifies the RGB values for the foreground of the source.

       width
       height    Specify the width and height of the cursor that you  want  the
                 size information for.

       width_return
       height_return
                 Return the best width and height that is closest to the speci-
                 fied width and height.

DESCRIPTION
       The  XRecolorCursor  function changes the color of the specified cursor,
       and if the cursor is being displayed on a screen, the change is  visible
       immediately.   The  pixel  members of the XColor structures are ignored;
       only the RGB values are used.

       XRecolorCursor can generate a BadCursor error.

       The XFreeCursor function deletes the association between the cursor  re-
       source ID and the specified cursor.  The cursor storage is freed when no
       other resource references it.  The specified cursor ID should not be re-
       ferred to again.

       XFreeCursor can generate a BadCursor error.

       Some   displays   allow   larger   cursors  than  other  displays.   The
       XQueryBestCursor function provides a way to find out what  size  cursors
       are  actually possible on the display.  It returns the largest size that
       can be displayed.  Applications should be prepared to use  smaller  cur-
       sors on displays that cannot support large ones.

       XQueryBestCursor can generate a BadDrawable error.

DIAGNOSTICS
       BadCursor A value for a Cursor argument does not name a defined Cursor.

       BadDrawable
                 A value for a Drawable argument does not name a defined Window
                 or Pixmap.

SEE ALSO
       XCreateColormap(3), XCreateFontCursor(3), XDefineCursor(3)
       Xlib - C Language X Interface

X Version 11                     libX11 1.8.12                XRecolorCursor(3)

Generated by dwww version 1.16 on Sat Oct 3 06:46:43 CEST 2026.