From b1d6589b73a5f228fcb6d251acad6d2948936160 Mon Sep 17 00:00:00 2001 From: dyorgio Date: Wed, 23 May 2018 11:32:42 -0300 Subject: [PATCH] Added usage example (github pages). --- docs/index.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/docs/index.md b/docs/index.md index 5dfc9a1..af1224a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -44,3 +44,28 @@ Include dependency in your project: ## Usage + ```java + /* Create an event object for the underlying plugin to populate */ + Event event = new Event(); + + /* Get the available controllers */ + Controller[] controllers = ControllerEnvironment.getDefaultEnvironment().getControllers(); + for (int i = 0; i < controllers.length; i++) { + /* Remember to poll each one */ + controllers[i].poll(); + + /* Get the controllers event queue */ + EventQueue queue = controllers[i].getEventQueue(); + + /* For each object in the queue */ + while (queue.getNextEvent(event)) { + /* Get event component */ + Component comp = event.getComponent(); + + /* Process event (your awesome code) */ + ... + } + } + ``` + +### [More examples here](https://github.com/jinput/jinput/tree/master/examples/src/main/java/net/java/games/input/example).