gumball_controller.h File Reference

Go to the source code of this file.

Macros
#define	GUM_Controller_create(...)
Type System
Type UUID and cast operators
#define	GUM_CONTROLLER_TYPE
#define	GUM_CONTROLLER(self)
#define	GUM_CONTROLLER_CLASS(klass)
#define	GUM_CONTROLLER_CLASSOF(self)

Enumerations
enum	GUM_CONTROLLER_BUTTON_STATE : uint8_t
enum	GUM_CONTROLLER_BUTTON_ID : uint8_t

Functions
GBL_EXPORT void	GUM_Controller_sendButton (GBL_SELF, GUM_CONTROLLER_BUTTON_STATE state, GUM_CONTROLLER_BUTTON_ID button) GBL_NOEXCEPT
GBL_EXPORT void	GUM_Controller_setSelectedButton (GBL_SELF, GUM_Button *pButton) GBL_NOEXCEPT

Variables
Properties
Properties you can set/get at or after creation. Note You can also set/get properties from parent classes (see GUM_Controller).
uint8_t	controllerId
bool	isKeyboard

Detailed Description

GUM_Controller data structure and hierarchy graph

GUM_Controller is responsible for handling input from gamepads and/or keyboards, and drawing a border around the currently selected button. Each controller is associated with a specific player id, allowing you to have multiple controllers at once.

Todo

• Handle multiple controllers on the same button
• Make pSelectedButton a property
• Make variables private
• Deprecate GUM_Controller_setSelectedButton once GUM_Property is implemented

Author

2025 Agustín Bellagamba

Copyright

MIT License

Macro Definition Documentation

GUM_CONTROLLER_TYPE

#define GUM_CONTROLLER_TYPE

Returns the GUM_Controller Type UUID.

GUM_CONTROLLER

#define GUM_CONTROLLER

(

self

)

Casts an instance of a compatible element to a GUM_Controller.

GUM_CONTROLLER_CLASS

#define GUM_CONTROLLER_CLASS

(

klass

)

Casts a class of a compatible element to a GUM_ControllerClass.

GUM_CONTROLLER_CLASSOF

#define GUM_CONTROLLER_CLASSOF

(

self

)

Casts an instance of a compatible element to a GUM_ControllerClass.

Enumeration Type Documentation

GUM_CONTROLLER_BUTTON_STATE

enum GUM_CONTROLLER_BUTTON_STATE : uint8_t

             : uint8_t {
    GUM_CONTROLLER_BUTTON_PRESS,
    GUM_CONTROLLER_BUTTON_RELEASE
} GUM_CONTROLLER_BUTTON_STATE;

GUM_CONTROLLER_BUTTON_ID

enum GUM_CONTROLLER_BUTTON_ID : uint8_t

             : uint8_t {
    GUM_CONTROLLER_UP,
    GUM_CONTROLLER_RIGHT,
    GUM_CONTROLLER_DOWN,
    GUM_CONTROLLER_LEFT,
    GUM_CONTROLLER_PRIMARY,
    GUM_CONTROLLER_SECONDARY,
    GUM_CONTROLLER_TERTIARY
} GUM_CONTROLLER_BUTTON_ID;

Function Documentation

GUM_Controller_sendButton()

GBL_EXPORT void GUM_Controller_sendButton	(	GBL_SELF	,
		GUM_CONTROLLER_BUTTON_STATE	state,
		GUM_CONTROLLER_BUTTON_ID	button )

Takes in a GUM_Controller, a GUM_CONTROLLER_BUTTON_STATE, and a GUM_CONTROLLER_BUTTON_ID.

Handles the event.

GUM_Controller_setSelectedButton()

GBL_EXPORT void GUM_Controller_setSelectedButton	(	GBL_SELF	,
		GUM_Button *	pButton )

Takes in a GUM_Controller, and sets its selected button to the passed GUM_Button.

Variable Documentation

controllerId

uint8_t controllerId

Which id is this controller associated with.

Default value is 0

isKeyboard

bool isKeyboard

If the controller is a keyboard.

Default value is false