qmk_firmware/internals/programmable_button.md

group programmable_button

HID Programmable Buttons

Summary

Members	Descriptions
public void programmable_button_clear(void)	Clear the programmable button report.
public void programmable_button_add(uint8_t index)	Set the state of a button.
public void programmable_button_remove(uint8_t index)	Reset the state of a button.
public void programmable_button_register(uint8_t index)	Set the state of a button, and flush the report.
public void programmable_button_unregister(uint8_t index)	Reset the state of a button, and flush the report.
public bool programmable_button_is_on(uint8_t index)	Get the state of a button.
public void programmable_button_flush(void)	Send the programmable button report to the host.
public uint32_t programmable_button_get_report(void)	Get the programmable button report.
public void programmable_button_set_report(uint32_t report)	Set the programmable button report.

Members

public void programmable_button_clear(void)

Clear the programmable button report.

public void programmable_button_add(uint8_t index)

Set the state of a button.

Parameters

• index The index of the button to press, from 0 to 31.

public void programmable_button_remove(uint8_t index)

Reset the state of a button.

Parameters

• index The index of the button to release, from 0 to 31.

public void programmable_button_register(uint8_t index)

Set the state of a button, and flush the report.

Parameters

• index The index of the button to press, from 0 to 31.

public void programmable_button_unregister(uint8_t index)

Reset the state of a button, and flush the report.

Parameters

• index The index of the button to release, from 0 to 31.

public bool programmable_button_is_on(uint8_t index)

Get the state of a button.

Parameters

• index The index of the button to check, from 0 to 31.

Returns

true if the button is pressed.

public void programmable_button_flush(void)

Send the programmable button report to the host.

public uint32_t programmable_button_get_report(void)

Get the programmable button report.

Returns

The bitmask of programmable button states.

public void programmable_button_set_report(uint32_t report)

Set the programmable button report.

Parameters

• report A bitmask of programmable button states.