donut::events::Event Struct Reference

Data structure containing information about an event. More...

#include <donut/events/Event.hpp>

Inheritance diagram for donut::events::Event:

Additional Inherited Members
Public Types inherited from donut::Variant< ApplicationQuitRequestedEvent, ApplicationTerminatingEvent, ApplicationLowMemoryEvent, ApplicationPausingEvent, ApplicationPausedEvent, ApplicationUnpausingEvent, ApplicationUnpausedEvent, WindowShownEvent, WindowHiddenEvent, WindowExposedEvent, WindowMovedEvent, WindowResizedEvent, WindowSizeChangedEvent, WindowMinimizedEvent, WindowMaximizedEvent, WindowRestoredEvent, WindowMouseFocusGainedEvent, WindowMouseFocusLostEvent, WindowKeyboardFocusGainedEvent, WindowKeyboardFocusLostEvent, WindowCloseRequestedEvent, WindowDisplayChangedEvent, KeyPressedEvent, KeyPressRepeatedEvent, KeyReleasedEvent, TextInputEditedEvent, TextInputSubmittedEvent, MouseMovedEvent, MouseButtonPressedEvent, MouseButtonReleasedEvent, MouseWheelScrolledEvent, ControllerAddedEvent, ControllerRemovedEvent, ControllerRemappedEvent, ControllerAxisMovedEvent, ControllerButtonPressedEvent, ControllerButtonReleasedEvent, TouchMovedEvent, TouchPressedEvent, TouchReleasedEvent, KeymapChangedEvent, ClipboardUpdatedEvent, DropFileEvent, DropTextEvent, DropStartedEvent, DropCompletedEvent >
using	index_type = std::conditional_t< sizeof...(Ts)< 255ull, std::uint8_t, std::conditional_t< sizeof...(Ts)< 65535ull, std::uint16_t, std::conditional_t< sizeof...(Ts)< 4294967295ull, std::uint32_t, std::uint64_t > > >
	Index type used to encode the active alternative type.
Public Member Functions inherited from donut::Variant< ApplicationQuitRequestedEvent, ApplicationTerminatingEvent, ApplicationLowMemoryEvent, ApplicationPausingEvent, ApplicationPausedEvent, ApplicationUnpausingEvent, ApplicationUnpausedEvent, WindowShownEvent, WindowHiddenEvent, WindowExposedEvent, WindowMovedEvent, WindowResizedEvent, WindowSizeChangedEvent, WindowMinimizedEvent, WindowMaximizedEvent, WindowRestoredEvent, WindowMouseFocusGainedEvent, WindowMouseFocusLostEvent, WindowKeyboardFocusGainedEvent, WindowKeyboardFocusLostEvent, WindowCloseRequestedEvent, WindowDisplayChangedEvent, KeyPressedEvent, KeyPressRepeatedEvent, KeyReleasedEvent, TextInputEditedEvent, TextInputSubmittedEvent, MouseMovedEvent, MouseButtonPressedEvent, MouseButtonReleasedEvent, MouseWheelScrolledEvent, ControllerAddedEvent, ControllerRemovedEvent, ControllerRemappedEvent, ControllerAxisMovedEvent, ControllerButtonPressedEvent, ControllerButtonReleasedEvent, TouchMovedEvent, TouchPressedEvent, TouchReleasedEvent, KeymapChangedEvent, ClipboardUpdatedEvent, DropFileEvent, DropTextEvent, DropStartedEvent, DropCompletedEvent >
constexpr	Variant () noexcept(std::is_nothrow_default_constructible_v< variant_alternative_t< 0, Variant > >)
	Default-construct a variant with the first variant alternative, if it is default-constructible.
constexpr	Variant (U &&value) noexcept(std::is_nothrow_constructible_v< decltype(F(std::forward< U >(value)))>)
	Converting constructor.
constexpr	Variant (std::in_place_type_t< T > type, Args &&... args)
	Construct a variant alternative in-place given its type.
constexpr	Variant (std::in_place_type_t< T > type, std::initializer_list< U > ilist, Args &&... args)
	Construct a variant alternative in-place given its type, with an initializer list as the first constructor argument.
constexpr	Variant (std::in_place_index_t< Index > index, Args &&... args)
	Construct a variant alternative in-place given its index.
constexpr	Variant (std::in_place_index_t< Index > index, std::initializer_list< U > ilist, Args &&... args)
	Construct a variant alternative in-place given its index, with an initializer list as the first constructor argument.
constexpr	Variant (const Variant &other)=delete
	Deleted copy constructor.
constexpr	Variant (const Variant &other)=default
	Trivial copy constructor.
constexpr	Variant (const Variant &other)
	Copy constructor.
constexpr	Variant (Variant &&other) noexcept=default
	Trivial move constructor.
constexpr	Variant (Variant &&other) noexcept((std::is_nothrow_move_constructible_v< Ts > &&...))
	Move constructor.
constexpr	~Variant ()
	Destructor.
constexpr	~Variant ()=default
	Trivial destructor.
constexpr Variant &	operator= (const Variant &other)=delete
	Deleted copy assignment.
constexpr Variant &	operator= (const Variant &other)=default
	Trivial copy assignment.
constexpr Variant &	operator= (const Variant &other)
	Copy assignment.
constexpr Variant &	operator= (Variant &&other) noexcept=default
	Trivial move assignment.
constexpr Variant &	operator= (Variant &&other) noexcept(((std::is_nothrow_move_constructible_v< Ts > &&//NOLINT(performance-noexcept-move-constructor, cppcoreguidelines-noexcept-move-operations) std::is_nothrow_move_assignable_v< Ts >) &&...))
	Move assignment.
constexpr Variant &	operator= (U &&value) noexcept(std::is_nothrow_assignable_v< decltype(F(std::forward< U >(value)))&, U > &&std::is_nothrow_constructible_v< decltype(F(std::forward< U >(value))), U >)
	Converting assignment.
constexpr T &	emplace (Args &&... args)
	Construct an alternative given its type, destroying the old value.
constexpr T &	emplace (std::initializer_list< U > ilist, Args &&... args)
	Construct an alternative given its type, with an initializer list as the first constructor argument, destroying the old value.
constexpr variant_alternative_t< Index, Variant > &	emplace (Args &&... args)
	Construct an alternative given its index, destroying the old value.
constexpr variant_alternative_t< Index, Variant > &	emplace (std::initializer_list< U > ilist, Args &&... args)
	Construct an alternative given its index, with an initializer list as the first constructor argument, destroying the old value.
constexpr void	swap (Variant &other) noexcept(((std::is_nothrow_move_constructible_v< Ts > &&std::is_nothrow_swappable_v< Ts >) &&...))
	Swap this variant's value with that of another.
constexpr index_type	index () const noexcept
	Get the alternative index of the currently active value held by the variant.
constexpr bool	valueless_by_exception () const noexcept
	Check if the variant is in the valueless by exception state.
constexpr bool	is () const noexcept
	Check if the variant currently holds the alternative with the given type.
constexpr bool	is () const noexcept
	Check if the variant currently holds the alternative with the given index.
constexpr T &	as () &noexcept
	Access the underlying value with the given type without a safety check.
constexpr const T &	as () const &noexcept
	Access the underlying value with the given type without a safety check.
constexpr T &&	as () &&noexcept
	Access the underlying value with the given type without a safety check.
constexpr const T &&	as () const &&noexcept
	Access the underlying value with the given type without a safety check.
constexpr variant_alternative_t< Index, Variant > &	as () &noexcept
	Access the underlying value with the given index without a safety check.
constexpr const variant_alternative_t< Index, Variant > &	as () const &noexcept
	Access the underlying value with the given index without a safety check.
constexpr variant_alternative_t< Index, Variant > &&	as () &&noexcept
	Access the underlying value with the given index without a safety check.
constexpr const variant_alternative_t< Index, Variant > &&	as () const &&noexcept
	Access the underlying value with the given index without a safety check.
constexpr T &	get () &
	Access the underlying value with the given type.
constexpr const T &	get () const &
	Access the underlying value with the given type.
constexpr T &&	get () &&
	Access the underlying value with the given type.
constexpr const T &&	get () const &&
	Access the underlying value with the given type.
constexpr variant_alternative_t< Index, Variant > &	get () &
	Access the underlying value with the given index.
constexpr const variant_alternative_t< Index, Variant > &	get () const &
	Access the underlying value with the given index.
constexpr variant_alternative_t< Index, Variant > &&	get () &&
	Access the underlying value with the given index.
constexpr const variant_alternative_t< Index, Variant > &&	get () const &&
	Access the underlying value with the given index.
constexpr T *	get_if () noexcept
	Access the underlying value with the given type if it is the currently active alternative.
constexpr const T *	get_if () const noexcept
	Access the underlying value with the given type if it is the currently active alternative.
constexpr variant_alternative_t< Index, Variant > *	get_if () noexcept
	Access the underlying value with the given index if it is the currently active alternative.
constexpr const variant_alternative_t< Index, Variant > *	get_if () const noexcept
	Access the underlying value with the given index if it is the currently active alternative.
Static Public Member Functions inherited from donut::Variant< ApplicationQuitRequestedEvent, ApplicationTerminatingEvent, ApplicationLowMemoryEvent, ApplicationPausingEvent, ApplicationPausedEvent, ApplicationUnpausingEvent, ApplicationUnpausedEvent, WindowShownEvent, WindowHiddenEvent, WindowExposedEvent, WindowMovedEvent, WindowResizedEvent, WindowSizeChangedEvent, WindowMinimizedEvent, WindowMaximizedEvent, WindowRestoredEvent, WindowMouseFocusGainedEvent, WindowMouseFocusLostEvent, WindowKeyboardFocusGainedEvent, WindowKeyboardFocusLostEvent, WindowCloseRequestedEvent, WindowDisplayChangedEvent, KeyPressedEvent, KeyPressRepeatedEvent, KeyReleasedEvent, TextInputEditedEvent, TextInputSubmittedEvent, MouseMovedEvent, MouseButtonPressedEvent, MouseButtonReleasedEvent, MouseWheelScrolledEvent, ControllerAddedEvent, ControllerRemovedEvent, ControllerRemappedEvent, ControllerAxisMovedEvent, ControllerButtonPressedEvent, ControllerButtonReleasedEvent, TouchMovedEvent, TouchPressedEvent, TouchReleasedEvent, KeymapChangedEvent, ClipboardUpdatedEvent, DropFileEvent, DropTextEvent, DropStartedEvent, DropCompletedEvent >
static constexpr decltype(auto)	visit (Visitor &&visitor, V &&variant)
	Call a visitor functor with the currently active underlying value of a variant.
Static Public Attributes inherited from donut::Variant< ApplicationQuitRequestedEvent, ApplicationTerminatingEvent, ApplicationLowMemoryEvent, ApplicationPausingEvent, ApplicationPausedEvent, ApplicationUnpausingEvent, ApplicationUnpausedEvent, WindowShownEvent, WindowHiddenEvent, WindowExposedEvent, WindowMovedEvent, WindowResizedEvent, WindowSizeChangedEvent, WindowMinimizedEvent, WindowMaximizedEvent, WindowRestoredEvent, WindowMouseFocusGainedEvent, WindowMouseFocusLostEvent, WindowKeyboardFocusGainedEvent, WindowKeyboardFocusLostEvent, WindowCloseRequestedEvent, WindowDisplayChangedEvent, KeyPressedEvent, KeyPressRepeatedEvent, KeyReleasedEvent, TextInputEditedEvent, TextInputSubmittedEvent, MouseMovedEvent, MouseButtonPressedEvent, MouseButtonReleasedEvent, MouseWheelScrolledEvent, ControllerAddedEvent, ControllerRemovedEvent, ControllerRemappedEvent, ControllerAxisMovedEvent, ControllerButtonPressedEvent, ControllerButtonReleasedEvent, TouchMovedEvent, TouchPressedEvent, TouchReleasedEvent, KeymapChangedEvent, ClipboardUpdatedEvent, DropFileEvent, DropTextEvent, DropStartedEvent, DropCompletedEvent >
static constexpr index_type	npos
	Invalid alternative index, representing the valueless by exception state.

Detailed Description

Data structure containing information about an event.

Instances of this type are generated by an EventPump when certain events occur in the host environment, typically as a result of user input. These events can either be handled manually or be forwarded to subsystems such as an InputManager for processing.

Examples

example_game.cpp, and example_rectangle.cpp.

---

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

• include/donut/events/Event.hpp