Struct vjoy_wrapper::vjoy_base::device::info::VJDInfo

pub struct VJDInfo(_);

Holder of utility methods to retrieve information regarding vJoy devices.

Implementations

impl VJDInfo

pub fn is_exist_device(device: VJDevice) -> bool

Returns true if the specified device exists (configured and enabled), false otherwise (including the following cases: device does not exist, disabled, driver not installed).

pub fn is_exist_axis(device: VJDevice, axis: VJDAxis) -> bool

Returns true if the specified axis exists in the specified device, false otherwise.

pub fn get_status(device: VJDevice) -> VJDStatus

Returns the status of the specified device as one variant of the VJDStatus enum.

pub fn get_owner_pid(device: VJDevice) -> Result<i32, PIDFailed>

Returns the process id (PID) of the process that owns the specified device.

If the device is owned by a process, then the method returns a positive integer which is the PID of the owner.

Otherwise, the method returns one variant of the PIDFailed enum to describe the resulting negative state.

pub fn get_total_btns(device: VJDevice) -> Result<u8, TotalBtnsFailed>

On success, returns the number of buttons in the specified device. Valid values are 0 to 128.

On failure, returns one variant of TotalBtnsFailed enum.

pub fn get_total_disc_povs(device: VJDevice) -> Result<u8, TotalPOVFailed>

Returns the number of discrete-type POV hats in the specified device, or one variant of TotalPOVFailed if it fails.

Valid number value is 0 to 4.

pub fn get_total_cont_povs(device: VJDevice) -> Result<u8, TotalPOVFailed>

Returns the number of continuous-type POV hats in the specified device, or one variant of TotalPOVFailed if it fails.

Valid number value is 0 to 4.