KarmaEngine
Game Engine for practical learning and research purposes
Loading...
Searching...
No Matches
Karma::MouseButtonReleasedEvent Class Reference

Event triggered when the mouse button is released. More...

#include <MouseEvent.h>

Inheritance diagram for Karma::MouseButtonReleasedEvent:
Karma::MouseButtonEvent Karma::Event

Public Member Functions

 MouseButtonReleasedEvent (int button)
 A constructor.
std::string ToString () const override
 String representation of the event.
Public Member Functions inherited from Karma::MouseButtonEvent
int GetMouseButton () const
 Getter for mouse button.
Public Member Functions inherited from Karma::Event
virtual EventType GetEventType () const =0
 Getter for event name (type).
virtual const char * GetName () const =0
 Getter for event type.
virtual int GetCategoryFlags () const =0
 Getter for category flags (enum EventCategory).
bool IsInCategory (EventCategory category)
 Routine to see if the category of the Event is (or a part of) given category.
bool IsHandled () const
 Getter for the m_Handled.
EventGetObjPointer ()
 Getter for the pointer to the object.

Additional Inherited Members

Protected Member Functions inherited from Karma::MouseButtonEvent
 MouseButtonEvent (int button)
Protected Attributes inherited from Karma::MouseButtonEvent
int m_Button
Protected Attributes inherited from Karma::Event
bool m_Handled = false

Detailed Description

Event triggered when the mouse button is released.

Constructor & Destructor Documentation

◆ MouseButtonReleasedEvent()

Karma::MouseButtonReleasedEvent::MouseButtonReleasedEvent ( int button)
inline

A constructor.

Parameters
buttonGLFW defined mouse button, signifying the button released
See also
https://www.glfw.org/docs/3.3/group__buttons.html
Since
Karma 1.0.0

Member Function Documentation

◆ ToString()

std::string Karma::MouseButtonReleasedEvent::ToString ( ) const
inlineoverridevirtual

String representation of the event.

Since
Karma 1.0.0

Reimplemented from Karma::Event.


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