carb.input

pybind11 carb.input bindings

class carb.input.ActionEvent

Bases: pybind11_builtins.pybind11_object

property action
property flags
property value
class carb.input.ActionMappingDesc

Bases: pybind11_builtins.pybind11_object

property device
property deviceType
property input
property modifiers
class carb.input.ActionMappingSet

Bases: pybind11_builtins.pybind11_object

class carb.input.DeviceType(self: carb.input.DeviceType, arg0: int)None

Bases: pybind11_builtins.pybind11_object

Members:

KEYBOARD

MOUSE

GAMEPAD

GAMEPAD = DeviceType.GAMEPAD
KEYBOARD = DeviceType.KEYBOARD
MOUSE = DeviceType.MOUSE
property name

handle) -> str

Type

(self

class carb.input.EventType(self: carb.input.EventType, arg0: int)None

Bases: pybind11_builtins.pybind11_object

Members:

UNKNOWN

UNKNOWN = EventType.UNKNOWN
property name

handle) -> str

Type

(self

class carb.input.Gamepad

Bases: carb.input.InputDevice

class carb.input.GamepadEvent

Bases: pybind11_builtins.pybind11_object

property device
property gamepad
property input
property value
class carb.input.GamepadInput(self: carb.input.GamepadInput, arg0: int)None

Bases: pybind11_builtins.pybind11_object

Members:

LEFT_STICK_RIGHT

LEFT_STICK_LEFT

LEFT_STICK_UP

LEFT_STICK_DOWN

RIGHT_STICK_RIGHT

RIGHT_STICK_LEFT

RIGHT_STICK_UP

RIGHT_STICK_DOWN

LEFT_TRIGGER

RIGHT_TRIGGER

A

B

X

Y

LEFT_SHOULDER

RIGHT_SHOULDER

MENU1

MENU2

LEFT_STICK

RIGHT_STICK

DPAD_UP

DPAD_RIGHT

DPAD_DOWN

DPAD_LEFT

COUNT

A = GamepadInput.A
B = GamepadInput.B
COUNT = GamepadInput.COUNT
DPAD_DOWN = GamepadInput.DPAD_DOWN
DPAD_LEFT = GamepadInput.DPAD_LEFT
DPAD_RIGHT = GamepadInput.DPAD_RIGHT
DPAD_UP = GamepadInput.DPAD_UP
LEFT_SHOULDER = GamepadInput.LEFT_SHOULDER
LEFT_STICK = GamepadInput.LEFT_STICK
LEFT_STICK_DOWN = GamepadInput.LEFT_STICK_DOWN
LEFT_STICK_LEFT = GamepadInput.LEFT_STICK_LEFT
LEFT_STICK_RIGHT = GamepadInput.LEFT_STICK_RIGHT
LEFT_STICK_UP = GamepadInput.LEFT_STICK_UP
LEFT_TRIGGER = GamepadInput.LEFT_TRIGGER
MENU1 = GamepadInput.MENU1
MENU2 = GamepadInput.MENU2
RIGHT_SHOULDER = GamepadInput.RIGHT_SHOULDER
RIGHT_STICK = GamepadInput.RIGHT_STICK
RIGHT_STICK_DOWN = GamepadInput.RIGHT_STICK_DOWN
RIGHT_STICK_LEFT = GamepadInput.RIGHT_STICK_LEFT
RIGHT_STICK_RIGHT = GamepadInput.RIGHT_STICK_RIGHT
RIGHT_STICK_UP = GamepadInput.RIGHT_STICK_UP
RIGHT_TRIGGER = GamepadInput.RIGHT_TRIGGER
X = GamepadInput.X
Y = GamepadInput.Y
property name

handle) -> str

Type

(self

class carb.input.IInput

Bases: pybind11_builtins.pybind11_object

add_action_mapping(*args, **kwargs)

Overloaded function.

  1. add_action_mapping(self: carb.input.IInput, arg0: carb.input.ActionMappingSet, arg1: str, arg2: carb.input.Keyboard, arg3: carb.input.KeyboardInput, arg4: int) -> int

  2. add_action_mapping(self: carb.input.IInput, arg0: carb.input.ActionMappingSet, arg1: str, arg2: carb.input.Gamepad, arg3: carb.input.GamepadInput) -> int

  3. add_action_mapping(self: carb.input.IInput, arg0: carb.input.ActionMappingSet, arg1: str, arg2: carb.input.Mouse, arg3: carb.input.MouseInput, arg4: int) -> int

clear_action_mappings(self: carb.input.IInput, arg0: carb.input.ActionMappingSet, arg1: str)None
get_action_button_flags(self: carb.input.IInput, arg0: carb.input.ActionMappingSet, arg1: str)int
get_action_mapping_count(self: carb.input.IInput, arg0: carb.input.ActionMappingSet, arg1: str)int
get_action_mapping_set_by_path(self: carb.input.IInput, arg0: str)carb.input.ActionMappingSet
get_action_mappings(self: carb.input.IInput, arg0: carb.input.ActionMappingSet, arg1: str) → List[carb.input.ActionMappingDesc]
get_action_value(self: carb.input.IInput, arg0: carb.input.ActionMappingSet, arg1: str)float
get_actions(self: carb.input.IInput, arg0: carb.input.ActionMappingSet) → List[str]
get_device_name(self: carb.input.IInput, arg0: carb.input.InputDevice)str
get_device_type(self: carb.input.IInput, arg0: carb.input.InputDevice)carb.input.DeviceType
get_gamepad_button_flags(self: carb.input.IInput, arg0: carb.input.Gamepad, arg1: carb.input.GamepadInput)int
get_gamepad_guid(self: carb.input.IInput, arg0: carb.input.Gamepad)str
get_gamepad_name(self: carb.input.IInput, arg0: carb.input.Gamepad)str
get_gamepad_value(self: carb.input.IInput, arg0: carb.input.Gamepad, arg1: carb.input.GamepadInput)float
get_keyboard_button_flags(self: carb.input.IInput, arg0: carb.input.Keyboard, arg1: carb.input.KeyboardInput)int
get_keyboard_name(self: carb.input.IInput, arg0: carb.input.Keyboard)str
get_keyboard_value(self: carb.input.IInput, arg0: carb.input.Keyboard, arg1: carb.input.KeyboardInput)float
get_mouse_button_flags(self: carb.input.IInput, arg0: carb.input.Mouse, arg1: carb.input.MouseInput)int
get_mouse_coords(self: carb.input.IInput, arg0: carb.input.Mouse) → carb._carb.Float2
get_mouse_name(self: carb.input.IInput, arg0: carb.input.Mouse)str
get_mouse_value(self: carb.input.IInput, arg0: carb.input.Mouse, arg1: carb.input.MouseInput)float
remove_action_mapping(self: carb.input.IInput, arg0: carb.input.ActionMappingSet, arg1: str, arg2: int)None
set_action_mapping(*args, **kwargs)

Overloaded function.

  1. set_action_mapping(self: carb.input.IInput, arg0: carb.input.ActionMappingSet, arg1: str, arg2: int, arg3: carb.input.Keyboard, arg4: carb.input.KeyboardInput, arg5: int) -> None

  2. set_action_mapping(self: carb.input.IInput, arg0: carb.input.ActionMappingSet, arg1: str, arg2: int, arg3: carb.input.Gamepad, arg4: carb.input.GamepadInput) -> None

  3. set_action_mapping(self: carb.input.IInput, arg0: carb.input.ActionMappingSet, arg1: str, arg2: int, arg3: carb.input.Mouse, arg4: carb.input.MouseInput, arg5: int) -> None

set_default_action_mapping(*args, **kwargs)

Overloaded function.

  1. set_default_action_mapping(self: carb.input.IInput, arg0: carb.input.ActionMappingSet, arg1: str, arg2: carb.input.Keyboard, arg3: carb.input.KeyboardInput, arg4: int) -> bool

  2. set_default_action_mapping(self: carb.input.IInput, arg0: carb.input.ActionMappingSet, arg1: str, arg2: carb.input.Gamepad, arg3: carb.input.GamepadInput) -> bool

  3. set_default_action_mapping(self: carb.input.IInput, arg0: carb.input.ActionMappingSet, arg1: str, arg2: carb.input.Mouse, arg3: carb.input.MouseInput, arg4: int) -> bool

subscribe_to_action_events(self: carb.input.IInput, arg0: carb.input.ActionMappingSet, arg1: str, arg2: Callable[[carb.input.ActionEvent], bool])int
subscribe_to_gamepad_connection_events(self: carb.input.IInput, arg0: Callable[[carb::input::GamepadConnectionEvent], None])int
subscribe_to_gamepad_events(self: carb.input.IInput, arg0: carb.input.Gamepad, arg1: Callable[[carb.input.GamepadEvent], bool])int
subscribe_to_input_events(self: carb.input.IInput, eventFn: Callable[[carb.input.InputEvent], bool], eventTypes: int = 4294967295, device: carb.input.InputDevice = None, order: int = - 1)int
subscribe_to_keyboard_events(self: carb.input.IInput, arg0: carb.input.Keyboard, arg1: Callable[[carb.input.KeyboardEvent], bool])int
subscribe_to_mouse_events(self: carb.input.IInput, arg0: carb.input.Mouse, arg1: Callable[[carb.input.MouseEvent], bool])int
unsubscribe_to_action_events(self: carb.input.IInput, arg0: int)None
unsubscribe_to_gamepad_connection_events(self: carb.input.IInput, arg0: int)None
unsubscribe_to_gamepad_events(self: carb.input.IInput, arg0: carb.input.Gamepad, arg1: int)None
unsubscribe_to_input_events(self: carb.input.IInput, arg0: int)None
unsubscribe_to_keyboard_events(self: carb.input.IInput, arg0: carb.input.Keyboard, arg1: int)None
unsubscribe_to_mouse_events(self: carb.input.IInput, arg0: carb.input.Mouse, arg1: int)None
class carb.input.InputDevice

Bases: pybind11_builtins.pybind11_object

class carb.input.InputEvent

Bases: pybind11_builtins.pybind11_object

property device
property deviceType
property event
class carb.input.InputProvider

Bases: pybind11_builtins.pybind11_object

buffer_gamepad_event(self: carb.input.InputProvider, arg0: carb.input.Gamepad, arg1: carb.input.GamepadInput, arg2: float)None
buffer_keyboard_char_event(self: carb.input.InputProvider, arg0: carb.input.Keyboard, arg1: str, arg2: int)None
buffer_keyboard_key_event(self: carb.input.InputProvider, arg0: carb.input.Keyboard, arg1: carb.input.KeyboardEventType, arg2: carb.input.KeyboardInput, arg3: int)None
buffer_mouse_event(self: carb.input.InputProvider, arg0: carb.input.Mouse, arg1: carb.input.MouseEventType, arg2: carb._carb.Float2, arg3: int)None
create_gamepad(self: carb.input.InputProvider, arg0: str, arg1: str)carb.input.Gamepad
create_keyboard(self: carb.input.InputProvider, arg0: str)carb.input.Keyboard
create_mouse(self: carb.input.InputProvider, arg0: str)carb.input.Mouse
destroy_gamepad(self: carb.input.InputProvider, arg0: carb.input.Gamepad)None
destroy_keyboard(self: carb.input.InputProvider, arg0: carb.input.Keyboard)None
destroy_mouse(self: carb.input.InputProvider, arg0: carb.input.Mouse)None
set_gamepad_connected(self: carb.input.InputProvider, arg0: carb.input.Gamepad, arg1: bool)None
update_gamepad(self: carb.input.InputProvider, arg0: carb.input.Gamepad)None
update_keyboard(self: carb.input.InputProvider, arg0: carb.input.Keyboard)None
update_mouse(self: carb.input.InputProvider, arg0: carb.input.Mouse)None
class carb.input.Keyboard

Bases: carb.input.InputDevice

class carb.input.KeyboardEvent

Bases: pybind11_builtins.pybind11_object

property device
property input
property keyboard
property modifiers
property type
class carb.input.KeyboardEventType(self: carb.input.KeyboardEventType, arg0: int)None

Bases: pybind11_builtins.pybind11_object

Members:

KEY_PRESS

KEY_REPEAT

KEY_RELEASE

CHAR

CHAR = KeyboardEventType.CHAR
KEY_PRESS = KeyboardEventType.KEY_PRESS
KEY_RELEASE = KeyboardEventType.KEY_RELEASE
KEY_REPEAT = KeyboardEventType.KEY_REPEAT
property name

handle) -> str

Type

(self

class carb.input.KeyboardInput(self: carb.input.KeyboardInput, arg0: int)None

Bases: pybind11_builtins.pybind11_object

Members:

UNKNOWN

SPACE

APOSTROPHE

COMMA

MINUS

PERIOD

SLASH

KEY_0

KEY_1

KEY_2

KEY_3

KEY_4

KEY_5

KEY_6

KEY_7

KEY_8

KEY_9

SEMICOLON

EQUAL

A

B

C

D

E

F

G

H

I

J

K

L

M

N

O

P

Q

R

S

T

U

V

W

X

Y

Z

LEFT_BRACKET

BACKSLASH

RIGHT_BRACKET

GRAVE_ACCENT

ESCAPE

TAB

ENTER

BACKSPACE

INSERT

DEL

RIGHT

LEFT

DOWN

UP

PAGE_UP

PAGE_DOWN

HOME

END

CAPS_LOCK

SCROLL_LOCK

NUM_LOCK

PRINT_SCREEN

PAUSE

F1

F2

F3

F4

F5

F6

F7

F8

F9

F10

F11

F12

NUMPAD_0

NUMPAD_1

NUMPAD_2

NUMPAD_3

NUMPAD_4

NUMPAD_5

NUMPAD_6

NUMPAD_7

NUMPAD_8

NUMPAD_9

NUMPAD_DEL

NUMPAD_DIVIDE

NUMPAD_MULTIPLY

NUMPAD_SUBTRACT

NUMPAD_ADD

NUMPAD_ENTER

NUMPAD_EQUAL

LEFT_SHIFT

LEFT_CONTROL

LEFT_ALT

LEFT_SUPER

RIGHT_SHIFT

RIGHT_CONTROL

RIGHT_ALT

RIGHT_SUPER

MENU

COUNT

A = KeyboardInput.A
APOSTROPHE = KeyboardInput.APOSTROPHE
B = KeyboardInput.B
BACKSLASH = KeyboardInput.BACKSLASH
BACKSPACE = KeyboardInput.BACKSPACE
C = KeyboardInput.C
CAPS_LOCK = KeyboardInput.CAPS_LOCK
COMMA = KeyboardInput.COMMA
COUNT = KeyboardInput.COUNT
D = KeyboardInput.D
DEL = KeyboardInput.DEL
DOWN = KeyboardInput.DOWN
E = KeyboardInput.E
END = KeyboardInput.END
ENTER = KeyboardInput.ENTER
EQUAL = KeyboardInput.EQUAL
ESCAPE = KeyboardInput.ESCAPE
F = KeyboardInput.F
F1 = KeyboardInput.F1
F10 = KeyboardInput.F10
F11 = KeyboardInput.F11
F12 = KeyboardInput.F12
F2 = KeyboardInput.F2
F3 = KeyboardInput.F3
F4 = KeyboardInput.F4
F5 = KeyboardInput.F5
F6 = KeyboardInput.F6
F7 = KeyboardInput.F7
F8 = KeyboardInput.F8
F9 = KeyboardInput.F9
G = KeyboardInput.G
GRAVE_ACCENT = KeyboardInput.GRAVE_ACCENT
H = KeyboardInput.H
HOME = KeyboardInput.HOME
I = KeyboardInput.I
INSERT = KeyboardInput.INSERT
J = KeyboardInput.J
K = KeyboardInput.K
KEY_0 = KeyboardInput.KEY_0
KEY_1 = KeyboardInput.KEY_1
KEY_2 = KeyboardInput.KEY_2
KEY_3 = KeyboardInput.KEY_3
KEY_4 = KeyboardInput.KEY_4
KEY_5 = KeyboardInput.KEY_5
KEY_6 = KeyboardInput.KEY_6
KEY_7 = KeyboardInput.KEY_7
KEY_8 = KeyboardInput.KEY_8
KEY_9 = KeyboardInput.KEY_9
L = KeyboardInput.L
LEFT = KeyboardInput.LEFT
LEFT_ALT = KeyboardInput.LEFT_ALT
LEFT_BRACKET = KeyboardInput.LEFT_BRACKET
LEFT_CONTROL = KeyboardInput.LEFT_CONTROL
LEFT_SHIFT = KeyboardInput.LEFT_SHIFT
LEFT_SUPER = KeyboardInput.LEFT_SUPER
M = KeyboardInput.M
MENU = KeyboardInput.MENU
MINUS = KeyboardInput.MINUS
N = KeyboardInput.N
NUMPAD_0 = KeyboardInput.NUMPAD_0
NUMPAD_1 = KeyboardInput.NUMPAD_1
NUMPAD_2 = KeyboardInput.NUMPAD_2
NUMPAD_3 = KeyboardInput.NUMPAD_3
NUMPAD_4 = KeyboardInput.NUMPAD_4
NUMPAD_5 = KeyboardInput.NUMPAD_5
NUMPAD_6 = KeyboardInput.NUMPAD_6
NUMPAD_7 = KeyboardInput.NUMPAD_7
NUMPAD_8 = KeyboardInput.NUMPAD_8
NUMPAD_9 = KeyboardInput.NUMPAD_9
NUMPAD_ADD = KeyboardInput.NUMPAD_ADD
NUMPAD_DEL = KeyboardInput.NUMPAD_DEL
NUMPAD_DIVIDE = KeyboardInput.NUMPAD_DIVIDE
NUMPAD_ENTER = KeyboardInput.NUMPAD_ENTER
NUMPAD_EQUAL = KeyboardInput.NUMPAD_EQUAL
NUMPAD_MULTIPLY = KeyboardInput.NUMPAD_MULTIPLY
NUMPAD_SUBTRACT = KeyboardInput.NUMPAD_SUBTRACT
NUM_LOCK = KeyboardInput.NUM_LOCK
O = KeyboardInput.O
P = KeyboardInput.P
PAGE_DOWN = KeyboardInput.PAGE_DOWN
PAGE_UP = KeyboardInput.PAGE_UP
PAUSE = KeyboardInput.PAUSE
PERIOD = KeyboardInput.PERIOD
PRINT_SCREEN = KeyboardInput.PRINT_SCREEN
Q = KeyboardInput.Q
R = KeyboardInput.R
RIGHT = KeyboardInput.RIGHT
RIGHT_ALT = KeyboardInput.RIGHT_ALT
RIGHT_BRACKET = KeyboardInput.RIGHT_BRACKET
RIGHT_CONTROL = KeyboardInput.RIGHT_CONTROL
RIGHT_SHIFT = KeyboardInput.RIGHT_SHIFT
RIGHT_SUPER = KeyboardInput.RIGHT_SUPER
S = KeyboardInput.S
SCROLL_LOCK = KeyboardInput.SCROLL_LOCK
SEMICOLON = KeyboardInput.SEMICOLON
SLASH = KeyboardInput.SLASH
SPACE = KeyboardInput.SPACE
T = KeyboardInput.T
TAB = KeyboardInput.TAB
U = KeyboardInput.U
UNKNOWN = KeyboardInput.UNKNOWN
UP = KeyboardInput.UP
V = KeyboardInput.V
W = KeyboardInput.W
X = KeyboardInput.X
Y = KeyboardInput.Y
Z = KeyboardInput.Z
property name

handle) -> str

Type

(self

class carb.input.Mouse

Bases: carb.input.InputDevice

class carb.input.MouseEvent

Bases: pybind11_builtins.pybind11_object

property coords
property device
property modifiers
property mouse
property scrollDelta
property type
class carb.input.MouseEventType(self: carb.input.MouseEventType, arg0: int)None

Bases: pybind11_builtins.pybind11_object

Members:

LEFT_BUTTON_DOWN

LEFT_BUTTON_UP

MIDDLE_BUTTON_DOWN

MIDDLE_BUTTON_UP

RIGHT_BUTTON_DOWN

RIGHT_BUTTON_UP

MOVE

SCROLL

LEFT_BUTTON_DOWN = MouseEventType.LEFT_BUTTON_DOWN
LEFT_BUTTON_UP = MouseEventType.LEFT_BUTTON_UP
MIDDLE_BUTTON_DOWN = MouseEventType.MIDDLE_BUTTON_DOWN
MIDDLE_BUTTON_UP = MouseEventType.MIDDLE_BUTTON_UP
MOVE = MouseEventType.MOVE
RIGHT_BUTTON_DOWN = MouseEventType.RIGHT_BUTTON_DOWN
RIGHT_BUTTON_UP = MouseEventType.RIGHT_BUTTON_UP
SCROLL = MouseEventType.SCROLL
property name

handle) -> str

Type

(self

class carb.input.MouseInput(self: carb.input.MouseInput, arg0: int)None

Bases: pybind11_builtins.pybind11_object

Members:

LEFT_BUTTON

RIGHT_BUTTON

MIDDLE_BUTTON

FORWARD_BUTTON

BACK_BUTTON

SCROLL_RIGHT

SCROLL_LEFT

SCROLL_UP

SCROLL_DOWN

MOVE_RIGHT

MOVE_LEFT

MOVE_UP

MOVE_DOWN

COUNT

BACK_BUTTON = MouseInput.BACK_BUTTON
COUNT = MouseInput.COUNT
FORWARD_BUTTON = MouseInput.FORWARD_BUTTON
LEFT_BUTTON = MouseInput.LEFT_BUTTON
MIDDLE_BUTTON = MouseInput.MIDDLE_BUTTON
MOVE_DOWN = MouseInput.MOVE_DOWN
MOVE_LEFT = MouseInput.MOVE_LEFT
MOVE_RIGHT = MouseInput.MOVE_RIGHT
MOVE_UP = MouseInput.MOVE_UP
RIGHT_BUTTON = MouseInput.RIGHT_BUTTON
SCROLL_DOWN = MouseInput.SCROLL_DOWN
SCROLL_LEFT = MouseInput.SCROLL_LEFT
SCROLL_RIGHT = MouseInput.SCROLL_RIGHT
SCROLL_UP = MouseInput.SCROLL_UP
property name

handle) -> str

Type

(self

carb.input.acquire_input_interface(plugin_name: str = None, library_path: str = None) → carb::input::IInput
carb.input.acquire_input_provider(plugin_name: str = None, library_path: str = None) → carb::input::InputProvider
carb.input.get_action_mapping_desc_from_string(arg0: str)tuple
carb.input.get_string_from_action_mapping_desc(*args, **kwargs)

Overloaded function.

  1. get_string_from_action_mapping_desc(arg0: carb.input.KeyboardInput, arg1: int) -> str

  2. get_string_from_action_mapping_desc(arg0: carb.input.MouseInput, arg1: int) -> str

  3. get_string_from_action_mapping_desc(arg0: carb.input.GamepadInput) -> str