Opaque handle for a registered input provider. More...

#include <InputManager.h>

Collaboration diagram for Input::InputManager::ProviderHandle:

Public Member Functions
	operator bool () const
	Checks whether this handle refers to a registered provider id.

Public Attributes
uint64_t	id = 0
	Unique provider identifier. Zero means invalid.
ActionValueType	type = ActionValueType::Bool
	Value type of the registered provider.
std::string	name
	Action name passed to the bind function.

Detailed Description

Opaque handle for a registered input provider.

Store this handle to remove the provider with InputManager::removeProvider(). The handle records the action type and name so provider removal cannot affect a different action type. A default-constructed handle is invalid.

Definition at line 120 of file InputManager.h.

Member Function Documentation

◆ operator bool()

Input::InputManager::ProviderHandle::operator bool ( ) const

inlineexplicitnodiscard

Checks whether this handle refers to a registered provider id.

Returns: True when the handle id is non-zero.

Definition at line 131 of file InputManager.h.

Member Data Documentation

◆ id

uint64_t Input::InputManager::ProviderHandle::id = 0

Unique provider identifier. Zero means invalid.

Definition at line 122 of file InputManager.h.

◆ name

std::string Input::InputManager::ProviderHandle::name

Action name passed to the bind function.

Definition at line 125 of file InputManager.h.

◆ type

ActionValueType Input::InputManager::ProviderHandle::type = ActionValueType::Bool

Value type of the registered provider.

Definition at line 124 of file InputManager.h.

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

/workspace/magerbeton/gl3-vulkan/code/Engine/include/Engine/Input/InputManager.h

Public Member Functions