From 0fa783372beb0147121c96c83144a52c0f21a0c7 Mon Sep 17 00:00:00 2001
From: Andreas Reich <r_andreas2@web.de>
Date: Sun, 10 Nov 2024 10:19:16 +0100
Subject: [PATCH] document compatible_surface requirement for WebGL directly on
 wgt::RequestAdapterOptions

---
 wgpu-types/src/lib.rs | 1 +
 1 file changed, 1 insertion(+)

diff --git a/wgpu-types/src/lib.rs b/wgpu-types/src/lib.rs
index 92ff6da74..34f871dcd 100644
--- a/wgpu-types/src/lib.rs
+++ b/wgpu-types/src/lib.rs
@@ -221,6 +221,7 @@ pub struct RequestAdapterOptions<S> {
     pub force_fallback_adapter: bool,
     /// Surface that is required to be presentable with the requested adapter. This does not
     /// create the surface, only guarantees that the adapter can present to said surface.
+    /// For WebGL, this is strictly required, as an adapter can not be created without a surface.
     pub compatible_surface: Option<S>,
 }