SDL::Cursor Struct Reference

The structure used to identify an SDL cursor. More...

Inheritance diagram for SDL::Cursor:

Public Member Functions
constexpr	Cursor (CursorRaw resource) noexcept
	Constructs from raw Cursor.
constexpr	Cursor (Cursor &&other) noexcept
	Move constructor.
	Cursor (const Uint8 *data, const Uint8 *mask, const PointRaw &size, const PointRaw &hot)
	Create a cursor using the specified bitmap data and mask (in MSB format).
	Cursor (SurfaceRef surface, const PointRaw &hot)
	Create a color cursor.
	Cursor (SystemCursor id)
	Create a system cursor.
	~Cursor ()
	Destructor.
constexpr Cursor &	operator= (Cursor &&other) noexcept
	Assignment operator.
Public Member Functions inherited from SDL::CursorBase
void	Destroy ()
	Free a previously-created cursor.
void	Set ()
	Set the active cursor.
constexpr	ResourceBaseT ()=default
	Default constructor, creates null/invalid resource.
constexpr	ResourceBaseT (RawPointer resource)
	Constructs from resource pointer.
constexpr	ResourceBaseT (std::nullptr_t)
	Constructs null/invalid.
constexpr	ResourceBaseT (const ResourceBaseT &)=default
	Copy constructor.
constexpr	ResourceBaseT (ResourceBaseT &&) noexcept=default
	Move constructor.
Public Member Functions inherited from SDL::ResourceBaseT< CursorRaw >
constexpr	ResourceBaseT ()=default
	Default constructor, creates null/invalid resource.
constexpr	operator bool () const
	Converts to bool.
constexpr auto	operator<=> (const ResourceBaseT &other) const=default
	Comparison.
constexpr RawConstPointer	operator-> () const noexcept
	member access to underlying resource pointer.
constexpr RawPointer	get () const noexcept
	Retrieves underlying resource pointer.
constexpr RawPointer	release () noexcept
	Retrieves underlying resource pointer and clear this.

Additional Inherited Members
Public Types inherited from SDL::ResourceBaseT< CursorRaw >
using	RawPointer
	The underlying raw pointer type.
using	RawConstPointer
	The underlying const raw pointer type.
Protected Member Functions inherited from SDL::ResourceBaseT< CursorRaw >
constexpr	~ResourceBaseT ()=default
	Destructor.
constexpr ResourceBaseT &	operator= (const ResourceBaseT &)=default
	Assignment operator.

Detailed Description

The structure used to identify an SDL cursor.

This is opaque data.

Since

This struct is available since SDL 3.2.0.

Category:

Resource

Constructor & Destructor Documentation

Cursor()

SDL::Cursor::Cursor ( CursorRaw resource )

inlineexplicitconstexprnoexcept

Constructs from raw Cursor.

Parameters

resource

a CursorRaw to be wrapped.

This assumes the ownership, call release() if you need to take back.

---

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

• SDL3pp/SDL3pp_mouse.h