Declarations for libvirtualhid-backed input helpers. More...

#include <memory>
#include <optional>
#include <set>
#include <string>
#include <string_view>
#include <vector>
#include <libvirtualhid/libvirtualhid.hpp>
#include "src/platform/common.h"

Include dependency graph for virtualhid_input.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	platf::virtualhid::client_context_t
	Per-client virtual touch and pen state. More...
struct	platf::virtualhid::input_context_t
	Runtime and virtual devices owned by one platform input context. More...

Functions
void	platf::virtualhid::abs_mouse (input_context_t &context, const touch_port_t &touch_port, float x, float y)
	Move the virtual mouse absolutely inside a target touch port.
int	platf::virtualhid::alloc_gamepad (input_context_t &context, const gamepad_id_t &id, const gamepad_arrival_t &metadata, feedback_queue_t feedback_queue)
	Allocate a libvirtualhid gamepad.
void	platf::virtualhid::button_mouse (input_context_t &context, int button, bool release)
	Submit a mouse button event.
bool	platf::virtualhid::configured_gamepad_supports_controller_extensions ()
	Return whether the configured gamepad profile needs Moonlight controller extensions.
bool	platf::virtualhid::configured_gamepad_supports_touchpad ()
	Return whether the configured gamepad profile can expose touchpad input.
std::unique_ptr< lvh::Runtime >	platf::virtualhid::create_runtime (lvh::BackendKind backend=lvh::BackendKind::platform_default)
	Create a platform-default libvirtualhid runtime.
void	platf::virtualhid::free_gamepad (input_context_t &context, int nr)
	Release a libvirtualhid gamepad slot.
void	platf::virtualhid::gamepad_battery (input_context_t &context, const gamepad_battery_t &battery)
	Submit gamepad battery metadata.
void	platf::virtualhid::gamepad_motion (input_context_t &context, const gamepad_motion_t &motion)
	Submit a gamepad motion event.
void	platf::virtualhid::gamepad_touch (input_context_t &context, const gamepad_touch_t &touch)
	Submit a gamepad touch event.
void	platf::virtualhid::gamepad_update (input_context_t &context, int nr, const gamepad_state_t &state)
	Submit a full gamepad state.
client_context_t &	platf::virtualhid::get_client_context (client_input_t *input)
	Return the per-client libvirtualhid context from a platform input backend.
input_context_t &	platf::virtualhid::get_input_context (input_t &input)
	Return the shared libvirtualhid context from a platform input backend.
bool	platf::virtualhid::has_gamepad (const input_context_t &context, int nr)
	Check whether a libvirtualhid gamepad exists in a slot.
void	platf::virtualhid::hscroll (input_context_t &context, int high_res_distance)
	Submit horizontal scroll input.
void	platf::virtualhid::keyboard_update (input_context_t &context, std::uint16_t modcode, bool release, std::uint8_t flags, bool extended=false)
	Submit a keyboard key transition.
void	platf::virtualhid::move_mouse (input_context_t &context, const touch_port_t &touch_port, int delta_x, int delta_y)
	Retarget the virtual mouse and move it relatively.
void	platf::virtualhid::move_mouse (input_context_t &context, int delta_x, int delta_y)
	Move the virtual mouse relatively.
void	platf::virtualhid::pen_update (client_context_t &context, const touch_port_t &touch_port, const pen_input_t &pen)
	Submit a pen event.
int	platf::virtualhid::rebind_gamepad (input_context_t &context, const gamepad_id_t &id, feedback_queue_t feedback_queue)
	Rebind an existing libvirtualhid gamepad to a resumed client session.
void	platf::virtualhid::scroll (input_context_t &context, int high_res_distance)
	Submit vertical scroll input.
bool	platf::virtualhid::should_try_vigembus_fallback (std::string_view configured_gamepad, bool virtualhid_selected, std::string_view gamepad_driver)
	Decide whether ViGEmBus should be tried for a gamepad allocation.
bool	platf::virtualhid::should_use_gamepad_runtime (const lvh::BackendCapabilities &capabilities, std::string_view gamepad_driver, bool virtualhid_licensed)
	Decide whether a libvirtualhid runtime may create a gamepad.
std::vector< supported_gamepad_t >	platf::virtualhid::static_supported_gamepads ()
	Return static gamepad choices for config validation.
std::vector< supported_gamepad_t >	platf::virtualhid::supported_gamepads (lvh::Runtime *runtime, bool fallback_vigem_available=false, bool virtualhid_licensed=true, bool require_license=false)
	Return gamepad choices and runtime availability.
void	platf::virtualhid::touch_update (client_context_t &context, const touch_port_t &touch_port, const touch_input_t &touch)
	Submit a touchscreen event.
void	platf::virtualhid::unicode (input_context_t &context, const char *utf8, int size)
	Submit UTF-8 text input.

Detailed Description

Declarations for libvirtualhid-backed input helpers.

Function Documentation

◆ abs_mouse()

void platf::virtualhid::abs_mouse	(	input_context_t &	context,
		const touch_port_t &	touch_port,
		float	x,
		float	y )

Move the virtual mouse absolutely inside a target touch port.

Parameters

context	Input context.
touch_port	Target coordinate space.
x	Absolute X coordinate.
y	Absolute Y coordinate.

◆ alloc_gamepad()

int platf::virtualhid::alloc_gamepad	(	input_context_t &	context,
		const gamepad_id_t &	id,
		const gamepad_arrival_t &	metadata,
		feedback_queue_t	feedback_queue )

Allocate a libvirtualhid gamepad.

Parameters

context	Input context.
id	Sunshine gamepad identifiers.
metadata	Client-reported controller metadata.
feedback_queue	Queue used to return gamepad feedback to the client.

Returns: 0 on success, otherwise -1.

◆ button_mouse()

void platf::virtualhid::button_mouse	(	input_context_t &	context,
		int	button,
		bool	release )

Submit a mouse button event.

Parameters

context	Input context.
button	Moonlight mouse button.
release	Whether the button was released.

◆ configured_gamepad_supports_controller_extensions()

bool platf::virtualhid::configured_gamepad_supports_controller_extensions ( )

Return whether the configured gamepad profile needs Moonlight controller extensions.

Moonlight uses the controller-touch feature flag to authorize both controller touchpad and motion packets.

Returns: True when controller touchpad or motion input should be advertised.

◆ configured_gamepad_supports_touchpad()

bool platf::virtualhid::configured_gamepad_supports_touchpad ( )

Return whether the configured gamepad profile can expose touchpad input.

Returns: True when controller touchpad input should be advertised.

◆ create_runtime()

std::unique_ptr< lvh::Runtime > platf::virtualhid::create_runtime ( lvh::BackendKind backend = lvh::BackendKind::platform_default )

Create a platform-default libvirtualhid runtime.

Parameters

backend Backend used to create the runtime.

Returns: Runtime instance.

◆ free_gamepad()

void platf::virtualhid::free_gamepad	(	input_context_t &	context,
		int	nr )

Release a libvirtualhid gamepad slot.

Parameters

context	Input context.
nr	Gamepad slot index.

◆ gamepad_battery()

void platf::virtualhid::gamepad_battery	(	input_context_t &	context,
		const gamepad_battery_t &	battery )

Submit gamepad battery metadata.

Parameters

context	Input context.
battery	Sunshine battery event.

◆ gamepad_motion()

void platf::virtualhid::gamepad_motion	(	input_context_t &	context,
		const gamepad_motion_t &	motion )

Submit a gamepad motion event.

Parameters

context	Input context.
motion	Sunshine motion event.

◆ gamepad_touch()

void platf::virtualhid::gamepad_touch	(	input_context_t &	context,
		const gamepad_touch_t &	touch )

Submit a gamepad touch event.

Parameters

context	Input context.
touch	Sunshine touch event.

◆ gamepad_update()

void platf::virtualhid::gamepad_update	(	input_context_t &	context,
		int	nr,
		const gamepad_state_t &	state )

Submit a full gamepad state.

Parameters

context	Input context.
nr	Gamepad slot index.
state	Sunshine gamepad state.

◆ get_client_context()

virtualhid::client_context_t & platf::virtualhid::get_client_context ( client_input_t * input )

Return the per-client libvirtualhid context from a platform input backend.

Parameters

input Per-client platform input backend.

Returns: Per-client libvirtualhid input context.

◆ get_input_context()

virtualhid::input_context_t & platf::virtualhid::get_input_context ( input_t & input )

Return the shared libvirtualhid context from a platform input backend.

Parameters

input Platform input backend.

Returns: Shared libvirtualhid input context.

◆ has_gamepad()

bool platf::virtualhid::has_gamepad	(	const input_context_t &	context,
		int	nr )

Check whether a libvirtualhid gamepad exists in a slot.

Parameters

context	Input context.
nr	Gamepad slot index.

Returns: True when a virtual gamepad is active.

◆ hscroll()

void platf::virtualhid::hscroll	(	input_context_t &	context,
		int	high_res_distance )

Submit horizontal scroll input.

Parameters

context	Input context.
high_res_distance	High-resolution scroll distance.

◆ keyboard_update()

void platf::virtualhid::keyboard_update	(	input_context_t &	context,
		std::uint16_t	modcode,
		bool	release,
		std::uint8_t	flags,
		bool	extended = false )

Submit a keyboard key transition.

Parameters

context	Input context.
modcode	Portable key code.
release	Whether the key was released.
flags	Bit flags that modify the requested operation.
extended	Whether the client positively identified an extended key.

◆ move_mouse() [1/2]

void platf::virtualhid::move_mouse	(	input_context_t &	context,
		const touch_port_t &	touch_port,
		int	delta_x,
		int	delta_y )

Retarget the virtual mouse and move it relatively.

Parameters

context	Input context.
touch_port	Desktop and streamed-display bounds for the pointer.
delta_x	Horizontal delta.
delta_y	Vertical delta.

◆ move_mouse() [2/2]

void platf::virtualhid::move_mouse	(	input_context_t &	context,
		int	delta_x,
		int	delta_y )

Move the virtual mouse relatively.

Parameters

context	Input context.
delta_x	Horizontal delta.
delta_y	Vertical delta.

◆ pen_update()

void platf::virtualhid::pen_update	(	client_context_t &	context,
		const touch_port_t &	touch_port,
		const pen_input_t &	pen )

Submit a pen event.

Parameters

context	Client context.
touch_port	Touch coordinate bounds used for scaling.
pen	Pen event.

◆ rebind_gamepad()

int platf::virtualhid::rebind_gamepad	(	input_context_t &	context,
		const gamepad_id_t &	id,
		feedback_queue_t	feedback_queue )

Rebind an existing libvirtualhid gamepad to a resumed client session.

Parameters

context	Input context.
id	Sunshine gamepad identifiers for the resumed client.
feedback_queue	Queue used to return gamepad feedback to the resumed client.

Returns: 0 when the gamepad exists and was rebound; otherwise -1.

◆ scroll()

void platf::virtualhid::scroll	(	input_context_t &	context,
		int	high_res_distance )

Submit vertical scroll input.

Parameters

context	Input context.
high_res_distance	High-resolution scroll distance.

◆ should_try_vigembus_fallback()

bool platf::virtualhid::should_try_vigembus_fallback	(	std::string_view	configured_gamepad,
		bool	virtualhid_selected,
		std::string_view	gamepad_driver )

Decide whether ViGEmBus should be tried for a gamepad allocation.

When Virtual HID Driver is unavailable or deliberately bypassed, ViGEmBus uses automatic selection for profiles it cannot represent directly.

Parameters

configured_gamepad	Configured virtual gamepad profile.
virtualhid_selected	Whether Virtual HID Driver was selected for the allocation.
gamepad_driver	Configured Windows virtual gamepad driver policy.

Returns: True when Sunshine should attempt the ViGEmBus fallback.

◆ should_use_gamepad_runtime()

bool platf::virtualhid::should_use_gamepad_runtime	(	const lvh::BackendCapabilities &	capabilities,
		std::string_view	gamepad_driver,
		bool	virtualhid_licensed )

Decide whether a libvirtualhid runtime may create a gamepad.

Parameters

capabilities	Runtime backend capabilities.
gamepad_driver	Configured Windows virtual gamepad driver policy.
virtualhid_licensed	Whether the Virtual HID Driver machine license is valid.

Returns: True when the libvirtualhid runtime should receive gamepad allocations.

◆ static_supported_gamepads()

std::vector< supported_gamepad_t > platf::virtualhid::static_supported_gamepads ( )

Return static gamepad choices for config validation.

Returns: Supported gamepad choices.

◆ supported_gamepads()

std::vector< supported_gamepad_t > platf::virtualhid::supported_gamepads	(	lvh::Runtime *	runtime,
		bool	fallback_vigem_available = false,
		bool	virtualhid_licensed = true,
		bool	require_license = false )

Return gamepad choices and runtime availability.

Parameters

runtime	Runtime to probe.
fallback_vigem_available	Whether Windows ViGEm fallback can create gamepads.
virtualhid_licensed	Whether the broker has a valid license.
require_license	Whether this platform requires a broker license for gamepads.

Returns: Supported gamepad choices.

◆ touch_update()

void platf::virtualhid::touch_update	(	client_context_t &	context,
		const touch_port_t &	touch_port,
		const touch_input_t &	touch )

Submit a touchscreen event.

Parameters

context	Client context.
touch_port	Touch coordinate bounds used for scaling.
touch	Touch event.

◆ unicode()

void platf::virtualhid::unicode	(	input_context_t &	context,
		const char *	utf8,
		int	size )

Submit UTF-8 text input.

Parameters

context	Input context.
utf8	UTF-8 text buffer.
size	Text buffer size.

Sunshine 0.0.5917 Self-hosted game stream host for Moonlight.

Classes

Functions

Detailed Description

Function Documentation

◆ abs_mouse()

◆ alloc_gamepad()

◆ button_mouse()

◆ configured_gamepad_supports_controller_extensions()

◆ configured_gamepad_supports_touchpad()

◆ create_runtime()

◆ free_gamepad()

◆ gamepad_battery()

◆ gamepad_motion()

◆ gamepad_touch()

◆ gamepad_update()

◆ get_client_context()

◆ get_input_context()

◆ has_gamepad()

◆ hscroll()

◆ keyboard_update()

◆ move_mouse() [1/2]

◆ move_mouse() [2/2]

◆ pen_update()

◆ rebind_gamepad()

◆ scroll()

◆ should_try_vigembus_fallback()

◆ should_use_gamepad_runtime()

◆ static_supported_gamepads()

◆ supported_gamepads()

◆ touch_update()

◆ unicode()