logo

xcursorgen-nox

xcursorgen(1) without libX11/libXcursor dependency

Xcursor.h (13209B)

    

  1. /* include/X11/Xcursor/Xcursor.h.  Generated from Xcursor.h.in by configure.  */
  2. /*
  3.  * Copyright © 2002 Keith Packard
  4.  *
  5.  * SPDX-License-Identifier: MIT
  6.  *
  7.  * Permission to use, copy, modify, distribute, and sell this software and its
  8.  * documentation for any purpose is hereby granted without fee, provided that
  9.  * the above copyright notice appear in all copies and that both that
  10.  * copyright notice and this permission notice appear in supporting
  11.  * documentation, and that the name of Keith Packard not be used in
  12.  * advertising or publicity pertaining to distribution of the software without
  13.  * specific, written prior permission.  Keith Packard makes no
  14.  * representations about the suitability of this software for any purpose.  It
  15.  * is provided "as is" without express or implied warranty.
  16.  *
  17.  * KEITH PACKARD DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
  18.  * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
  19.  * EVENT SHALL KEITH PACKARD BE LIABLE FOR ANY SPECIAL, INDIRECT OR
  20.  * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
  21.  * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
  22.  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  23.  * PERFORMANCE OF THIS SOFTWARE.
  24.  */
  26. #ifndef _XCURSOR_H_
  27. #define _XCURSOR_H_
  28. #include <stdint.h>
  29. #include <stdio.h>
  31. typedef int XcursorBool;
  32. typedef uint32_t XcursorUInt;
  34. typedef XcursorUInt XcursorDim;
  35. typedef XcursorUInt XcursorPixel;
  37. #define XcursorTrue 1
  38. #define XcursorFalse 0
  40. /*
  41.  * Cursor files start with a header.  The header
  42.  * contains a magic number, a version number and a
  43.  * table of contents which has type and offset information
  44.  * for the remaining tables in the file.
  45.  *
  46.  * File minor versions increment for compatible changes
  47.  * File major versions increment for incompatible changes (never, we hope)
  48.  *
  49.  * Chunks of the same type are always upward compatible.  Incompatible
  50.  * changes are made with new chunk types; the old data can remain under
  51.  * the old type.  Upward compatible changes can add header data as the
  52.  * header lengths are specified in the file.
  53.  *
  54.  *  File:
  55.  *    FileHeader
  56.  *    LISTofChunk
  57.  *
  58.  *  FileHeader:
  59.  *  CARD32         magic      magic number
  60.  *  CARD32         header     bytes in file header
  61.  *  CARD32         version    file version
  62.  *  CARD32         ntoc       number of toc entries
  63.  *  LISTofFileToc  toc        table of contents
  64.  *
  65.  *  FileToc:
  66.  *  CARD32  type        entry type
  67.  *  CARD32  subtype     entry subtype (size for images)
  68.  *  CARD32  position    absolute file position
  69.  */
  71. #define XCURSOR_MAGIC 0x72756358 /* "Xcur" LSBFirst */
  73. /*
  74.  * Current Xcursor version number.  Will be substituted by configure
  75.  * from the version in the libXcursor configure.ac file.
  76.  */
  78. #define XCURSOR_LIB_MAJOR 1
  79. #define XCURSOR_LIB_MINOR 2
  80. #define XCURSOR_LIB_REVISION 1
  81. #define XCURSOR_LIB_VERSION                                                                        \
  82. 	((XCURSOR_LIB_MAJOR * 10000) + (XCURSOR_LIB_MINOR * 100) + (XCURSOR_LIB_REVISION))
  84. /*
  85.  * This version number is stored in cursor files; changes to the
  86.  * file format require updating this version number
  87.  */
  88. #define XCURSOR_FILE_MAJOR 1
  89. #define XCURSOR_FILE_MINOR 0
  90. #define XCURSOR_FILE_VERSION ((XCURSOR_FILE_MAJOR << 16) | (XCURSOR_FILE_MINOR))
  91. #define XCURSOR_FILE_HEADER_LEN (4 * 4)
  92. #define XCURSOR_FILE_TOC_LEN (3 * 4)
  94. typedef struct _XcursorFileToc
  95. {
  96. 	XcursorUInt type;     /* chunk type */
  97. 	XcursorUInt subtype;  /* subtype (size for images) */
  98. 	XcursorUInt position; /* absolute position in file */
  99. } XcursorFileToc;
  101. typedef struct _XcursorFileHeader
  102. {
  103. 	XcursorUInt magic;    /* magic number */
  104. 	XcursorUInt header;   /* byte length of header */
  105. 	XcursorUInt version;  /* file version number */
  106. 	XcursorUInt ntoc;     /* number of toc entries */
  107. 	XcursorFileToc *tocs; /* table of contents */
  108. } XcursorFileHeader;
  110. /*
  111.  * The rest of the file is a list of chunks, each tagged by type
  112.  * and version.
  113.  *
  114.  *  Chunk:
  115.  *    ChunkHeader
  116.  *    <extra type-specific header fields>
  117.  *    <type-specific data>
  118.  *
  119.  *  ChunkHeader:
  120.  *  CARD32    header   bytes in chunk header + type header
  121.  *  CARD32    type     chunk type
  122.  *  CARD32    subtype  chunk subtype
  123.  *  CARD32    version  chunk type version
  124.  */
  126. #define XCURSOR_CHUNK_HEADER_LEN (4 * 4)
  128. typedef struct _XcursorChunkHeader
  129. {
  130. 	XcursorUInt header;  /* bytes in chunk header */
  131. 	XcursorUInt type;    /* chunk type */
  132. 	XcursorUInt subtype; /* chunk subtype (size for images) */
  133. 	XcursorUInt version; /* version of this type */
  134. } XcursorChunkHeader;
  136. /*
  137.  * Here's a list of the known chunk types
  138.  */
  140. /*
  141.  * Comments consist of a 4-byte length field followed by
  142.  * UTF-8 encoded text
  143.  *
  144.  *  Comment:
  145.  *    ChunkHeader header  chunk header
  146.  *    CARD32      length  bytes in text
  147.  *    LISTofCARD8 text    UTF-8 encoded text
  148.  */
  150. #define XCURSOR_COMMENT_TYPE 0xfffe0001
  151. #define XCURSOR_COMMENT_VERSION 1
  152. #define XCURSOR_COMMENT_HEADER_LEN (XCURSOR_CHUNK_HEADER_LEN + (1 * 4))
  153. #define XCURSOR_COMMENT_COPYRIGHT 1
  154. #define XCURSOR_COMMENT_LICENSE 2
  155. #define XCURSOR_COMMENT_OTHER 3
  156. #define XCURSOR_COMMENT_MAX_LEN 0x100000
  158. typedef struct _XcursorComment
  159. {
  160. 	XcursorUInt version;
  161. 	XcursorUInt comment_type;
  162. 	char *comment;
  163. } XcursorComment;
  165. /*
  166.  * Each cursor image occupies a separate image chunk.
  167.  * The length of the image header follows the chunk header
  168.  * so that future versions can extend the header without
  169.  * breaking older applications
  170.  *
  171.  *  Image:
  172.  *    ChunkHeader   header  chunk header
  173.  *    CARD32        width   actual width
  174.  *    CARD32        height  actual height
  175.  *    CARD32        xhot    hot spot x
  176.  *    CARD32        yhot    hot spot y
  177.  *    CARD32        delay   animation delay
  178.  *    LISTofCARD32  pixels  ARGB pixels
  179.  */
  181. #define XCURSOR_IMAGE_TYPE 0xfffd0002
  182. #define XCURSOR_IMAGE_VERSION 1
  183. #define XCURSOR_IMAGE_HEADER_LEN (XCURSOR_CHUNK_HEADER_LEN + (5 * 4))
  184. #define XCURSOR_IMAGE_MAX_SIZE 0x7fff /* 32767x32767 max cursor size */
  186. typedef struct _XcursorImage
  187. {
  188. 	XcursorUInt version;  /* version of the image data */
  189. 	XcursorDim size;      /* nominal size for matching */
  190. 	XcursorDim width;     /* actual width */
  191. 	XcursorDim height;    /* actual height */
  192. 	XcursorDim xhot;      /* hot spot x (must be inside image) */
  193. 	XcursorDim yhot;      /* hot spot y (must be inside image) */
  194. 	XcursorUInt delay;    /* animation delay to next frame (ms) */
  195. 	XcursorPixel *pixels; /* pointer to pixels */
  196. } XcursorImage;
  198. /*
  199.  * Other data structures exposed by the library API
  200.  */
  201. typedef struct _XcursorImages
  202. {
  203. 	int nimage;            /* number of images */
  204. 	XcursorImage **images; /* array of XcursorImage pointers */
  205. 	char *name;            /* name used to load images */
  206. } XcursorImages;
  208. #ifdef HAVE_X11
  209. typedef struct _XcursorCursors
  210. {
  211. 	Display *dpy;    /* Display holding cursors */
  212. 	int ref;         /* reference count */
  213. 	int ncursor;     /* number of cursors */
  214. 	Cursor *cursors; /* array of cursors */
  215. } XcursorCursors;
  217. typedef struct _XcursorAnimate
  218. {
  219. 	XcursorCursors *cursors; /* list of cursors to use */
  220. 	int sequence;            /* which cursor is next */
  221. } XcursorAnimate;
  222. #endif
  224. typedef struct _XcursorFile XcursorFile;
  226. struct _XcursorFile
  227. {
  228. 	void *closure;
  229. 	int (*read)(XcursorFile *file, unsigned char *buf, int len);
  230. 	int (*write)(XcursorFile *file, unsigned char *buf, int len);
  231. 	int (*seek)(XcursorFile *file, long offset, int whence);
  232. };
  234. typedef struct _XcursorComments
  235. {
  236. 	int ncomment;              /* number of comments */
  237. 	XcursorComment **comments; /* array of XcursorComment pointers */
  238. } XcursorComments;
  240. #define XCURSOR_CORE_THEME "core"
  242. /*
  243.  * Manage Image objects
  244.  */
  245. XcursorImage *XcursorImageCreate(int width, int height);
  247. void XcursorImageDestroy(XcursorImage *image);
  249. /*
  250.  * Manage Images objects
  251.  */
  252. extern XcursorImages *XcursorImagesCreate(int size);
  254. void XcursorImagesDestroy(XcursorImages *images);
  256. void XcursorImagesSetName(XcursorImages *images, const char *name);
  258. #ifdef HAVE_X11
  259. /*
  260.  * Manage Cursor objects
  261.  */
  262. XcursorCursors *XcursorCursorsCreate(Display *dpy, int size);
  264. //void
  265. XcursorCursorsDestroy(XcursorCursors *cursors);
  267. /*
  268.  * Manage Animate objects
  269.  */
  270. XcursorAnimate *XcursorAnimateCreate(XcursorCursors *cursors);
  272. void XcursorAnimateDestroy(XcursorAnimate *animate);
  274. Cursor XcursorAnimateNext(XcursorAnimate *animate);
  275. #endif
  277. /*
  278.  * Manage Comment objects
  279.  */
  280. XcursorComment *XcursorCommentCreate(XcursorUInt comment_type, int length);
  282. void XcursorCommentDestroy(XcursorComment *comment);
  284. XcursorComments *XcursorCommentsCreate(int size);
  286. void XcursorCommentsDestroy(XcursorComments *comments);
  288. /*
  289.  * XcursorFile/Image APIs
  290.  */
  291. XcursorImage *XcursorXcFileLoadImage(XcursorFile *file, int size);
  293. XcursorImages *XcursorXcFileLoadImages(XcursorFile *file, int size);
  295. XcursorImages *XcursorXcFileLoadAllImages(XcursorFile *file);
  297. XcursorBool
  298. XcursorXcFileLoad(XcursorFile *file, XcursorComments **commentsp, XcursorImages **imagesp);
  300. XcursorBool
  301. XcursorXcFileSave(XcursorFile *file, const XcursorComments *comments, const XcursorImages *images);
  303. /*
  304.  * FILE/Image APIs
  305.  */
  306. XcursorImage *XcursorFileLoadImage(FILE *file, int size);
  308. XcursorImages *XcursorFileLoadImages(FILE *file, int size);
  310. XcursorImages *XcursorFileLoadAllImages(FILE *file);
  312. XcursorBool XcursorFileLoad(FILE *file, XcursorComments **commentsp, XcursorImages **imagesp);
  314. XcursorBool XcursorFileSaveImages(FILE *file, const XcursorImages *images);
  316. XcursorBool
  317. XcursorFileSave(FILE *file, const XcursorComments *comments, const XcursorImages *images);
  319. /*
  320.  * Filename/Image APIs
  321.  */
  322. XcursorImage *XcursorFilenameLoadImage(const char *filename, int size);
  324. XcursorImages *XcursorFilenameLoadImages(const char *filename, int size);
  326. XcursorImages *XcursorFilenameLoadAllImages(const char *filename);
  328. XcursorBool
  329. XcursorFilenameLoad(const char *file, XcursorComments **commentsp, XcursorImages **imagesp);
  331. XcursorBool XcursorFilenameSaveImages(const char *filename, const XcursorImages *images);
  333. XcursorBool
  334. XcursorFilenameSave(const char *file, const XcursorComments *comments, const XcursorImages *images);
  336. /*
  337.  * Library/Image APIs
  338.  */
  339. XcursorImage *XcursorLibraryLoadImage(const char *library, const char *theme, int size);
  341. XcursorImages *XcursorLibraryLoadImages(const char *library, const char *theme, int size);
  343. /*
  344.  * Library/shape API
  345.  */
  347. const char *XcursorLibraryPath(void);
  349. int XcursorLibraryShape(const char *library);
  351. #ifdef HAVE_X11
  352. /*
  353.  * Image/Cursor APIs
  354.  */
  356. Cursor XcursorImageLoadCursor(Display *dpy, const XcursorImage *image);
  358. XcursorCursors *XcursorImagesLoadCursors(Display *dpy, const XcursorImages *images);
  360. Cursor XcursorImagesLoadCursor(Display *dpy, const XcursorImages *images);
  362. /*
  363.  * Filename/Cursor APIs
  364.  */
  365. Cursor XcursorFilenameLoadCursor(Display *dpy, const char *file);
  367. XcursorCursors *XcursorFilenameLoadCursors(Display *dpy, const char *file);
  369. /*
  370.  * Library/Cursor APIs
  371.  */
  372. Cursor XcursorLibraryLoadCursor(Display *dpy, const char *file);
  374. XcursorCursors *XcursorLibraryLoadCursors(Display *dpy, const char *file);
  375. #endif
  377. /*
  378.  * Shape/Image APIs
  379.  */
  381. XcursorImage *XcursorShapeLoadImage(unsigned int shape, const char *theme, int size);
  383. XcursorImages *XcursorShapeLoadImages(unsigned int shape, const char *theme, int size);
  385. #ifdef HAVE_X11
  386. /*
  387.  * Shape/Cursor APIs
  388.  */
  389. Cursor XcursorShapeLoadCursor(Display *dpy, unsigned int shape);
  391. XcursorCursors *XcursorShapeLoadCursors(Display *dpy, unsigned int shape);
  393. /*
  394.  * This is the function called by Xlib when attempting to
  395.  * load cursors from XCreateGlyphCursor.  The interface must
  396.  * not change as Xlib loads 'libXcursor.so' instead of
  397.  * a specific major version
  398.  */
  399. Cursor XcursorTryShapeCursor(Display *dpy,
  400.                              Font source_font,
  401.                              Font mask_font,
  402.                              unsigned int source_char,
  403.                              unsigned int mask_char,
  404.                              XColor _Xconst *foreground,
  405.                              XColor _Xconst *background);
  407. void XcursorNoticeCreateBitmap(Display *dpy, Pixmap pid, unsigned int width, unsigned int height);
  409. void XcursorNoticePutBitmap(Display *dpy, Drawable draw, XImage *image);
  411. Cursor XcursorTryShapeBitmapCursor(Display *dpy,
  412.                                    Pixmap source,
  413.                                    Pixmap mask,
  414.                                    XColor *foreground,
  415.                                    XColor *background,
  416.                                    unsigned int x,
  417.                                    unsigned int y);
  418. #endif
  420. #define XCURSOR_BITMAP_HASH_SIZE 16
  422. #ifdef HAVE_X11
  423. void XcursorImageHash(XImage *image, unsigned char hash[XCURSOR_BITMAP_HASH_SIZE]);
  424. #endif
  426. #ifdef HAVE_X11
  427. /*
  428.  * Display information APIs
  429.  */
  430. XcursorBool XcursorSupportsARGB(Display *dpy);
  432. XcursorBool XcursorSupportsAnim(Display *dpy);
  434. XcursorBool XcursorSetDefaultSize(Display *dpy, int size);
  436. int XcursorGetDefaultSize(Display *dpy);
  438. XcursorBool XcursorSetTheme(Display *dpy, const char *theme);
  440. char *XcursorGetTheme(Display *dpy);
  442. XcursorBool XcursorGetThemeCore(Display *dpy);
  444. XcursorBool XcursorSetThemeCore(Display *dpy, XcursorBool theme_core);
  445. #endif // HAVE_X11
  447. #endif // _XCURSOR_H_