> home > Custom Layer Boundary API

get_next_input

January 19th 2020
In a view context, yield control to the core until new input is sent to this view, then return that input

Signature

C++
User_Input
get_next_input(Application_Links* app,
               Event_Property get_properties,
               Event_Property abort_properties);

Parameters

app

the standard custom layer context pointer

get_properties

flags for properties of an event that should be allowed to be returned from this call

abort_properties

flags for properties of an event that should be converted into abort events before returning from this call

Return

the next input that is sent to this view context, or cleared to zero if this is not a view context thread

Details

This works as a blocking call on it's thread, blocking until the core has more input. However it only works in view context threads. View context threads are created by the core whenever a view is created, and has the primary responsibility of dispatching user input and other events. The base of view context threads is determined by HookID_ViewEventHandler.

Related

User_Input