/*
 * mouse.h -- mouse definitions
 *
 * Copyright (c) 2020-2023 David Demelier <markand@malikania.fr>
 *
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

#ifndef MLK_CORE_MOUSE_H
#define MLK_CORE_MOUSE_H

/**
 * \file mlk/core/mouse.h
 * \brief Mouse definitions
 */

/**
 * \enum mlk_mouse_button
 * \brief Mouse button
 *
 * This enumeration is implemented as a bitmask.
 */
enum mlk_mouse_button {
	/**
	 * No button pressed.
	 */
	MLK_MOUSE_BUTTON_NONE   = 0,

	/**
	 * Left button.
	 */
	MLK_MOUSE_BUTTON_LEFT   = (1 << 0),

	/**
	 * Middle click button.
	 */
	MLK_MOUSE_BUTTON_MIDDLE = (1 << 1),

	/**
	 * Right button.
	 */
	MLK_MOUSE_BUTTON_RIGHT  = (1 << 2)
};

#endif /* !MLK_CORE_MOUSE_H */