Utilities for querying user input. More...

Enumerations
enum	AERInputKey { AER_KEY_INTERRUPT = 0x3 , AER_KEY_BACKSPACE = 0x8 , AER_KEY_TAB = 0x9 , AER_KEY_ERASE_AFTER = 0xb , AER_KEY_CLEAR = 0xc , AER_KEY_ENTER = 0xd , AER_KEY_CAPSLOCK = 0x14 , AER_KEY_ERASE = 0x15 , AER_KEY_ERASE_BEFORE = 0x15 , AER_KEY_ESCAPE = 0x1b , AER_KEY_SPACE = 0x20 , AER_KEY_PAGEUP = 0x21 , AER_KEY_EXCLAIM = 0x21 , AER_KEY_PAGEDOWN = 0x22 , AER_KEY_QUOTE = 0x22 , AER_KEY_END = 0x23 , AER_KEY_HOME = 0x24 , AER_KEY_DOLLAR = 0x24 , AER_KEY_LARROW = 0x25 , AER_KEY_PERCENT = 0x25 , AER_KEY_UARROW = 0x26 , AER_KEY_AMP = 0x26 , AER_KEY_RARROW = 0x27 , AER_KEY_DARROW = 0x28 , AER_KEY_LPAREN = 0x28 , AER_KEY_RPAREN = 0x29 , AER_KEY_ASTERISK = 0x2a , AER_KEY_PLUS = 0x2b , AER_KEY_INSERT = 0x2d , AER_KEY_DELETE = 0x2e , AER_KEY_0 = 0x30 , AER_KEY_1 = 0x31 , AER_KEY_2 = 0x32 , AER_KEY_3 = 0x33 , AER_KEY_4 = 0x34 , AER_KEY_5 = 0x35 , AER_KEY_6 = 0x36 , AER_KEY_7 = 0x37 , AER_KEY_8 = 0x38 , AER_KEY_9 = 0x39 , AER_KEY_COLON = 0x3a , AER_KEY_LESS = 0x3c , AER_KEY_GREATER = 0x3e , AER_KEY_QUERY = 0x3f , AER_KEY_AT = 0x40 , AER_KEY_A = 0x41 , AER_KEY_B = 0x42 , AER_KEY_C = 0x43 , AER_KEY_D = 0x44 , AER_KEY_E = 0x45 , AER_KEY_F = 0x46 , AER_KEY_G = 0x47 , AER_KEY_H = 0x48 , AER_KEY_I = 0x49 , AER_KEY_J = 0x4a , AER_KEY_K = 0x4b , AER_KEY_L = 0x4c , AER_KEY_M = 0x4d , AER_KEY_N = 0x4e , AER_KEY_O = 0x4f , AER_KEY_P = 0x50 , AER_KEY_Q = 0x51 , AER_KEY_R = 0x52 , AER_KEY_S = 0x53 , AER_KEY_T = 0x54 , AER_KEY_U = 0x55 , AER_KEY_V = 0x56 , AER_KEY_W = 0x57 , AER_KEY_X = 0x58 , AER_KEY_Y = 0x59 , AER_KEY_Z = 0x5a , AER_KEY_CARET = 0x5e , AER_KEY_UNDERSCORE = 0x5f , AER_KEY_NUM0 = 0x60 , AER_KEY_NUM1 = 0x61 , AER_KEY_NUM2 = 0x62 , AER_KEY_NUM3 = 0x63 , AER_KEY_NUM4 = 0x64 , AER_KEY_NUM5 = 0x65 , AER_KEY_NUM6 = 0x66 , AER_KEY_NUM7 = 0x67 , AER_KEY_NUM8 = 0x68 , AER_KEY_NUM9 = 0x69 , AER_KEY_NUMASTERISK = 0x6a , AER_KEY_NUMPLUS = 0x6b , AER_KEY_NUMMINUS = 0x6d , AER_KEY_NUMPERIOD = 0x6e , AER_KEY_NUMSLASH = 0x6f , AER_KEY_F1 = 0x70 , AER_KEY_F2 = 0x71 , AER_KEY_F3 = 0x72 , AER_KEY_F4 = 0x73 , AER_KEY_F5 = 0x74 , AER_KEY_F6 = 0x75 , AER_KEY_F7 = 0x76 , AER_KEY_F8 = 0x77 , AER_KEY_F9 = 0x78 , AER_KEY_F10 = 0x79 , AER_KEY_LCURLY = 0x7b , AER_KEY_VBAR = 0x7c , AER_KEY_RCURLY = 0x7d , AER_KEY_TILDE = 0x7e , AER_KEY_F11 = 0x80 , AER_KEY_F12 = 0x81 , AER_KEY_LSHIFT = 0xa0 , AER_KEY_RSHIFT = 0xa1 , AER_KEY_LCTRL = 0xa2 , AER_KEY_RCTRL = 0xa3 , AER_KEY_LALT = 0xa4 , AER_KEY_RALT = 0xa5 , AER_KEY_SEMICOLON = 0xba , AER_KEY_EQUALS = 0xbb , AER_KEY_COMMA = 0xbc , AER_KEY_MINUS = 0xbd , AER_KEY_PERIOD = 0xbe , AER_KEY_SLASH = 0xbf , AER_KEY_APOS = 0xc0 , AER_KEY_LSQUARE = 0xdb , AER_KEY_BACKSLASH = 0xdc , AER_KEY_RSQUARE = 0xdd , AER_KEY_HASH = 0xde , AER_KEY_BACKTICK = 0xdf }
	Indexes for keypresses in input lookup table. More...

Functions
const bool *	AERInputGetKeysPressed (void)
	Query the keyboard key(s) that the user just pressed this step. More...

const bool *	AERInputGetKeysHeld (void)
	Query the keyboard key(s) that the user has held this step. More...

const bool *	AERInputGetKeysReleased (void)
	Query the keyboard key(s) that the user just released this step. More...

const bool *	AERInputGetMouseButtonsPressed (void)
	Query the mouse button(s) that the user just pressed this step. More...

const bool *	AERInputGetMouseButtonsHeld (void)
	Query the mouse button(s) that the user has held this step. More...

const bool *	AERInputGetMouseButtonsReleased (void)
	Query the mouse button(s) that the user just released this step. More...

void	AERInputGetMousePositionRaw (uint32_t x, uint32_t y)
	Query the current position of the mouse cursor in pixels relative to the game window. More...

void	AERInputGetMousePosition (uint32_t x, uint32_t y)
	This function is a deprecated alias for AERInputGetMousePositionRaw. More...

void	AERInputGetMousePositionVirtual (float x, float y)
	Query the current position of the mouse cursor in pixels relative to the current room. More...

Variables
const char	AER_DISPLAY_KEYS []
	Printable characters corresponding to input table indexes. More...

Detailed Description

Utilities for querying user input.

Since: 1.0.0

Copyright: 2021 the libaermre authors

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Enumeration Type Documentation

◆ AERInputKey

enum AERInputKey

Indexes for keypresses in input lookup table.

Since: 1.1.0

Enumerator
AER_KEY_ERASE_AFTER	Since 1.3.0
AER_KEY_CLEAR	Since 1.3.0
AER_KEY_ERASE	Deprecated: Since 1.3.0. Use AER_KEY_ERASE_BEFORE instead.
AER_KEY_ERASE_BEFORE	Since 1.3.0

Function Documentation

◆ AERInputGetKeysHeld()

const bool * AERInputGetKeysHeld ( void )

Query the keyboard key(s) that the user has held this step.

Returns: Lookup table mapping key-codes to held state or NULL if unsuccessful.

Exceptions

AER_SEQ_BREAK if called outside action stage.

Since: 1.0.0

See also: AERInputKey

◆ AERInputGetKeysPressed()

const bool * AERInputGetKeysPressed ( void )

Query the keyboard key(s) that the user just pressed this step.

Returns: Lookup table mapping key-codes to pressed state or NULL if unsuccessful.

Exceptions

AER_SEQ_BREAK if called outside action stage.

Since: 1.0.0

See also: AERInputKey

◆ AERInputGetKeysReleased()

const bool * AERInputGetKeysReleased ( void )

Query the keyboard key(s) that the user just released this step.

Returns: Lookup table mapping key-codes to released state or NULL if unsuccessful.

Exceptions

AER_SEQ_BREAK if called outside action stage.

Since: 1.0.0

See also: AERInputKey

◆ AERInputGetMouseButtonsHeld()

const bool * AERInputGetMouseButtonsHeld ( void )

Query the mouse button(s) that the user has held this step.

For more information about the mouse buttons, see Mouse Button States.

Returns: Array of mouse button held states or NULL if unsuccessful.

Exceptions

AER_SEQ_BREAK if called outside action stage.

Since: 1.0.0

◆ AERInputGetMouseButtonsPressed()

const bool * AERInputGetMouseButtonsPressed ( void )

Query the mouse button(s) that the user just pressed this step.

Mouse Button States

The array returned by this function has the following values.

Array Index	Mouse Button
`0`	Left
`1`	Right
`2`	Middle

Returns: Array of mouse button pressed states or NULL if unsuccessful.

Exceptions

AER_SEQ_BREAK if called outside action stage.

Since: 1.0.0

◆ AERInputGetMouseButtonsReleased()

const bool * AERInputGetMouseButtonsReleased ( void )

Query the mouse button(s) that the user just released this step.

For more information about the mouse buttons, see Mouse Button States.

Returns: Array of mouse button released states or NULL if unsuccessful.

Exceptions

AER_SEQ_BREAK if called outside action stage.

Since: 1.0.0

◆ AERInputGetMousePosition()

void AERInputGetMousePosition	(	uint32_t *	x,
		uint32_t *	y
	)

This function is a deprecated alias for AERInputGetMousePositionRaw.

Deprecated:: Since 1.3.0. Use AERInputGetMousePositionRaw instead.

Since: 1.0.0

See also: AERInputGetMousePositionRaw; AERInputGetMousePositionVirtual

◆ AERInputGetMousePositionRaw()

void AERInputGetMousePositionRaw	(	uint32_t *	x,
		uint32_t *	y
	)

Query the current position of the mouse cursor in pixels relative to the game window.

If only one component of the position is needed, then the argument for the unneeded component may be NULL.

Parameters

[out]	x	Horizontal position.
[out]	y	Vertical position.

Exceptions

AER_SEQ_BREAK	if called outside action stage.
AER_NULL_ARG	if both arguments `x` and `y` are `NULL`.

Since: 1.3.0

See also: AERInputGetMousePositionVirtual

◆ AERInputGetMousePositionVirtual()

void AERInputGetMousePositionVirtual	(	float *	x,
		float *	y
	)

Query the current position of the mouse cursor in pixels relative to the current room.

If only one component of the position is needed, then the argument for the unneeded component may be NULL.

Parameters

[out]	x	Horizontal position.
[out]	y	Vertical position.

Exceptions

AER_SEQ_BREAK	if called outside action stage.
AER_NULL_ARG	if both arguments `x` and `y` are `NULL`.

Since: 1.3.0

See also: AERInputGetMousePositionRaw

Variable Documentation

◆ AER_DISPLAY_KEYS

const char AER_DISPLAY_KEYS[]

extern

Printable characters corresponding to input table indexes.

Since: 1.1.0

Enumerations

Functions

Variables

Detailed Description

Enumeration Type Documentation

◆ AERInputKey

Function Documentation

◆ AERInputGetKeysHeld()

◆ AERInputGetKeysPressed()

◆ AERInputGetKeysReleased()

◆ AERInputGetMouseButtonsHeld()

◆ AERInputGetMouseButtonsPressed()

Mouse Button States

◆ AERInputGetMouseButtonsReleased()

◆ AERInputGetMousePosition()

◆ AERInputGetMousePositionRaw()

◆ AERInputGetMousePositionVirtual()

Variable Documentation

◆ AER_DISPLAY_KEYS