falsepattern/zig-glfw
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

glfw: add Joystick.isGamepad

Browse source 
Signed-off-by: Stephen Gutekanst <stephen@hexops.com>
This commit is contained in:
Stephen Gutekanst 2021-10-21 21:44:11 -07:00 • committed by Stephen Gutekanst
parent 71036baa25
commit 2c62772a37
1 changed files with 35 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

60
src/joystick.zig
View file

@ -326,31 +326,6 @@ const GamepadState = extern struct {
// /// @ingroup input
// GLFWAPI void* glfwGetJoystickUserPointer(int jid);
// TODO(joystick)
// /// Returns whether the specified joystick has a gamepad mapping.
// ///
// /// This function returns whether the specified joystick is both present and has
// /// a gamepad mapping.
// ///
// /// If the specified joystick is present but does not have a gamepad mapping
// /// this function will return `false` but will not generate an error. Call
// /// @ref glfwJoystickPresent to check if a joystick is present regardless of
// /// whether it has a mapping.
// ///
// /// @param[in] jid The [joystick](@ref joysticks) to query.
// /// @return `true` if a joystick is both present and has a gamepad mapping,
// /// or `false` otherwise.
// ///
// /// Possible errors include glfw.Error.NotInitialized and glfw.Error.InvalidEnum.
// ///
// /// @thread_safety This function must only be called from the main thread.
// ///
// /// see also: gamepad, glfwGetGamepadState
// ///
// ///
// /// @ingroup input
// GLFWAPI int glfwJoystickIsGamepad(int jid);
// TODO(joystick)
// /// Sets the joystick configuration callback.
// ///
@ -414,6 +389,32 @@ pub inline fn updateGamepadMappings(gamepad_mappings: [*c]const u8) Error!void {
try getError();
}
/// Returns whether the specified joystick has a gamepad mapping.
///
/// This function returns whether the specified joystick is both present and has a gamepad mapping.
///
/// If the specified joystick is present but does not have a gamepad mapping this function will
/// return `false` but will not generate an error. Call glfw.Joystick.present to check if a
/// joystick is present regardless of whether it has a mapping.
///
/// @return `true` if a joystick is both present and has a gamepad mapping, or `false` otherwise.
///
/// Possible errors include glfw.Error.NotInitialized and glfw.Error.InvalidEnum.
///
/// @thread_safety This function must only be called from the main thread.
///
/// see also: gamepad, glfw.Joystick.getGamepadState
pub inline fn isGamepad(self: Joystick) bool {
const is_gamepad = c.glfwJoystickIsGamepad(self.jid);
// The only error this could return would be glfw.Error.NotInitialized, which should
// definitely have occurred before calls to this, or glfw.Error.InvalidEnum if the joystick ID
// is wrong. Returning an error here makes the API awkward to use, so we discard it instead.
getError() catch {};
return is_gamepad == c.GLFW_TRUE;
}
/// Returns the human-readable gamepad name for the specified joystick.
///
/// This function returns the human-readable name of the gamepad from the gamepad mapping assigned
@ -475,6 +476,15 @@ test "updateGamepadMappings_syntax" {
_ = updateGamepadMappings;
}
test "isGamepad" {
const glfw = @import("main.zig");
try glfw.init();
defer glfw.terminate();
const joystick = glfw.Joystick{ .jid = glfw.Joystick.one };
_ = joystick.isGamepad();
}
test "getGamepadName" {
const glfw = @import("main.zig");
try glfw.init();