[go: up one dir, main page]

GLFWkeyfun

Type Alias GLFWkeyfun 

Source
pub type GLFWkeyfun = Option<unsafe extern "C" fn(*mut GLFWwindow, i32, i32, i32, i32)>;
Expand description

@brief The function pointer type for keyboard key callbacks.

This is the function pointer type for keyboard key callbacks. A keyboard key callback function has the following signature: @code void function_name(GLFWwindow* window, int key, int scancode, int action, int mods) @endcode

@param[in] window The window that received the event. @param[in] key The [keyboard key](@ref keys) that was pressed or released. @param[in] scancode The platform-specific scancode of the key. @param[in] action GLFW_PRESS, GLFW_RELEASE or GLFW_REPEAT. Future releases may add more actions. @param[in] mods Bit field describing which [modifier keys](@ref mods) were held down.

@sa @ref input_key @sa @ref glfwSetKeyCallback

@since Added in version 1.0. @glfw3 Added window handle, scancode and modifier mask parameters.

@ingroup input

Aliased Type§

pub enum GLFWkeyfun {
    None,
    Some(unsafe extern "C" fn(*mut GLFWwindow, i32, i32, i32, i32)),
}

Variants§

§1.0.0

None

No value.

§1.0.0

Some(unsafe extern "C" fn(*mut GLFWwindow, i32, i32, i32, i32))

Some value of type T.