Inheritance diagram for ezInputDeviceMouseKeyboard_Win:

[legend]

Public Member Functions
	ezInputDeviceMouseKeyboard_Win (ezMinWindows::HWND hWnd)

void	WindowMessage (ezMinWindows::UINT msg, ezMinWindows::WPARAM wparam, ezMinWindows::LPARAM lparam)
	This function needs to be called by all Windows functions, to pass the input information through to this input device.

virtual ezUInt32	GetHardwareCursorSize () const override

virtual void	SetDisableOSHotkeys (bool bDisable) override

Public Member Functions inherited from ezInputDeviceMouseKeyboard
void	SetShowMouseCursor (bool bShow)

bool	GetShowMouseCursor () const

void	SetClipMouseCursor (ezMouseCursorClipMode::Enum mode)

ezMouseCursorClipMode::Enum	GetClipMouseCursor () const

bool	GetDisableOSHotkeys () const
	Returns whether OS hotkey suppression is currently requested.

virtual void	SetMouseSpeed (const ezVec2 &vScale)
	Sets the scaling factor that is applied on all (relative) mouse input.

ezVec2	GetMouseSpeed () const
	Returns the scaling factor that is applied on all (relative) mouse input.

bool	IsMouseOver () const
	Returns the number of the ezWindow over which the mouse moved last.

bool	IsFocused ()
	Returns if the associated ezWindow has focus.

ezVec2	GetLocalMouseCoordinates () const

Public Member Functions inherited from ezInputDevice
	ezInputDevice ()
	Default Constructor.

float	GetInputSlotState (ezStringView sSlot) const
	Allows to query current input values for the given slot.

bool	HasDeviceBeenUsedLastFrame () const
	Returns true, if the device was 'used' during the last frame, ie. when it generated input due to some user interaction.

Public Member Functions inherited from ezReflectedClass
virtual const ezRTTI *	GetDynamicRTTI () const

bool	IsInstanceOf (const ezRTTI *pType) const
	Returns whether the type of this instance is of the given type or derived from it.

template<typename T >
EZ_ALWAYS_INLINE bool	IsInstanceOf () const
	Returns whether the type of this instance is of the given type or derived from it.

Static Public Member Functions
static void	LocalizeButtonDisplayNames ()
	Calling this function will 'translate' most key names from English to the OS language, by querying that information from the OS.

Static Public Member Functions inherited from ezNoBase
static const ezRTTI *	GetStaticRTTI ()

Protected Member Functions
virtual void	ApplyShowMouseCursor (bool bShow, bool bCustomCursorActive) override

virtual void	ApplyClipMouseCursor (ezMouseCursorClipMode::Enum mode) override
	Platform implementation of confining the OS cursor.

virtual void	InitializeDevice () override
	Override this if you need to do device specific initialization before the first use.

virtual void	RegisterInputSlots () override
	Override this to register all the input slots that this device exposes.

virtual void	ResetInputSlotValues () override
	Override this, if you need to reset certain input slot values to zero, after the ezInputManager is finished with the current frame update.

virtual void	UpdateInputSlotValues () override
	Override this, if you need to query the state of the hardware to update the input slots.

Protected Member Functions inherited from ezInputDeviceMouseKeyboard
void	UpdateEffectiveMouseCursorState ()

Protected Member Functions inherited from ezInputDevice
virtual void	UpdateHardwareState (ezTime tTimeDifference)
	This function is called once after ezInputManager::Update with the same time delta value. It allows to update hardware state, such as the vibration of gamepad motors.

Additional Inherited Members
Static Protected Member Functions inherited from ezInputDevice
static void	RegisterInputSlot (ezStringView sName, ezStringView sDefaultDisplayName, ezBitflags< ezInputSlotFlags > SlotFlags)
	Calls RegisterInputSlot() on the ezInputManager and passes the parameters through.

Protected Attributes inherited from ezInputDeviceMouseKeyboard
ezTime	m_DoubleClickTime = ezTime::MakeFromMilliseconds(500)

ezVec2	m_vLocalMouseCoordinates = ezVec2(0.0f)

bool	m_bDisableOSHotkeys = false

bool	m_bShowMouseCursorDesired = true

ezMouseCursorClipMode::Enum	m_ClipModeDesired = ezMouseCursorClipMode::NoClip

bool	m_bShowMouseCursorEffective = true

ezMouseCursorClipMode::Enum	m_ClipModeEffective = ezMouseCursorClipMode::NoClip

Protected Attributes inherited from ezInputDevice
bool	m_bOverridesAbsoluteInput = false
	Whether this device is authoritative for absolute-value slots (a position, not a delta) it writes, such as the mouse position - see ezInputManager::GatherDeviceInputSlotValues().

ezMap< ezString, float >	m_InputSlotValues
	Stores all the values for all input slots that this device handles.

ezStringBuilder	m_sLastCharacters
	If this input device type handles character input, append every typed character (Unicode codepoint) it receives to this, one Append() call per character event. Append rather than overwrite, so several characters typed within one frame - which happens whenever the OS delivers input faster than the game updates - are all preserved instead of all but the last being silently dropped. The ezInputManager calls RetrieveLastCharacters() to query what the user typed since the last update.

Protected Attributes inherited from ezEnumerable< ezInputDevice, ezReflectedClass >
ezEnumerable *	m_pNextInstance

Static Protected Attributes inherited from ezInputDeviceMouseKeyboard
static ezInputDevice *	s_pMouseOver = nullptr

Member Function Documentation

◆ ApplyClipMouseCursor()

virtual void ezInputDeviceMouseKeyboard_Win::ApplyClipMouseCursor ( ezMouseCursorClipMode::Enum mode )

overrideprotectedvirtual

Platform implementation of confining the OS cursor.

See also: ApplyShowMouseCursor()

Implements ezInputDeviceMouseKeyboard.

◆ ApplyShowMouseCursor()

virtual void ezInputDeviceMouseKeyboard_Win::ApplyShowMouseCursor	(	bool	bShow,
		bool	bCustomCursorActive
	)

overrideprotectedvirtual

Platform implementation of showing / hiding the OS cursor.

Called by the base class only, and only when the effective state actually changed, so implementations don't need to filter out redundant calls themselves.

Parameters

bShow	The state to apply.
bCustomCursorActive	Whether the cursor is hidden because a custom ('software') cursor is drawn instead. In that case the mouse must keep reporting absolute in-window positions, ie. the cursor may be hidden, but must not be captured.

Implements ezInputDeviceMouseKeyboard.

◆ GetHardwareCursorSize()

virtual ezUInt32 ezInputDeviceMouseKeyboard_Win::GetHardwareCursorSize ( ) const

overridevirtual

Returns the edge length of the operating system's mouse cursor, in pixels.

This takes both the display's DPI scaling and the user's mouse pointer size setting into account, so it is the value to use to render a custom cursor at the size that the user expects, independent of resolution, window size and monitor.

Returns 0 if the platform can't report it.

Querying this involves system calls. Prefer ezInputManager::GetHardwareCursorSize(), which caches the value and provides a fallback.

Reimplemented from ezInputDeviceMouseKeyboard.

◆ InitializeDevice()

virtual void ezInputDeviceMouseKeyboard_Win::InitializeDevice ( )

overrideprotectedvirtual

Override this if you need to do device specific initialization before the first use.

Implements ezInputDevice.

◆ LocalizeButtonDisplayNames()

static void ezInputDeviceMouseKeyboard_Win::LocalizeButtonDisplayNames ( )

static

Calling this function will 'translate' most key names from English to the OS language, by querying that information from the OS.

The OS translation might not always be perfect for all keys. The translation can change when the user changes the keyboard layout. So if he switches from an English layout to a German layout, LocalizeButtonDisplayNames() should be called again, to update the display names, if that is required.

◆ RegisterInputSlots()

virtual void ezInputDeviceMouseKeyboard_Win::RegisterInputSlots ( )

overrideprotectedvirtual

Override this to register all the input slots that this device exposes.

This is called once during initialization. It needs to call RegisterInputSlot() once for every input slot that this device exposes to the system.

Implements ezInputDevice.

◆ ResetInputSlotValues()

virtual void ezInputDeviceMouseKeyboard_Win::ResetInputSlotValues ( )

overrideprotectedvirtual

Override this, if you need to reset certain input slot values to zero, after the ezInputManager is finished with the current frame update.

Reimplemented from ezInputDevice.

◆ SetDisableOSHotkeys()

virtual void ezInputDeviceMouseKeyboard_Win::SetDisableOSHotkeys ( bool bDisable )

overridevirtual

If enabled, the OS will not handle system hotkeys (e.g. the Windows key) while this device is active.

Can be called before or after device initialization. On platforms that support it, calling this after initialization will re-register the input device with the updated setting.

Reimplemented from ezInputDeviceMouseKeyboard.

◆ UpdateInputSlotValues()

virtual void ezInputDeviceMouseKeyboard_Win::UpdateInputSlotValues ( )

overrideprotectedvirtual

Override this, if you need to query the state of the hardware to update the input slots.

Note: This function might be called multiple times before ResetInputSlotValues() is called. This will be the case when ezInputManager::PollHardware is used to make more frequent hardware updates than input is actually processed. Just make sure to always accumulate delta values (such as mouse move values) and don't expect ResetInputSlotValues() to be called in tandem with this function and it will be fine.

Reimplemented from ezInputDeviceMouseKeyboard.

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

/home/runner/work/ezEngine/ezEngine/Code/Engine/Core/Platform/Win/InputDevice_Platform.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Member Function Documentation

◆ ApplyClipMouseCursor()

◆ ApplyShowMouseCursor()

◆ GetHardwareCursorSize()

◆ InitializeDevice()

◆ LocalizeButtonDisplayNames()

◆ RegisterInputSlots()

◆ ResetInputSlotValues()

◆ SetDisableOSHotkeys()

◆ UpdateInputSlotValues()