/* This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ use canvas_traits::webgl::WebGLError; use dom::bindings::cell::DomRefCell; use dom::bindings::codegen::Bindings::OESStandardDerivativesBinding::OESStandardDerivativesConstants; use dom::bindings::codegen::Bindings::OESTextureHalfFloatBinding::OESTextureHalfFloatConstants; use dom::bindings::codegen::Bindings::WebGLRenderingContextBinding::WebGLRenderingContextConstants as constants; use dom::bindings::nonnull::NonNullJSObjectPtr; use dom::bindings::root::DomRoot; use dom::bindings::trace::JSTraceable; use dom::webglrenderingcontext::WebGLRenderingContext; use fnv::{FnvHashMap, FnvHashSet}; use gleam::gl::GLenum; use js::jsapi::JSContext; use js::jsval::JSVal; use malloc_size_of::MallocSizeOf; use ref_filter_map::ref_filter_map; use std::cell::Ref; use std::collections::HashMap; use std::iter::FromIterator; use super::{ext, WebGLExtension}; use super::wrapper::{WebGLExtensionWrapper, TypedWebGLExtensionWrapper}; // Data types that are implemented for texImage2D and texSubImage2D in WebGLRenderingContext // but must trigger a InvalidValue error until the related WebGL Extensions are enabled. // Example: https://www.khronos.org/registry/webgl/extensions/OES_texture_float/ const DEFAULT_DISABLED_TEX_TYPES: [GLenum; 2] = [ constants::FLOAT, OESTextureHalfFloatConstants::HALF_FLOAT_OES ]; // Data types that are implemented for textures in WebGLRenderingContext // but not allowed to use with linear filtering until the related WebGL Extensions are enabled. // Example: https://www.khronos.org/registry/webgl/extensions/OES_texture_float_linear/ const DEFAULT_NOT_FILTERABLE_TEX_TYPES: [GLenum; 2] = [ constants::FLOAT, OESTextureHalfFloatConstants::HALF_FLOAT_OES ]; // Param names that are implemented for getParameter WebGL function // but must trigger a InvalidEnum error until the related WebGL Extensions are enabled. // Example: https://www.khronos.org/registry/webgl/extensions/OES_standard_derivatives/ const DEFAULT_DISABLED_GET_PARAMETER_NAMES: [GLenum; 1] = [ OESStandardDerivativesConstants::FRAGMENT_SHADER_DERIVATIVE_HINT_OES ]; /// WebGL features that are enabled/disabled by WebGL Extensions. #[derive(JSTraceable, MallocSizeOf)] struct WebGLExtensionFeatures { gl_extensions: FnvHashSet, disabled_tex_types: FnvHashSet, not_filterable_tex_types: FnvHashSet, effective_tex_internal_formats: FnvHashMap, query_parameter_handlers: FnvHashMap, /// WebGL Hint() targets enabled by extensions. hint_targets: FnvHashSet, /// WebGL GetParameter() names enabled by extensions. disabled_get_parameter_names: FnvHashSet, } impl Default for WebGLExtensionFeatures { fn default() -> WebGLExtensionFeatures { WebGLExtensionFeatures { gl_extensions: Default::default(), disabled_tex_types: DEFAULT_DISABLED_TEX_TYPES.iter().cloned().collect(), not_filterable_tex_types: DEFAULT_NOT_FILTERABLE_TEX_TYPES.iter().cloned().collect(), effective_tex_internal_formats: Default::default(), query_parameter_handlers: Default::default(), hint_targets: Default::default(), disabled_get_parameter_names: DEFAULT_DISABLED_GET_PARAMETER_NAMES.iter().cloned().collect(), } } } /// Handles the list of implemented, supported and enabled WebGL extensions. #[must_root] #[derive(JSTraceable, MallocSizeOf)] pub struct WebGLExtensions { extensions: DomRefCell>>, features: DomRefCell, } impl WebGLExtensions { pub fn new() -> WebGLExtensions { Self { extensions: DomRefCell::new(HashMap::new()), features: DomRefCell::new(Default::default()) } } pub fn init_once(&self, cb: F) where F: FnOnce() -> String { if self.extensions.borrow().len() == 0 { let gl_str = cb(); self.features.borrow_mut().gl_extensions = FnvHashSet::from_iter(gl_str.split(&[',', ' '][..]) .map(|s| s.into())); self.register_all_extensions(); } } pub fn register(&self) { let name = T::name().to_uppercase(); self.extensions.borrow_mut().insert(name, Box::new(TypedWebGLExtensionWrapper::::new())); } pub fn get_suported_extensions(&self) -> Vec<&'static str> { self.extensions.borrow().iter() .filter(|ref v| v.1.is_supported(&self)) .map(|ref v| v.1.name()) .collect() } pub fn get_or_init_extension(&self, name: &str, ctx: &WebGLRenderingContext) -> Option { let name = name.to_uppercase(); self.extensions.borrow().get(&name).and_then(|extension| { if extension.is_supported(self) { Some(extension.instance_or_init(ctx, self)) } else { None } }) } pub fn is_enabled(&self) -> bool where T: 'static + WebGLExtension + JSTraceable + MallocSizeOf { let name = T::name().to_uppercase(); self.extensions.borrow().get(&name).map_or(false, |ext| { ext.is_enabled() }) } pub fn get_dom_object(&self) -> Option> where T: 'static + WebGLExtension + JSTraceable + MallocSizeOf { let name = T::name().to_uppercase(); self.extensions.borrow().get(&name).and_then(|extension| { extension.as_any().downcast_ref::>().and_then(|extension| { extension.dom_object() }) }) } pub fn supports_gl_extension(&self, name: &str) -> bool { self.features.borrow().gl_extensions.contains(name) } pub fn supports_any_gl_extension(&self, names: &[&str]) -> bool { let features = self.features.borrow(); names.iter().any(|name| features.gl_extensions.contains(*name)) } pub fn enable_tex_type(&self, data_type: GLenum) { self.features.borrow_mut().disabled_tex_types.remove(&data_type); } pub fn is_tex_type_enabled(&self, data_type: GLenum) -> bool { self.features.borrow().disabled_tex_types.get(&data_type).is_none() } pub fn add_effective_tex_internal_format(&self, source_internal_format: u32, source_data_type: u32, effective_internal_format: u32) { let format = TexFormatType(source_internal_format, source_data_type); self.features.borrow_mut().effective_tex_internal_formats.insert(format, effective_internal_format); } pub fn get_effective_tex_internal_format(&self, source_internal_format: u32, source_data_type: u32) -> u32 { let format = TexFormatType(source_internal_format, source_data_type); *(self.features.borrow().effective_tex_internal_formats.get(&format) .unwrap_or(&source_internal_format)) } pub fn enable_filterable_tex_type(&self, text_data_type: GLenum) { self.features.borrow_mut().not_filterable_tex_types.remove(&text_data_type); } pub fn is_filterable(&self, text_data_type: u32) -> bool { self.features.borrow().not_filterable_tex_types.get(&text_data_type).is_none() } pub fn add_query_parameter_handler(&self, name: GLenum, f: Box) { let handler = WebGLQueryParameterHandler { func: f }; self.features.borrow_mut().query_parameter_handlers.insert(name, handler); } pub fn get_query_parameter_handler(&self, name: GLenum) -> Option>> { ref_filter_map(self.features.borrow(), |features| { features.query_parameter_handlers.get(&name).map(|item| &item.func) }) } pub fn enable_hint_target(&self, name: GLenum) { self.features.borrow_mut().hint_targets.insert(name); } pub fn is_hint_target_enabled(&self, name: GLenum) -> bool { self.features.borrow().hint_targets.contains(&name) } pub fn enable_get_parameter_name(&self, name: GLenum) { self.features.borrow_mut().disabled_get_parameter_names.remove(&name); } pub fn is_get_parameter_name_enabled(&self, name: GLenum) -> bool { !self.features.borrow().disabled_get_parameter_names.contains(&name) } fn register_all_extensions(&self) { self.register::(); self.register::(); self.register::(); self.register::(); self.register::(); self.register::(); } } // Helper structs #[derive(Eq, Hash, JSTraceable, MallocSizeOf, PartialEq)] struct TexFormatType(u32, u32); type WebGLQueryParameterFunc = Fn(*mut JSContext, &WebGLRenderingContext) -> Result; #[derive(MallocSizeOf)] struct WebGLQueryParameterHandler { #[ignore_malloc_size_of = "Closures are hard"] func: Box } unsafe_no_jsmanaged_fields!(WebGLQueryParameterHandler);