Home | History | Annotate | Download | only in cursor
      1 /*
      2  * Copyright  2002 Keith Packard
      3  *
      4  * Permission is hereby granted, free of charge, to any person obtaining
      5  * a copy of this software and associated documentation files (the
      6  * "Software"), to deal in the Software without restriction, including
      7  * without limitation the rights to use, copy, modify, merge, publish,
      8  * distribute, sublicense, and/or sell copies of the Software, and to
      9  * permit persons to whom the Software is furnished to do so, subject to
     10  * the following conditions:
     11  *
     12  * The above copyright notice and this permission notice (including the
     13  * next paragraph) shall be included in all copies or substantial
     14  * portions of the Software.
     15  *
     16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
     17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
     18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
     19  * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
     20  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
     21  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
     22  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
     23  * SOFTWARE.
     24  */
     25 
     26 #ifndef XCURSOR_H
     27 #define XCURSOR_H
     28 
     29 typedef int		XcursorBool;
     30 typedef unsigned int	XcursorUInt;
     31 
     32 typedef XcursorUInt	XcursorDim;
     33 typedef XcursorUInt	XcursorPixel;
     34 
     35 typedef struct _XcursorImage {
     36     XcursorUInt	    version;	/* version of the image data */
     37     XcursorDim	    size;	/* nominal size for matching */
     38     XcursorDim	    width;	/* actual width */
     39     XcursorDim	    height;	/* actual height */
     40     XcursorDim	    xhot;	/* hot spot x (must be inside image) */
     41     XcursorDim	    yhot;	/* hot spot y (must be inside image) */
     42     XcursorUInt	    delay;	/* animation delay to next frame (ms) */
     43     XcursorPixel    *pixels;	/* pointer to pixels */
     44 } XcursorImage;
     45 
     46 /*
     47  * Other data structures exposed by the library API
     48  */
     49 typedef struct _XcursorImages {
     50     int		    nimage;	/* number of images */
     51     XcursorImage    **images;	/* array of XcursorImage pointers */
     52     char	    *name;	/* name used to load images */
     53 } XcursorImages;
     54 
     55 XcursorImages *
     56 XcursorLibraryLoadImages (const char *file, const char *theme, int size);
     57 
     58 void
     59 XcursorImagesDestroy (XcursorImages *images);
     60 
     61 void
     62 xcursor_load_theme(const char *theme, int size,
     63 		    void (*load_callback)(XcursorImages *, void *),
     64 		    void *user_data);
     65 #endif
     66