Browse Source

doc: add a page aggregating WebGL-specific features.

The time have come to this. Sigh.
pull/240/head
Vladimír Vondruš 5 years ago
parent
commit
86b454dc4e
  1. 1
      doc/Doxyfile
  2. 1
      doc/Doxyfile-mcss
  3. 1
      doc/Doxyfile-public
  4. 14
      doc/opengl.dox
  5. 3
      doc/portability.dox

1
doc/Doxyfile

@ -298,6 +298,7 @@ ALIASES = \
"requires_webgl20=@xrefitem requires-webgl20 \"Requires WebGL 2.0\" \"Functionality requiring WebGL 2.0\"" \ "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_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_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}=<a href=\"https://www.khronos.org/registry/webgl/extensions/\1_\2/\">\1_\2</a>" \ "webgl_extension{2}=<a href=\"https://www.khronos.org/registry/webgl/extensions/\1_\2/\">\1_\2</a>" \
"fn_vk{1}=<a href=\"https://www.khronos.org/registry/vulkan/specs/1.2-extensions/man/html/vk\1.html\">vk\1()</a>" \ "fn_vk{1}=<a href=\"https://www.khronos.org/registry/vulkan/specs/1.2-extensions/man/html/vk\1.html\">vk\1()</a>" \
"type_vk{1}=<a href=\"https://www.khronos.org/registry/vulkan/specs/1.2-extensions/man/html/Vk\1.html\">Vk\1</a>" \ "type_vk{1}=<a href=\"https://www.khronos.org/registry/vulkan/specs/1.2-extensions/man/html/Vk\1.html\">Vk\1</a>" \

1
doc/Doxyfile-mcss

@ -55,6 +55,7 @@ ALIASES = \
"requires_webgl20=@xrefitem requires-webgl20 \"Requires WebGL 2.0\" \"Functionality requiring WebGL 2.0\"" \ "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_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_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} <a href=\"https://www.khronos.org/registry/webgl/extensions/\1_\2/\">\1_\2</a>" \ "webgl_extension{2}=@m_class{m-doc-external} <a href=\"https://www.khronos.org/registry/webgl/extensions/\1_\2/\">\1_\2</a>" \
"fn_vk{1}=@m_class{m-doc-external} <a href=\"https://www.khronos.org/registry/vulkan/specs/1.2-extensions/man/html/vk\1.html\">vk\1()</a>" \ "fn_vk{1}=@m_class{m-doc-external} <a href=\"https://www.khronos.org/registry/vulkan/specs/1.2-extensions/man/html/vk\1.html\">vk\1()</a>" \
"type_vk{1}=@m_class{m-doc-external} <a href=\"https://www.khronos.org/registry/vulkan/specs/1.2-extensions/man/html/Vk\1.html\">Vk\1</a>" \ "type_vk{1}=@m_class{m-doc-external} <a href=\"https://www.khronos.org/registry/vulkan/specs/1.2-extensions/man/html/Vk\1.html\">Vk\1</a>" \

1
doc/Doxyfile-public

@ -51,6 +51,7 @@ ALIASES = \
"requires_webgl20=@xrefitem requires-webgl20 \"Requires WebGL 2.0\" \"Functionality requiring WebGL 2.0\"" \ "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_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_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} <a href=\"https://www.khronos.org/registry/webgl/extensions/\1_\2/\">\1_\2</a>" \ "webgl_extension{2}=@m_class{m-doc-external} <a href=\"https://www.khronos.org/registry/webgl/extensions/\1_\2/\">\1_\2</a>" \
"fn_vk{1}=@m_class{m-doc-external} <a href=\"https://www.khronos.org/registry/vulkan/specs/1.2-extensions/man/html/vk\1.html\">vk\1()</a>" \ "fn_vk{1}=@m_class{m-doc-external} <a href=\"https://www.khronos.org/registry/vulkan/specs/1.2-extensions/man/html/vk\1.html\">vk\1()</a>" \
"type_vk{1}=@m_class{m-doc-external} <a href=\"https://www.khronos.org/registry/vulkan/specs/1.2-extensions/man/html/Vk\1.html\">Vk\1</a>" \ "type_vk{1}=@m_class{m-doc-external} <a href=\"https://www.khronos.org/registry/vulkan/specs/1.2-extensions/man/html/Vk\1.html\">Vk\1</a>" \

14
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-webgl20
- @subpage requires-webgl-extension - @subpage requires-webgl-extension
- @subpage requires-gles20-only - @subpage requires-gles20-only
- @subpage requires-webgl-only
@see @ref building, @ref cmake, @ref MAGNUM_TARGET_GLES, @see @ref building, @ref cmake, @ref MAGNUM_TARGET_GLES,
@ref MAGNUM_TARGET_GLES2 @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. 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 /** @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 The following symbols are not defined when targeting OpenGL ES 3.0, WebGL 2.0
or desktop OpenGL. 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
*/ */

3
doc/portability.dox

@ -51,7 +51,8 @@ Example usage:
@snippet MagnumGL.cpp portability-targets @snippet MagnumGL.cpp portability-targets
Each feature is marked accordingly if it is not available in some targets. See 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 @section portability-compiler Compiler- and platform-specific code

Loading…
Cancel
Save