key_pressed()

MAYAFLUX_API Vruta::Event MayaFlux::Kriya::key_pressed	(	std::shared_ptr< Core::Window >	window,
		IO::Keys	key,
		std::function< void()>	callback
	)

Creates an Event coroutine that triggers on specific key press.

Parameters

window	Window to listen to
key	The key to wait for
callback	Function to call on key press

Returns

Event coroutine that can be added to EventManager

Example:

auto task = on_key_pressed(window, IO::Keys::Escape,
    []() {
        // Handle Escape key press
    });

Definition at line 10 of file InputEvents.cpp.

{
    auto& promise = co_await GetEventPromise {};
    auto& source = window->get_event_source();
 
    Vruta::WindowEventFilter filter;
    filter.event_type = Core::WindowEventType::KEY_PRESSED;
    filter.key_code = key;
 
    while (true) {
        if (promise.should_terminate) {
            break;
        }
 
        co_await WindowEventAwaiter(source, filter);
        callback();
    }
}

References callback, MayaFlux::Vruta::WindowEventFilter::event_type, MayaFlux::Vruta::WindowEventFilter::key_code, MayaFlux::Core::KEY_PRESSED, and window.

Referenced by MayaFlux::Nexus::Wiring::finalise(), MayaFlux::on_key_pressed(), and MayaFlux::Portal::Forma::Context::on_press().

Here is the caller graph for this function: