[go: up one dir, main page]

glfwSetWindowOpacity

Function glfwSetWindowOpacity 

Source
pub unsafe extern "C" fn glfwSetWindowOpacity(
    window: *mut GLFWwindow,
    opacity: f32,
)
Expand description

@brief Sets the opacity of the whole window.

This function sets the opacity of the window, including any decorations.

The opacity (or alpha) value is a positive finite number between zero and one, where zero is fully transparent and one is fully opaque.

The initial opacity value for newly created windows is one.

A window created with framebuffer transparency may not use whole window transparency. The results of doing this are undefined.

@param[in] window The window to set the opacity for. @param[in] opacity The desired opacity of the specified window.

@errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref GLFW_PLATFORM_ERROR and @ref GLFW_FEATURE_UNAVAILABLE (see remarks).

@remark @wayland There is no way to set an opacity factor for a window. This function will emit @ref GLFW_FEATURE_UNAVAILABLE.

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

@sa @ref window_transparency @sa @ref glfwGetWindowOpacity

@since Added in version 3.3.

@ingroup window