libretro.drivers.message.driver

Protocol definition for the message driver interface.

See also

libretro.api.message

Provides the message types that MessageDriver implementations display or log.

Classes

MessageDriver

Protocol for drivers that handle on-screen or logged messages sent by the core.

class MessageDriver

Bases: Protocol

Protocol for drivers that handle on-screen or logged messages sent by the core.

Cores deliver messages via RETRO_ENVIRONMENT_SET_MESSAGE or RETRO_ENVIRONMENT_SET_MESSAGE_EXT.

See also

libretro.api.message

The message types delivered to implementations of this protocol.

abstract property version

The message-interface version supported by this driver.

0 supports only retro_message. 1 additionally supports retro_message_ext.

abstractmethod set_message(message)

Delivers a message from the core.

Corresponds to the RETRO_ENVIRONMENT_SET_MESSAGE and RETRO_ENVIRONMENT_SET_MESSAGE_EXT environment calls.

Parameters:

message (retro_message | retro_message_ext | None) – The message to display or log, or None.

Return type:

bool

Returns:

True if the message was accepted.

See also

retro_message

The legacy message struct delivered via RETRO_ENVIRONMENT_SET_MESSAGE.

retro_message_ext

The extended message struct delivered via RETRO_ENVIRONMENT_SET_MESSAGE_EXT.

__init__(*args, **kwargs)

classmethod __new__(*args, **kwargs)