Kanzi Framework  3.9.0
Kanzi Engine API
kanzi::HudDebugEvent Class Reference

The event toggles the head-up display debugging status. More...

#include <kanzi/core.ui/platform/input/common/events.hpp>

Inheritance diagram for kanzi::HudDebugEvent:
[legend]

Public Member Functions

 HudDebugEvent (bool enabled)
 Constructs a head-up display debug event. More...
 
bool isHudEnabled () const
 Returns the head-up display debug status. More...
 
- Public Member Functions inherited from kanzi::InputEvent
Type getType () const
 Returns the type of the event. More...
 
 InputEvent (Type type)
 Constructs an event with a given type. More...
 
bool isHandled () const
 Returns true if the event is handled, false if not. More...
 
void markHandled ()
 Marks the event as handled. More...
 
virtual ~InputEvent ()
 Destructor. More...
 

Protected Attributes

bool m_enabled
 Holds the head-up display debug status value of the event. More...
 

Additional Inherited Members

- Public Types inherited from kanzi::InputEvent
enum  Type {
  Key, Pointer, Touch, WindowResized,
  WindowResizeRequest, WindowFocusLost, WindowFocusGained, WindowHidden,
  WindowResourcesLost, WindowOrientationChanged, WindowRedrawRequest, WindowClosed,
  ApplicationPaused, ApplicationSleep, ApplicationWakeup, DebugToggleHud,
  DebugSetHud, UserEvent
}
 InputEvent type enumeration. More...
 

Detailed Description

The event toggles the head-up display debugging status.

The type of the event is InputEvent::DebugSetHud.

Constructor & Destructor Documentation

◆ HudDebugEvent()

kanzi::HudDebugEvent::HudDebugEvent ( bool  enabled)
explicit

Constructs a head-up display debug event.

Parameters
enabledThe status of the head-up display debug event.

Member Function Documentation

◆ isHudEnabled()

bool kanzi::HudDebugEvent::isHudEnabled ( ) const
inline

Returns the head-up display debug status.

Member Data Documentation

◆ m_enabled

bool kanzi::HudDebugEvent::m_enabled
protected

Holds the head-up display debug status value of the event.


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