Quick Links
  • Homepage
        - Overview
        - Download
        - Screenshots
        - Community
  • Code Sample Pack
  • Reference Guide
  • Changelog
  • Overview of GLSL Hacker
  • Live Coding
  • Hack your first GLSL Code
  • Moon3D




  • GLSL Hacker Articles

    > Compute shaders on Radeon
    > Distance functions in GLSL
    > GLSL Interpolation Qualifiers
    > Tessellation Spacing Modes
    > Normal Visualizer with GS
    > 3D Surface Plots
    > Normal Mapping
    > Circle and Disc in GLSL
    > PhysX 3 Flag Demo
    > GLSL Hacker on Raspberry Pi
    GLSL Hacker

    Reference Guide
    Host-API Lua / Python



    Back to Homepage
    Back to Developer's Guide Index

    gh_input Library


    Description
    gh_input is the module that manages user's input: mouse, keyboard...

    Number of functions: 5

    gh_input.mouse_getpos

    Description
    Returns the position of the mouse cursor in screen coordinates. The top-left position is the {0, 0} position.

    Languages: Lua - Python

    Return Values
  • x, y [INTEGER]: mouse position

    Code sample :

    mx, my = gh_input.mouse_getpos()


    gh_input.mouse_get_button_state

    Description
    Returns the state of a mouse button.

    Languages: Lua - Python

    Parameters
  • button [INTEGER]: mouse button identifier: left button (1) or right button (2).

    Return Values
  • state [INTEGER]: button state: 1 if down (pressed) or 0 if up (not pressed).

    Code sample :

    local LEFT_BUTTON = 1
    local RIGHT_BUTTON = 2
    local is_down = gh_input.mouse_get_button_state(LEFT_BUTTON)


    gh_input.mouse_show_cursor

    Description
    Shows or hide the mouse cursor (Windows only).

    Languages: Lua - Python

    Parameters
  • state [INTEGER]: show (1) or hide (0)

    Code sample :

    gh_input.mouse_show_cursor(0)


    gh_input.keyboard_is_key_down

    Description
    Returns the pressed state of a keyboard key.

    Languages: Lua - Python

    Parameters
  • key [INTEGER]: key code.

    Return Values
  • state [INTEGER]: key state: 1 if down (pressed) or 0 if up (not pressed).

    Code sample :

    -- More key codes can be found in GLSL Hacker forum.
    local KC_W = 17
    local KC_S = 31
    local KC_A = 30
    local KC_D = 32

    local KC_LEFT = 75
    local KC_RIGHT = 77
    local KC_UP = 72
    local KC_DOWN = 80
    local KC_SPACE = 57

    local is_down = gh_input.keyboard_is_key_down(KC_SPACE)
    if (is_down == 1) then
    -- pressed!
    end


    gh_input.keyboard_update_buffer

    Description
    Updates the keyboard buffer. Call this function before keyboard_is_key_down().

    Languages: Lua - Python

    Code sample :

    gh_input.keyboard_update_buffer()
    local is_down = gh_input.keyboard_is_key_down(KC_SPACE)





  • (C)2012-2014 Geeks3D