wlroots/include/xcursor/xcursor.h

/*
 * Copyright © 2002 Keith Packard
 *
 * 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 (including the
 * next paragraph) 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 AUTHORS OR COPYRIGHT HOLDERS
 * 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.
 */

#ifndef XCURSOR_H
#define XCURSOR_H

#include <stdint.h>

struct xcursor_image {
	uint32_t version; /* version of the image data */
	uint32_t size; /* nominal size for matching */
	uint32_t width; /* actual width */
	uint32_t height; /* actual height */
	uint32_t xhot; /* hot spot x (must be inside image) */
	uint32_t yhot; /* hot spot y (must be inside image) */
	uint32_t delay; /* animation delay to next frame (ms) */
	uint32_t *pixels; /* pointer to pixels */
};

/*
 * Other data structures exposed by the library API
 */
struct xcursor_images {
	int nimage; /* number of images */
	struct xcursor_image **images; /* array of XcursorImage pointers */
	char *name; /* name used to load images */
};

void
xcursor_images_destroy(struct xcursor_images *images);

void
xcursor_load_theme(const char *theme, int size,
		   void (*load_callback)(struct xcursor_images *, void *),
		   void *user_data);
#endif