falsepattern/zig-glfw
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

glfw: add Window.setCloseCallback

Browse source 
Signed-off-by: Stephen Gutekanst <stephen@hexops.com>
This commit is contained in:
Stephen Gutekanst 2021-10-18 00:15:14 -07:00 • committed by Stephen Gutekanst
parent 1c7196e0c2
commit 5e154a0ffa
1 changed files with 59 additions and 70 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

129
src/Window.zig
View file

@ -38,6 +38,7 @@ pub const InternalUserPointer = struct {
// Callbacks to be invoked by wrapper functions. // Callbacks to be invoked by wrapper functions.
setPosCallback: ?fn (window: Window, xpos: isize, ypos: isize) void, setPosCallback: ?fn (window: Window, xpos: isize, ypos: isize) void,
setSizeCallback: ?fn (window: Window, width: isize, height: isize) void, setSizeCallback: ?fn (window: Window, width: isize, height: isize) void,
setCloseCallback: ?fn (window: Window) void,
}; };
/// Resets all window hints to their default values. /// Resets all window hints to their default values.
@ -817,21 +818,6 @@ pub inline fn swapBuffers(self: Window) Error!void {
// TODO(window): // TODO(window):
// /// The function pointer type for window close callbacks.
// ///
// /// This is the function pointer type for window close callbacks. A window
// /// close callback function has the following signature:
// /// @code
// /// void function_name(GLFWwindow* window)
// /// @endcode
// ///
// /// @param[in] window The window that the user attempted to close.
// ///
// /// see also: window_close, glfw.Window.setCloseCallback
// ///
// /// @glfw3 Added window handle parameter.
// typedef void (* GLFWwindowclosefun)(GLFWwindow*);
// /// The function pointer type for window content refresh callbacks. // /// The function pointer type for window content refresh callbacks.
// /// // ///
// /// This is the function pointer type for window content refresh callbacks. // /// This is the function pointer type for window content refresh callbacks.
@ -1153,43 +1139,45 @@ pub inline fn setSizeCallback(self: Window, callback: ?fn (window: Window, width
getError() catch {}; getError() catch {};
} }
// TODO(window): fn setCloseCallbackWrapper(handle: ?*c.GLFWwindow) callconv(.C) void {
const window = from(handle.?) catch unreachable;
const internal = window.getInternal();
internal.setCloseCallback.?(window);
}
// /// Sets the close callback for the specified window. /// Sets the close callback for the specified window.
// /// ///
// /// This function sets the close callback of the specified window, which is /// This function sets the close callback of the specified window, which is called when the user
// /// called when the user attempts to close the window, for example by clicking /// attempts to close the window, for example by clicking the close widget in the title bar.
// /// the close widget in the title bar. ///
// /// /// The close flag is set before this callback is called, but you can modify it at any time with
// /// The close flag is set before this callback is called, but you can modify it /// glfw.Window.setShouldClose.
// /// at any time with @ref glfwSetWindowShouldClose. ///
// /// /// The close callback is not triggered by glfw.Window.destroy.
// /// The close callback is not triggered by @ref glfwDestroyWindow. ///
// /// /// @param[in] window The window whose callback to set.
// /// @param[in] window The window whose callback to set. /// @param[in] callback The new callback, or null to remove the currently set callback.
// /// @param[in] callback The new callback, or null to remove the currently set ///
// /// callback. /// @callback_param `window` the window that the user attempted to close.
// /// @return The previously set callback, or null if no callback was set or the ///
// /// library had not been [initialized](@ref intro_init). /// macos: Selecting Quit from the application menu will trigger the close callback for all
// /// /// windows.
// /// @callback_signature ///
// /// @code /// @thread_safety This function must only be called from the main thread.
// /// void function_name(GLFWwindow* window) ///
// /// @endcode /// see also: window_close
// /// For more information about the callback parameters, see the pub inline fn setCloseCallback(self: Window, callback: ?fn (window: Window) void) void {
// /// [function pointer type](@ref GLFWwindowclosefun). var internal = self.getInternal();
// /// internal.setCloseCallback = callback;
// /// Possible errors include glfw.Error.NotInitialized. _ = c.glfwSetWindowCloseCallback(self.handle, if (callback != null) setCloseCallbackWrapper else null);
// ///
// /// macos: Selecting Quit from the application menu will trigger the // The only error this could return would be glfw.Error.NotInitialized, which should
// /// close callback for all windows. // definitely have occurred before calls to this. Returning an error here makes the API
// /// // awkward to use, so we discard it instead.
// /// @thread_safety This function must only be called from the main thread. getError() catch {};
// /// }
// /// see also: window_close
// /// // TODO(window):
// /// @glfw3 Added window handle parameter and return value.
// GLFWAPI GLFWwindowclosefun glfwSetWindowCloseCallback(GLFWwindow* window, GLFWwindowclosefun callback);
// /// Sets the refresh callback for the specified window. // /// Sets the refresh callback for the specified window.
// /// // ///
@ -1214,13 +1202,9 @@ pub inline fn setSizeCallback(self: Window, callback: ?fn (window: Window, width
// /// For more information about the callback parameters, see the // /// For more information about the callback parameters, see the
// /// [function pointer type](@ref GLFWwindowrefreshfun). // /// [function pointer type](@ref GLFWwindowrefreshfun).
// /// // ///
// /// Possible errors include glfw.Error.NotInitialized.
// ///
// /// @thread_safety This function must only be called from the main thread. // /// @thread_safety This function must only be called from the main thread.
// /// // ///
// /// see also: window_refresh // /// see also: window_refresh
// ///
// /// @glfw3 Added window handle parameter and return value.
// GLFWAPI GLFWwindowrefreshfun glfwSetWindowRefreshCallback(GLFWwindow* window, GLFWwindowrefreshfun callback); // GLFWAPI GLFWwindowrefreshfun glfwSetWindowRefreshCallback(GLFWwindow* window, GLFWwindowrefreshfun callback);
// /// Sets the focus callback for the specified window. // /// Sets the focus callback for the specified window.
@ -1246,12 +1230,9 @@ pub inline fn setSizeCallback(self: Window, callback: ?fn (window: Window, width
// /// For more information about the callback parameters, see the // /// For more information about the callback parameters, see the
// /// [function pointer type](@ref GLFWwindowfocusfun). // /// [function pointer type](@ref GLFWwindowfocusfun).
// /// // ///
// /// Possible errors include glfw.Error.NotInitialized.
// ///
// /// @thread_safety This function must only be called from the main thread. // /// @thread_safety This function must only be called from the main thread.
// /// // ///
// /// see also: window_focus // /// see also: window_focus
// ///
// GLFWAPI GLFWwindowfocusfun glfwSetWindowFocusCallback(GLFWwindow* window, GLFWwindowfocusfun callback); // GLFWAPI GLFWwindowfocusfun glfwSetWindowFocusCallback(GLFWwindow* window, GLFWwindowfocusfun callback);
// /// Sets the iconify callback for the specified window. // /// Sets the iconify callback for the specified window.
@ -1272,15 +1253,12 @@ pub inline fn setSizeCallback(self: Window, callback: ?fn (window: Window, width
// /// For more information about the callback parameters, see the // /// For more information about the callback parameters, see the
// /// [function pointer type](@ref GLFWwindowiconifyfun). // /// [function pointer type](@ref GLFWwindowiconifyfun).
// /// // ///
// /// Possible errors include glfw.Error.NotInitialized.
// ///
// /// wayland: The wl_shell protocol has no concept of iconification, // /// wayland: The wl_shell protocol has no concept of iconification,
// /// this callback will never be called when using this deprecated protocol. // /// this callback will never be called when using this deprecated protocol.
// /// // ///
// /// @thread_safety This function must only be called from the main thread. // /// @thread_safety This function must only be called from the main thread.
// /// // ///
// /// see also: window_iconify // /// see also: window_iconify
// ///
// GLFWAPI GLFWwindowiconifyfun glfwSetWindowIconifyCallback(GLFWwindow* window, GLFWwindowiconifyfun callback); // GLFWAPI GLFWwindowiconifyfun glfwSetWindowIconifyCallback(GLFWwindow* window, GLFWwindowiconifyfun callback);
// /// Sets the maximize callback for the specified window. // /// Sets the maximize callback for the specified window.
@ -1301,12 +1279,9 @@ pub inline fn setSizeCallback(self: Window, callback: ?fn (window: Window, width
// /// For more information about the callback parameters, see the // /// For more information about the callback parameters, see the
// /// [function pointer type](@ref GLFWwindowmaximizefun). // /// [function pointer type](@ref GLFWwindowmaximizefun).
// /// // ///
// /// Possible errors include glfw.Error.NotInitialized.
// ///
// /// @thread_safety This function must only be called from the main thread. // /// @thread_safety This function must only be called from the main thread.
// /// // ///
// /// see also: window_maximize // /// see also: window_maximize
// ///
// GLFWAPI GLFWwindowmaximizefun glfwSetWindowMaximizeCallback(GLFWwindow* window, GLFWwindowmaximizefun callback); // GLFWAPI GLFWwindowmaximizefun glfwSetWindowMaximizeCallback(GLFWwindow* window, GLFWwindowmaximizefun callback);
// /// Sets the framebuffer resize callback for the specified window. // /// Sets the framebuffer resize callback for the specified window.
@ -1327,12 +1302,9 @@ pub inline fn setSizeCallback(self: Window, callback: ?fn (window: Window, width
// /// For more information about the callback parameters, see the // /// For more information about the callback parameters, see the
// /// [function pointer type](@ref GLFWframebuffersizefun). // /// [function pointer type](@ref GLFWframebuffersizefun).
// /// // ///
// /// Possible errors include glfw.Error.NotInitialized.
// ///
// /// @thread_safety This function must only be called from the main thread. // /// @thread_safety This function must only be called from the main thread.
// /// // ///
// /// see also: window_fbsize // /// see also: window_fbsize
// ///
// GLFWAPI GLFWframebuffersizefun glfwSetFramebufferSizeCallback(GLFWwindow* window, GLFWframebuffersizefun callback); // GLFWAPI GLFWframebuffersizefun glfwSetFramebufferSizeCallback(GLFWwindow* window, GLFWframebuffersizefun callback);
// /// Sets the window content scale callback for the specified window. // /// Sets the window content scale callback for the specified window.
@ -1353,12 +1325,9 @@ pub inline fn setSizeCallback(self: Window, callback: ?fn (window: Window, width
// /// For more information about the callback parameters, see the // /// For more information about the callback parameters, see the
// /// [function pointer type](@ref GLFWwindowcontentscalefun). // /// [function pointer type](@ref GLFWwindowcontentscalefun).
// /// // ///
// /// Possible errors include glfw.Error.NotInitialized.
// ///
// /// @thread_safety This function must only be called from the main thread. // /// @thread_safety This function must only be called from the main thread.
// /// // ///
// /// see also: window_scale, glfw.Window.getContentScale // /// see also: window_scale, glfw.Window.getContentScale
// ///
// GLFWAPI GLFWwindowcontentscalefun glfwSetWindowContentScaleCallback(GLFWwindow* window, GLFWwindowcontentscalefun callback); // GLFWAPI GLFWwindowcontentscalefun glfwSetWindowContentScaleCallback(GLFWwindow* window, GLFWwindowcontentscalefun callback);
test "defaultHints" { test "defaultHints" {
@ -1946,3 +1915,23 @@ test "setSizeCallback" {
} }
}).callback); }).callback);
} }
test "setCloseCallback" {
const glfw = @import("main.zig");
try glfw.init();
defer glfw.terminate();
const window = glfw.Window.create(640, 480, "Hello, Zig!", null, null) catch |err| {
// return without fail, because most of our CI environments are headless / we cannot open
// windows on them.
std.debug.print("note: failed to create window: {}\n", .{err});
return;
};
defer window.destroy();
window.setCloseCallback((struct {
fn callback(_window: Window) void {
_ = _window;
}
}).callback);
}