From 86b454dc4ea27ccf710b3d0421fe4279815e7ae3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Mon, 18 Oct 2021 17:05:49 +0200 Subject: [PATCH] doc: add a page aggregating WebGL-specific features. The time have come to this. Sigh. --- doc/Doxyfile | 1 + doc/Doxyfile-mcss | 1 + doc/Doxyfile-public | 1 + doc/opengl.dox | 14 ++++++++++++-- doc/portability.dox | 3 ++- 5 files changed, 17 insertions(+), 3 deletions(-) diff --git a/doc/Doxyfile b/doc/Doxyfile index 13be58108..77bbee5e6 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -298,6 +298,7 @@ ALIASES = \ "requires_webgl20=@xrefitem requires-webgl20 \"Requires WebGL 2.0\" \"Functionality requiring WebGL 2.0\"" \ "requires_webgl_extension=@xrefitem requires-webgl-extension \"Requires WebGL extension\" \"Functionality requiring specific WebGL extension\"" \ "requires_gles20_only=@xrefitem requires-gles20-only \"OpenGL ES 2.0-only and WebGL 1.0-only\" \"OpenGL ES 2.0-only and WebGL 1.0-only functionality\"" \ + "requires_webgl_only=@xrefitem requires-webgl-only \"WebGL-only\" \"WebGL-only functionality\"" \ "webgl_extension{2}=\1_\2" \ "fn_vk{1}=vk\1()" \ "type_vk{1}=Vk\1" \ diff --git a/doc/Doxyfile-mcss b/doc/Doxyfile-mcss index 9fffeafc8..e17904ab1 100644 --- a/doc/Doxyfile-mcss +++ b/doc/Doxyfile-mcss @@ -55,6 +55,7 @@ ALIASES = \ "requires_webgl20=@xrefitem requires-webgl20 \"Requires WebGL 2.0\" \"Functionality requiring WebGL 2.0\"" \ "requires_webgl_extension=@xrefitem requires-webgl-extension \"Requires WebGL extension\" \"Functionality requiring specific WebGL extension\"" \ "requires_gles20_only=@xrefitem requires-gles20-only \"OpenGL ES 2.0-only and WebGL 1.0-only\" \"OpenGL ES 2.0-only and WebGL 1.0-only functionality\"" \ + "requires_webgl_only=@xrefitem requires-webgl-only \"WebGL-only\" \"WebGL-only functionality\"" \ "webgl_extension{2}=@m_class{m-doc-external} \1_\2" \ "fn_vk{1}=@m_class{m-doc-external} vk\1()" \ "type_vk{1}=@m_class{m-doc-external} Vk\1" \ diff --git a/doc/Doxyfile-public b/doc/Doxyfile-public index d339d3d7d..7e0ff884b 100644 --- a/doc/Doxyfile-public +++ b/doc/Doxyfile-public @@ -51,6 +51,7 @@ ALIASES = \ "requires_webgl20=@xrefitem requires-webgl20 \"Requires WebGL 2.0\" \"Functionality requiring WebGL 2.0\"" \ "requires_webgl_extension=@xrefitem requires-webgl-extension \"Requires WebGL extension\" \"Functionality requiring specific WebGL extension\"" \ "requires_gles20_only=@xrefitem requires-gles20-only \"OpenGL ES 2.0-only and WebGL 1.0-only\" \"OpenGL ES 2.0-only and WebGL 1.0-only functionality\"" \ + "requires_webgl_only=@xrefitem requires-webgl-only \"WebGL-only\" \"WebGL-only functionality\"" \ "webgl_extension{2}=@m_class{m-doc-external} \1_\2" \ "fn_vk{1}=@m_class{m-doc-external} vk\1()" \ "type_vk{1}=@m_class{m-doc-external} Vk\1" \ diff --git a/doc/opengl.dox b/doc/opengl.dox index 8557c3d1c..55bed5c32 100644 --- a/doc/opengl.dox +++ b/doc/opengl.dox @@ -82,6 +82,7 @@ is supported on older Intel GPUs even if they are capable of OpenGL 2.1 only). - @subpage requires-webgl20 - @subpage requires-webgl-extension - @subpage requires-gles20-only +- @subpage requires-webgl-only @see @ref building, @ref cmake, @ref MAGNUM_TARGET_GLES, @ref MAGNUM_TARGET_GLES2 @@ -170,7 +171,7 @@ The following symbols are not defined when targeting OpenGL ES 2.0. The following symbols are not defined when targeting WebGL. -@see @ref MAGNUM_TARGET_WEBGL, @ref requires-gl +@see @ref MAGNUM_TARGET_WEBGL, @ref requires-gl, @ref requires-webgl-only */ /** @page requires-webgl20 Functionality requiring WebGL 2.0 @@ -187,5 +188,14 @@ The following symbols are not defined when targeting WebGL. The following symbols are not defined when targeting OpenGL ES 3.0, WebGL 2.0 or desktop OpenGL. -@see @ref MAGNUM_TARGET_GLES2 +@see @ref MAGNUM_TARGET_GLES2, @ref requires-webgl-only +*/ + +/** @page requires-webgl-only WebGL-only functionality +@m_footernavigation + +The following symbols are not defined when targeting OpenGL ES or desktop +OpenGL. + +@see @ref MAGNUM_TARGET_WEBGL, @ref requires-gles20-only */ diff --git a/doc/portability.dox b/doc/portability.dox index 44fae06b2..22fb1d99d 100644 --- a/doc/portability.dox +++ b/doc/portability.dox @@ -51,7 +51,8 @@ Example usage: @snippet MagnumGL.cpp portability-targets Each feature is marked accordingly if it is not available in some targets. See -also @ref requires-gl, @ref requires-gles30 and @ref requires-gles20-only. +also @ref requires-gl, @ref requires-gles30, @ref requires-gles20-only and +@ref requires-webgl-only. @section portability-compiler Compiler- and platform-specific code