zig/mach
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

glfw: clarify Monitor.setCallback docs

Browse source 
Signed-off-by: Stephen Gutekanst <stephen@hexops.com>
This commit is contained in:
Stephen Gutekanst 2021-07-17 17:23:01 -07:00
parent c5b89fef2e
commit 0af761d046
1 changed files with 7 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

10
glfw/src/Monitor.zig
View file

@ -235,13 +235,17 @@ var callback_data_ptr: ?usize = undefined;
/// This is called when a monitor is connected to or disconnected from the system. Example:
///
/// ```
/// fn monitorCallback(monitor: glfw.Monitor, event: ) callconv(.C) void {
/// // use monitor, set/get user data via monitor.setUserPointer, etc.
/// fn monitorCallback(monitor: glfw.Monitor, event: usize, data: *MyData) void {
/// // data is the pointer you passed into setCallback.
/// // event is one of glfw.connected or glfw.disconnected
/// }
/// ...
/// glfw.Monitor.setCallback(monitorCallback)
/// glfw.Monitor.setCallback(MyData, &myData, monitorCallback)
/// ```
///
/// `event` may be one of glfw.connected or glfw.disconnected. More events may be added in the
/// future.
///
/// Possible errors include glfw.Error.NotInitialized.
///
/// @thread_safety This function must only be called from the main thread.