[go: up one dir, main page]

glfwIconifyWindow

Function glfwIconifyWindow 

Source
pub unsafe extern "C" fn glfwIconifyWindow(window: *mut GLFWwindow)
Expand description

@brief Iconifies the specified window.

This function iconifies (minimizes) the specified window if it was previously restored. If the window is already iconified, this function does nothing.

If the specified window is a full screen window, GLFW restores the original video mode of the monitor. The window’s desired video mode is set again when the window is restored.

@param[in] window The window to iconify.

@errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref GLFW_PLATFORM_ERROR.

@remark @wayland Once a window is iconified, @ref glfwRestoreWindow won’t be able to restore it. This is a design decision of the xdg-shell protocol.

@thread_safety This function must only be called from the main thread.

@sa @ref window_iconify @sa @ref glfwRestoreWindow @sa @ref glfwMaximizeWindow

@since Added in version 2.1. @glfw3 Added window handle parameter.

@ingroup window