From 0f968b0812ecfd09395bfef5c2cab3663b61c387 Mon Sep 17 00:00:00 2001 From: HampusM Date: Sat, 25 May 2024 00:09:56 +0200 Subject: docs(glfw): add documentation comments to Hint variants --- glfw/src/window.rs | 14 ++++++++++++++ 1 file changed, 14 insertions(+) (limited to 'glfw/src') diff --git a/glfw/src/window.rs b/glfw/src/window.rs index ca712a9..9a15796 100644 --- a/glfw/src/window.rs +++ b/glfw/src/window.rs @@ -442,8 +442,22 @@ impl Builder #[non_exhaustive] pub enum Hint { + /// Specifies whether the OpenGL context should be created in debug mode, which may + /// provide additional error and diagnostic reporting functionality. + /// + /// Valid values are [`HintValue::Bool`]. OpenGLDebugContext = crate::ffi::GLFW_OPENGL_DEBUG_CONTEXT, + + /// Specifies the desired number of samples to use for multisampling. Zero disables + /// multisampling. + /// + /// Valid values are: [`HintValue::Number`]. Samples = crate::ffi::GLFW_SAMPLES, + + /// Specifies whether the framebuffer should be double buffered. You nearly always + /// want to use double buffering. This is a hard constraint. + /// + /// Valid values are [`HintValue::Bool`]. DoubleBuffer = crate::ffi::GLFW_DOUBLEBUFFER, } -- cgit v1.2.3-18-g5258