IKeyCallback.java

/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2014-2017 Sri Harsha Chilakapati
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package com.shc.silenceengine.backend.lwjgl.glfw.callbacks;

import com.shc.silenceengine.backend.lwjgl.glfw.Window;

/**
 * Functional Interface describing the signature of the {@code GLFWkeyfun} in Java 8 environment. To set a key
 * callback on a window, use the function {@code setKeyCallback()} on a {@code Window} object.
 *
 * @author Sri Harsha Chilakapati
 */
@FunctionalInterface
public interface IKeyCallback
{
    /**
     * The signature of the {@code GLFWkeyfun} method. This method is invoked by GLFW to notify you whenever a key
     * input has occurred.
     *
     * @param window   The Window that received the event.
     * @param key      The keycode of the key that was released or pressed.
     * @param scanCode The system-specific scan code of the key.
     * @param action   {@code GLFW_PRESS, GLFW_RELEASE} or {@code GLFW_REPEAT}.
     * @param mods     Bit field describing which modifier keys were held down.
     */
    void invoke(Window window, int key, int scanCode, int action, int mods);
}