summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHampusM <hampus@hampusmat.com>2024-05-25 00:09:56 +0200
committerHampusM <hampus@hampusmat.com>2024-05-25 00:09:56 +0200
commit0f968b0812ecfd09395bfef5c2cab3663b61c387 (patch)
tree73bb039104da54d5dec2c6d7058c5caef33f71da
parent8a2c86e282673edb472a6ea0221c1b1af2de1c04 (diff)
docs(glfw): add documentation comments to Hint variants
-rw-r--r--glfw/src/window.rs14
1 files changed, 14 insertions, 0 deletions
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,
}