Table Of Contents

Acquire Device (G Dataflow)

Version:
    Last Modified: April 28, 2017

    Returns data about the device connected to the computer.

    Programming Patterns

    Wire Initialize Device to this node to specify the device data you want to acquire.

    connector_pane_image
    datatype_icon

    keyboard in

    Reference to the keyboard connected to the computer.

    Default: 0

    datatype_icon

    joystick in

    Reference to the joystick connected to the computer.

    This input only appears after you set the Function Configuration of the Initialize Device node to Joystick and wire the joystick output of Initialize Joystick to keyboard in.

    Default: 0

    datatype_icon

    mouse in

    Reference to the mouse connected to the computer.

    This input only appears after you set the Function Configuration of the Initialize Device node to Mouse and wire the mouse output of Initialize Mouse to keyboard in.

    Default: 0

    datatype_icon

    key mode

    Defines the mouse coordinates in axis info.

    This input only appears after you set the Function Configuration of the Initialize Device node to Mouse and wire the mouse output of Initialize Mouse to keyboard in.

    Name Description
    Relative Defines the mouse coordinates (axis info) as relative to the last time you called the node.
    Absolute Defines the mouse coordinates (axis info) as absolute coordinates relative to the upper left hand corner of the screen.

    Default: Absolute

    datatype_icon

    error in

    Error conditions that occur before this node runs.

    The node responds to this input according to standard error behavior.

    Standard Error Behavior

    Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

    error in does not contain an error error in contains an error
    If no error occurred before the node runs, the node begins execution normally.

    If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

    If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

    Default: No error

    datatype_icon

    keyboard out

    Reference to the keyboard connected to the computer.

    datatype_icon

    joystick out

    Reference to the joystick connected to the computer.

    This output only appears after you set the Function Configuration of the Initialize Device node to Joystick and wire the joystick output of Initialize Joystick to keyboard in.

    datatype_icon

    mouse out

    Reference to the mouse connected to the computer.

    This output only appears after you set the Function Configuration of the Initialize Device node to Mouse and wire the mouse output of Initialize Mouse to keyboard in.

    datatype_icon

    keys pressed

    Numeric that provides information about which keys are pressed when the node runs and only returns values associated with US keyboards.

    This output only appears after you set the Function Configuration of the Initialize Device node to Keyboard and wire the keyboard output of Initialize Keyboard to keyboard in.

    datatype_icon

    axis info

    Numeric values for the axes. The axis information you have access to varies depending on the device connected to the computer.

    This output only appears after you set the Function Configuration of the Initialize Device node to Mouse or Joystick and wire the mouse or joystick output of Initialize Mouse or Initialize Joystick to keyboard in.

    datatype_icon

    Horizontal

    Numeric value of the horizontal axis.

    datatype_icon

    X axis

    Numeric value of the x-axis.

    datatype_icon

    Vertical

    Numeric value of the vertical axis.

    datatype_icon

    Y axis

    Numeric value of the y-axis.

    datatype_icon

    Scrolling

    Numeric value of the scrolling axis if the mouse supports scrolling.

    datatype_icon

    Z axis

    Numeric value of the z-axis.

    datatype_icon

    X axis rotation

    Numeric value of the x-axis rotation.

    datatype_icon

    Y axis rotation

    Numeric value of the y-axis rotation.

    datatype_icon

    Z axis rotation

    Numeric value of the z-axis rotation.

    datatype_icon

    U axis

    Numeric value of the u-axis.

    datatype_icon

    V axis

    Numeric value for the v-axis.

    datatype_icon

    button info

    Cluster that contains Boolean values for buttons. The number of buttons you have access to depends on the device connected to the computer and displays up to four buttons for a mouse and 32 buttons for a joystick.

    This output only appears after you set the Function Configuration of the Initialize Device node to Mouse or Joystick and wire the mouse or Joystick output of Initialize Mouse or Initialize Joystick to keyboard in.

    True Button is activated.
    False Button is not activated.
    datatype_icon

    error out

    Error information.

    The node produces this output according to standard error behavior.

    Standard Error Behavior

    Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

    error in does not contain an error error in contains an error
    If no error occurred before the node runs, the node begins execution normally.

    If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

    If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.
    datatype_icon

    direction info

    Numeric values for up to four directions in which you move your joystick.

    This output only appears after you set the Function Configuration of the Initialize Device node to Joystick and wire the joystick output of Initialize Joystick to keyboard in.

    Where This Node Can Run:

    Desktop OS: Windows

    FPGA: This product does not support FPGA devices


    Recently Viewed Topics