Cursor Class Reference

A class for storing custom cursors. More...

#include <Cursor.hpp>

Public Member Functions
MYGL_EXPORT	Cursor () noexcept
	Creates a default arrow cursor.
MYGL_EXPORT	Cursor (const Image &image, int xhot, int yhot)
	Creates a cursor from an image file.
MYGL_EXPORT bool	load (const Image &image, int xhot, int yhot)
	Loads a cursor fron an image file.
MYGL_EXPORT bool	isUsable () const noexcept
	Tells wether the cursor is usable.

Static Public Attributes
static const Cursor	arrow
	The standard arrow cursor, this is the default.
static const Cursor	IBeam
	The I-beam shaped cursor (or text cursor)
static const Cursor	crosshair
	The crosshair cursor (cross shape)
static const Cursor	hand
	The pointing hand cursor.
static const Cursor	horizontalResize
	The horizontal resize arrow cursor.
static const Cursor	verticalResize
	The vertical resize arrow cursor.

Friends
class	Window

Detailed Description

A class for storing custom cursors.

Definition at line 18 of file Cursor.hpp.

Constructor & Destructor Documentation

Cursor()

MYGL_EXPORT Cursor	(	const Image &	image,
		int	xhot,
		int	yhot )

Creates a cursor from an image file.

The image used to create the cursor must be in a RGBA pixel format (4 channels). The hotspot is the point defining the cursor's position, its coordinates are relative to the image's lower left corner.

Parameters

image	The image to use
xhot	The x coordinate of the cursor's hotspot
yhot	The y coordinate of the cursor's hotspot

Member Function Documentation

isUsable()

MYGL_EXPORT bool isUsable ( ) const

noexcept

Tells wether the cursor is usable.

Returns

true if the cursor can be used

load()

MYGL_EXPORT bool load	(	const Image &	image,
		int	xhot,
		int	yhot )

Loads a cursor fron an image file.

Parameters

image	The image to use
xhot	The x coordinate of the cursor's hotpoint
yhot	The y coordinate of the cursor's hotpoint

Returns

true if the cursor was successfully created

Friends And Related Symbol Documentation

Window

friend class Window

friend

Definition at line 91 of file Cursor.hpp.

Member Data Documentation

arrow

const Cursor arrow

static

The standard arrow cursor, this is the default.

Definition at line 33 of file Cursor.hpp.

crosshair

const Cursor crosshair

static

The crosshair cursor (cross shape)

Definition at line 41 of file Cursor.hpp.

hand

const Cursor hand

static

The pointing hand cursor.

Definition at line 45 of file Cursor.hpp.

horizontalResize

const Cursor horizontalResize

static

The horizontal resize arrow cursor.

Definition at line 49 of file Cursor.hpp.

IBeam

const Cursor IBeam

static

The I-beam shaped cursor (or text cursor)

Definition at line 37 of file Cursor.hpp.

verticalResize

const Cursor verticalResize

static

The vertical resize arrow cursor.

Definition at line 53 of file Cursor.hpp.

---

The documentation for this class was generated from the following file:

• Cursor.hpp