event.h File Reference

SDL2/libtcod event compatibility tools. More...

#include "../console_types.h"
#include "../mouse.h"
#include "../sys.h"

Go to the source code of this file.

Namespaces
namespace	tcod
	The libtcod namespace.

Functions
TCOD_event_t	tcod::sdl2::process_event (const union SDL_Event &in, TCOD_key_t &out) noexcept
	Parse an SDL_Event into a key event and return the relevant TCOD_event_t.
TCOD_event_t	tcod::sdl2::process_event (const union SDL_Event &in, TCOD_mouse_t &out) noexcept
	Parse an SDL_Event into a mouse event and return the relevant TCOD_event_t.
TCOD_event_t	TCOD_sys_process_key_event (const union SDL_Event *in, TCOD_key_t *out)
	Parse an SDL_Event into a key event and return the relevant TCOD_event_t.
TCOD_event_t	TCOD_sys_process_mouse_event (const union SDL_Event *in, TCOD_mouse_t *out)
	Parse an SDL_Event into a mouse event and return the relevant TCOD_event_t.

Detailed Description

SDL2/libtcod event compatibility tools.

Function Documentation

process_event() [1/2]

TCOD_event_t tcod::sdl2::process_event ( const union SDL_Event & in, TCOD_key_t & out )

noexcept

Parse an SDL_Event into a key event and return the relevant TCOD_event_t.

Returns TCOD_EVENT_NONE if the event wasn't keyboard related.

embed:rst:leading-asterisk 
*  .. versionadded:: 1.11
*  

process_event() [2/2]

TCOD_event_t tcod::sdl2::process_event ( const union SDL_Event & in, TCOD_mouse_t & out )

noexcept

Parse an SDL_Event into a mouse event and return the relevant TCOD_event_t.

Returns TCOD_EVENT_NONE if the event wasn't mouse related.

embed:rst:leading-asterisk 
*  .. versionadded:: 1.11
*  

TCOD_sys_process_key_event()

TCOD_event_t TCOD_sys_process_key_event	(	const union SDL_Event *	in,
		TCOD_key_t *	out )

Parse an SDL_Event into a key event and return the relevant TCOD_event_t.

Returns TCOD_EVENT_NONE if the event wasn't keyboard related.

embed:rst:leading-asterisk 
*  .. versionadded:: 1.11
*  

TCOD_sys_process_mouse_event()

TCOD_event_t TCOD_sys_process_mouse_event	(	const union SDL_Event *	in,
		TCOD_mouse_t *	out )

Parse an SDL_Event into a mouse event and return the relevant TCOD_event_t.

Returns TCOD_EVENT_NONE if the event wasn't mouse related.

embed:rst:leading-asterisk 
*  .. versionadded:: 1.11
*