/* * Copyright (c) 2024-2025, Aliaksandr Kalenik * Copyright (c) 2024-2025, Luke Wilde * * SPDX-License-Identifier: BSD-2-Clause */ #include #include extern "C" { #include } #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include namespace Web::WebGL { WebGLRenderingContextBase::WebGLRenderingContextBase(JS::Realm& realm) : Bindings::PlatformObject(realm) { } struct Extension { Vector required_angle_extensions; JS::ThrowCompletionOr> (*factory)(JS::Realm&, GC::Ref); Optional only_for_webgl_version { OptionalNone {} }; }; static HashMap const& available_webgl_extensions() { static auto const& extensions = *new HashMap { // Khronos ratified WebGL Extensions { "ANGLE_instanced_arrays"_string, { { "GL_ANGLE_instanced_arrays"sv }, ANGLEInstancedArrays::create, WebGLVersion::WebGL1 } }, { "EXT_blend_minmax"_string, { { "GL_EXT_blend_minmax"sv }, EXTBlendMinMax::create, WebGLVersion::WebGL1 } }, { "EXT_frag_depth"_string, { { "GL_EXT_frag_depth"sv }, nullptr, WebGLVersion::WebGL1 } }, { "EXT_shader_texture_lod"_string, { { "GL_EXT_shader_texture_lod"sv }, nullptr, WebGLVersion::WebGL1 } }, { "EXT_texture_filter_anisotropic"_string, { { "GL_EXT_texture_filter_anisotropic"sv }, EXTTextureFilterAnisotropic::create } }, { "OES_element_index_uint"_string, { { "GL_OES_element_index_uint"sv }, OESElementIndexUint::create, WebGLVersion::WebGL1 } }, { "OES_standard_derivatives"_string, { { "GL_OES_standard_derivatives"sv }, OESStandardDerivatives::create, WebGLVersion::WebGL1 } }, { "OES_texture_float"_string, { { "GL_OES_texture_float"sv }, nullptr, WebGLVersion::WebGL1 } }, { "OES_texture_float_linear"_string, { { "GL_OES_texture_float_linear"sv }, nullptr } }, { "OES_texture_half_float"_string, { { "GL_OES_texture_half_float"sv }, nullptr, WebGLVersion::WebGL1 } }, { "OES_texture_half_float_linear"_string, { { "GL_OES_texture_half_float_linear"sv }, nullptr, WebGLVersion::WebGL1 } }, { "OES_vertex_array_object"_string, { { "GL_OES_vertex_array_object"sv }, OESVertexArrayObject::create, WebGLVersion::WebGL1 } }, { "WEBGL_compressed_texture_s3tc"_string, { { "GL_EXT_texture_compression_dxt1"sv, "GL_ANGLE_texture_compression_dxt3"sv, "GL_ANGLE_texture_compression_dxt5"sv }, WebGLCompressedTextureS3tc::create } }, { "WEBGL_debug_renderer_info"_string, { {}, WebGLDebugRendererInfo::create } }, { "WEBGL_debug_shaders"_string, { {}, nullptr } }, { "WEBGL_depth_texture"_string, { { "GL_ANGLE_depth_texture"sv }, nullptr, WebGLVersion::WebGL1 } }, { "WEBGL_draw_buffers"_string, { { "GL_EXT_draw_buffers"sv }, WebGLDrawBuffers::create, WebGLVersion::WebGL1 } }, { "WEBGL_lose_context"_string, { {}, nullptr } }, // Community approved WebGL Extensions { "EXT_clip_control"_string, { { "GL_EXT_clip_control"sv }, nullptr } }, { "EXT_color_buffer_float"_string, { { "GL_EXT_color_buffer_float"sv }, EXTColorBufferFloat::create, WebGLVersion::WebGL2 } }, { "EXT_color_buffer_half_float"_string, { { "GL_EXT_color_buffer_half_float"sv }, nullptr } }, { "EXT_conservative_depth"_string, { { "GL_EXT_conservative_depth"sv }, nullptr, WebGLVersion::WebGL2 } }, { "EXT_depth_clamp"_string, { { "GL_EXT_depth_clamp"sv }, nullptr } }, { "EXT_disjoint_timer_query"_string, { { "GL_EXT_disjoint_timer_query"sv }, nullptr, WebGLVersion::WebGL1 } }, { "EXT_disjoint_timer_query_webgl2"_string, { { "GL_EXT_disjoint_timer_query"sv }, nullptr, WebGLVersion::WebGL2 } }, { "EXT_float_blend"_string, { { "GL_EXT_float_blend"sv }, nullptr } }, { "EXT_polygon_offset_clamp"_string, { { "GL_EXT_polygon_offset_clamp"sv }, nullptr } }, { "EXT_render_snorm"_string, { { "GL_EXT_render_snorm"sv }, EXTRenderSnorm::create, WebGLVersion::WebGL2 } }, { "EXT_sRGB"_string, { { "GL_EXT_sRGB"sv }, nullptr, WebGLVersion::WebGL1 } }, { "EXT_texture_compression_bptc"_string, { { "GL_EXT_texture_compression_bptc"sv }, nullptr } }, { "EXT_texture_compression_rgtc"_string, { { "GL_EXT_texture_compression_rgtc"sv }, nullptr } }, { "EXT_texture_mirror_clamp_to_edge"_string, { { "GL_EXT_texture_mirror_clamp_to_edge"sv }, nullptr } }, { "EXT_texture_norm16"_string, { { "GL_EXT_texture_norm16"sv }, EXTTextureNorm16::create, WebGLVersion::WebGL2 } }, { "KHR_parallel_shader_compile"_string, { { "GL_KHR_parallel_shader_compile"sv }, nullptr } }, { "NV_shader_noperspective_interpolation"_string, { { "GL_NV_shader_noperspective_interpolation"sv }, nullptr, WebGLVersion::WebGL2 } }, { "OES_draw_buffers_indexed"_string, { { "GL_OES_draw_buffers_indexed"sv }, nullptr } }, { "OES_fbo_render_mipmap"_string, { { "GL_OES_fbo_render_mipmap"sv }, nullptr, WebGLVersion::WebGL1 } }, { "OES_sample_variables"_string, { { "GL_OES_sample_variables"sv }, nullptr, WebGLVersion::WebGL2 } }, { "OES_shader_multisample_interpolation"_string, { { "GL_OES_shader_multisample_interpolation"sv }, nullptr, WebGLVersion::WebGL2 } }, { "OVR_multiview2"_string, { { "GL_OVR_multiview2"sv }, nullptr, WebGLVersion::WebGL2 } }, { "WEBGL_blend_func_extended"_string, { { "GL_EXT_blend_func_extended"sv }, nullptr } }, { "WEBGL_clip_cull_distance"_string, { { "GL_EXT_clip_cull_distance"sv }, nullptr, WebGLVersion::WebGL2 } }, { "WEBGL_color_buffer_float"_string, { { "EXT_color_buffer_half_float"sv, "OES_texture_float"sv }, nullptr, WebGLVersion::WebGL1 } }, { "WEBGL_compressed_texture_astc"_string, { { "KHR_texture_compression_astc_hdr"sv, "KHR_texture_compression_astc_ldr"sv }, nullptr } }, { "WEBGL_compressed_texture_etc"_string, { { "GL_ANGLE_compressed_texture_etc"sv }, nullptr } }, { "WEBGL_compressed_texture_etc1"_string, { { "GL_OES_compressed_ETC1_RGB8_texture"sv }, nullptr } }, { "WEBGL_compressed_texture_pvrtc"_string, { { "GL_IMG_texture_compression_pvrtc"sv }, nullptr } }, { "WEBGL_compressed_texture_s3tc_srgb"_string, { { "GL_EXT_texture_compression_s3tc_srgb"sv }, WebGLCompressedTextureS3tcSrgb::create } }, { "WEBGL_multi_draw"_string, { { "GL_ANGLE_multi_draw"sv }, nullptr } }, { "WEBGL_polygon_mode"_string, { { "GL_ANGLE_polygon_mode"sv }, nullptr } }, { "WEBGL_provoking_vertex"_string, { { "GL_ANGLE_provoking_vertex"sv }, nullptr, WebGLVersion::WebGL2 } }, { "WEBGL_render_shared_exponent"_string, { { "GL_QCOM_render_shared_exponent"sv }, nullptr, WebGLVersion::WebGL2 } }, { "WEBGL_stencil_texturing"_string, { { "GL_ANGLE_stencil_texturing"sv }, nullptr, WebGLVersion::WebGL2 } }, }; return extensions; } Optional> WebGLRenderingContextBase::get_supported_extensions() { auto const& opengl_extensions = context().get_supported_opengl_extensions(); Vector webgl_extensions; for (auto const& [available_extension_name, available_extension_info] : available_webgl_extensions()) { bool supported = !available_extension_info.only_for_webgl_version.has_value() || context().webgl_version() == available_extension_info.only_for_webgl_version; if (!available_extension_info.factory && !HTML::UniversalGlobalScopeMixin::expose_experimental_interfaces()) { supported = false; } if (supported) { for (auto const& required_extension : available_extension_info.required_angle_extensions) { if (!opengl_extensions.contains_slow(required_extension)) { supported = false; break; } } } if (supported) webgl_extensions.append(available_extension_name); } return webgl_extensions; } JS::Object* WebGLRenderingContextBase::get_extension(String const& name) { // Returns an object if, and only if, name is an ASCII case-insensitive match [HTML] for one of the names returned // from getSupportedExtensions; otherwise, returns null. The object returned from getExtension contains any constants // or functions provided by the extension. A returned object may have no constants or functions if the extension does // not define any, but a unique object must still be returned. That object is used to indicate that the extension has // been enabled. auto supported_extensions = get_supported_extensions(); auto supported_extension_iterator = supported_extensions->find_if([&name](String const& supported_extension) { return supported_extension.equals_ignoring_ascii_case(name); }); if (supported_extension_iterator == supported_extensions->end()) return nullptr; auto maybe_extension = m_enabled_extensions.get(name); if (maybe_extension.has_value()) return maybe_extension.release_value(); // If we pass the check above this will always return a value auto const& extension_info = available_webgl_extensions().get(name).release_value(); if (!extension_info.factory) return nullptr; for (auto const& required_extension : extension_info.required_angle_extensions) { context().request_extension_angle(null_terminated_string(required_extension).data()); } auto extension = MUST(extension_info.factory(realm(), *this)); m_enabled_extensions.set(name, extension); return extension; } void WebGLRenderingContextBase::enable_compressed_texture_format(WebIDL::UnsignedLong format) { m_enabled_compressed_texture_formats.append(format); } void WebGLRenderingContextBase::visit_edges(Cell::Visitor& visitor) { Base::visit_edges(visitor); visitor.visit(m_enabled_extensions); } bool WebGLRenderingContextBase::extension_enabled(StringView extension) const { return m_enabled_extensions.contains(MUST(String::from_utf8(extension))); } ReadonlySpan WebGLRenderingContextBase::enabled_compressed_texture_formats() const { return m_enabled_compressed_texture_formats; } Optional WebGLRenderingContextBase::read_texture_image_source(TexImageSource const& source, WebIDL::UnsignedLong format, WebIDL::UnsignedLong type) { // FIXME: If this function is called with an ImageData whose data attribute has been neutered, // an INVALID_VALUE error is generated. // FIXME: If this function is called with an ImageBitmap that has been neutered, an INVALID_VALUE // error is generated. // FIXME: If this function is called with an HTMLImageElement or HTMLVideoElement whose origin // differs from the origin of the containing Document, or with an HTMLCanvasElement, // ImageBitmap or OffscreenCanvas whose bitmap's origin-clean flag is set to false, // a SECURITY_ERR exception must be thrown. See Origin Restrictions. // FIXME: If source is null then an INVALID_VALUE error is generated. auto frame = source.visit( [](GC::Ref source) -> Optional { return source->current_image_frame(); }, [](GC::Ref source) -> Optional { return Gfx::DecodedImageFrame { *source->get_bitmap_from_surface() }; }, [](GC::Ref source) -> Optional { return Gfx::DecodedImageFrame { *source->bitmap() }; }, [](GC::Ref source) -> Optional { return source->current_decoded_image_frame(); }, [](GC::Ref source) -> Optional { return Gfx::DecodedImageFrame { *source->bitmap() }; }, [](GC::Ref source) -> Optional { return Gfx::DecodedImageFrame { source->bitmap() }; }); if (!frame.has_value()) return OptionalNone {}; // Validate the combination before recording; the pixels travel to the host as shared // memory and the host performs the conversion next to GL. if (!texture_export_format(format, type).has_value()) return OptionalNone {}; // FIXME: Respect unpackColorSpace return TexImageSourceFrame { .frame = frame.release_value(), // The first pixel transferred from the source to the WebGL implementation corresponds to the upper left corner of // the source. This behavior is modified by the UNPACK_FLIP_Y_WEBGL pixel storage parameter, except for ImageBitmap // arguments, as described in the abovementioned section. .flip_y = m_unpack_flip_y && !source.has>(), .premultiply_alpha = m_unpack_premultiply_alpha, }; } // https://registry.khronos.org/webgl/specs/latest/1.0/#CONTEXT_LOST_WEBGL static constexpr GLenum CONTEXT_LOST_WEBGL = 0x9242; // TODO: The glGetError spec allows for queueing errors which is something we should probably do, for now // this just keeps track of one error which is also fine by the spec GLenum WebGLRenderingContextBase::get_error_value() { if (m_context_lost) { auto error = m_error; m_error = GL_NO_ERROR; return error; } if (auto local_error = context().take_pending_local_error(); local_error != GL_NO_ERROR) return local_error; auto context_error = context().get_error(); if (context_error != GL_NO_ERROR) return context_error; auto error = m_error; m_error = GL_NO_ERROR; return error; } void WebGLRenderingContextBase::set_error(GLenum error) { if (m_error == GL_NO_ERROR) m_error = error; } bool WebGLRenderingContextBase::is_context_lost() const { dbgln_if(WEBGL_CONTEXT_DEBUG, "WebGLRenderingContext::is_context_lost()"); return m_context_lost; } void WebGLRenderingContextBase::lose_context_from_compositor_loss() { if (m_context_lost) return; m_context_lost = true; context().set_lost(); // The next getError() must report CONTEXT_LOST_WEBGL (one-shot) per the spec. m_error = CONTEXT_LOST_WEBGL; HTML::queue_a_task(HTML::Task::Source::WebGL, nullptr, nullptr, GC::create_function(heap(), [this, canvas = canvas_for_binding()] { // webglcontextlost is cancelable; preventDefault() means the page wants the context // restored once a compositor is available again. m_context_restore_requested = !fire_webgl_context_event(canvas, EventNames::webglcontextlost); })); } void WebGLRenderingContextBase::restore_context_after_compositor_reconnect() { if (!m_context_lost || !m_context_restore_requested) return; // A fresh host context starts with no GL objects; per the spec the page re-creates them // in its webglcontextrestored handler. if (!reestablish_remote_context()) return; reset_context_state_after_loss(); m_context_lost = false; m_context_restore_requested = false; m_error = GL_NO_ERROR; HTML::queue_a_task(HTML::Task::Source::WebGL, nullptr, nullptr, GC::create_function(heap(), [canvas = canvas_for_binding()] { fire_webgl_context_event(canvas, EventNames::webglcontextrestored); })); } void WebGLRenderingContextBase::reset_context_state_after_loss() { ++m_context_generation; m_unpack_flip_y = false; m_unpack_premultiply_alpha = false; m_unpack_colorspace_conversion = BROWSER_DEFAULT_WEBGL; reset_client_side_webgl_state(); } // https://immersive-web.github.io/webxr/#dom-webglrenderingcontextbase-makexrcompatible GC::Ref WebGLRenderingContextBase::make_xr_compatible() { // 1. If the requesting document’s origin is not allowed to use the "xr-spatial-tracking" permissions policy, // resolve promise and return it. // FIXME: Implement this. // 2. Let promise be a new Promise created in the Realm of this WebGLRenderingContextBase. auto& realm = this->realm(); auto promise = WebIDL::create_promise(realm); // 3. Let context be this. auto context = this; // 4. Run the following steps in parallel: Platform::EventLoopPlugin::the().deferred_invoke(GC::create_function(realm.heap(), [&realm, context, promise]() { // 1. Let device be the result of ensuring an immersive XR device is selected. // FIXME: Implement https://immersive-web.github.io/webxr/#ensure-an-immersive-xr-device-is-selected // 2. Set context’s XR compatible boolean as follows: // -> If context’s WebGL context lost flag is set: if (context->is_context_lost()) { // Queue a task to set context’s XR compatible boolean to false and reject promise with an InvalidStateError. HTML::queue_a_task(HTML::Task::Source::Unspecified, nullptr, nullptr, GC::create_function(realm.heap(), [&realm, promise, context]() { context->set_xr_compatible(false); HTML::TemporaryExecutionContext execution_context { realm, HTML::TemporaryExecutionContext::CallbacksEnabled::Yes }; WebIDL::reject_promise(realm, promise, WebIDL::InvalidStateError::create(realm, "The WebGL context has been lost."_utf16)); })); } // -> If device is null: else if (false) { // Queue a task to set context’s XR compatible boolean to false and reject promise with an InvalidStateError. HTML::queue_a_task(HTML::Task::Source::Unspecified, nullptr, nullptr, GC::create_function(realm.heap(), [&realm, promise, context]() { context->set_xr_compatible(false); HTML::TemporaryExecutionContext execution_context { realm, HTML::TemporaryExecutionContext::CallbacksEnabled::Yes }; WebIDL::reject_promise(realm, promise, WebIDL::InvalidStateError::create(realm, "Could not select an immersive XR device."_utf16)); })); } // -> If context’s XR compatible boolean is true: else if (context->xr_compatible()) { // Queue a task to resolve promise. HTML::queue_a_task(HTML::Task::Source::Unspecified, nullptr, nullptr, GC::create_function(realm.heap(), [&realm, promise]() { HTML::TemporaryExecutionContext execution_context { realm, HTML::TemporaryExecutionContext::CallbacksEnabled::Yes }; WebIDL::resolve_promise(realm, promise); })); } // -> If context was created on a compatible graphics adapter for device: // FIXME: For now we just pretend that this happened, so that we can resolve the promise and proceed running basic WPT tests for this. else if (true) { // Queue a task to set context’s XR compatible boolean to true and resolve promise. HTML::queue_a_task(HTML::Task::Source::Unspecified, nullptr, nullptr, GC::create_function(realm.heap(), [&realm, promise, context]() { context->set_xr_compatible(true); HTML::TemporaryExecutionContext execution_context { realm, HTML::TemporaryExecutionContext::CallbacksEnabled::Yes }; WebIDL::resolve_promise(realm, promise); })); } // -> Otherwise: else { // Queue a task on the WebGL task source to perform the following steps: HTML::queue_a_task(HTML::Task::Source::WebGL, nullptr, nullptr, GC::create_function(realm.heap(), []() { // 1. Force context to be lost. // 2. Handle the context loss as described by the WebGL specification: // FIXME: Implement https://registry.khronos.org/webgl/specs/latest/1.0/#CONTEXT_LOST })); } })); // 5. Return promise. return promise; } }