From 0af761d046b19ec1d6759a5b3f021a959a3fc6f5 Mon Sep 17 00:00:00 2001 From: Stephen Gutekanst Date: Sat, 17 Jul 2021 17:23:01 -0700 Subject: [PATCH] glfw: clarify Monitor.setCallback docs Signed-off-by: Stephen Gutekanst --- glfw/src/Monitor.zig | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/glfw/src/Monitor.zig b/glfw/src/Monitor.zig index be3c79b8..4c42f2e2 100644 --- a/glfw/src/Monitor.zig +++ b/glfw/src/Monitor.zig @@ -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.