Browse Source

doc: introduce \requires_vk_feature, add useful info to the group pages.

pull/491/head
Vladimír Vondruš 5 years ago
parent
commit
ef0113f558
  1. 3
      doc/Doxyfile
  2. 3
      doc/Doxyfile-mcss
  3. 3
      doc/Doxyfile-public
  4. 3
      doc/coding-style.dox
  5. 48
      doc/vulkan.dox

3
doc/Doxyfile

@ -305,7 +305,8 @@ ALIASES = \
"def_vk{1}=<a href=\"https://www.khronos.org/registry/vulkan/specs/1.2-extensions/man/html/VK_\1.html\">VK_\1</a>" \
"requires_vk11=@xrefitem requires-vk11 \"Requires Vulkan 1.1\" \"Functionality requiring Vulkan 1.1\"" \
"requires_vk12=@xrefitem requires-vk12 \"Requires Vulkan 1.2\" \"Functionality requiring Vulkan 1.2\"" \
"requires_vk_extension=@xrefitem requires-vk-extension \"Requires Vulkan extension\" \"Functionality requiring specific Vulkan extension\"" \
"requires_vk_extension=@xrefitem requires-vk-extension \"Requires Vulkan extension\" \"Functionality requiring a specific Vulkan extension\"" \
"requires_vk_feature=@xrefitem requires-vk-feature \"Requires Vulkan feature\" \"Functionality requiring a specific Vulkan feature\"" \
"vk_extension{2}= <a href=\"https://www.khronos.org/registry/vulkan/specs/1.2-extensions/man/html/VK_\1_\2.html\">\1_\2</a>" \
"fn_al{1}=`al\1()`" \
"fn_alc{1}=`alc\1()`" \

3
doc/Doxyfile-mcss

@ -62,7 +62,8 @@ ALIASES = \
"def_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>" \
"requires_vk11=@xrefitem requires-vk11 \"Requires Vulkan 1.1\" \"Functionality requiring Vulkan 1.1\"" \
"requires_vk12=@xrefitem requires-vk12 \"Requires Vulkan 1.2\" \"Functionality requiring Vulkan 1.2\"" \
"requires_vk_extension=@xrefitem requires-vk-extension \"Requires Vulkan extension\" \"Functionality requiring specific Vulkan extension\"" \
"requires_vk_extension=@xrefitem requires-vk-extension \"Requires Vulkan extension\" \"Functionality requiring a specific Vulkan extension\"" \
"requires_vk_feature=@xrefitem requires-vk-feature \"Requires Vulkan feature\" \"Functionality requiring a specific Vulkan feature\"" \
"vk_extension{2}=@m_class{m-doc-external} <a href=\"https://www.khronos.org/registry/vulkan/specs/1.2-extensions/man/html/VK_\1_\2.html\">\1_\2</a>" \
"fn_al{1}=@m_class{m-doc-external} <a href=\"https://github.com/kcat/openal-soft/wiki/Programmer's-Guide#al\1\">al\1()</a>" \
"fn_alc{1}=@m_class{m-doc-external} <a href=\"https://github.com/kcat/openal-soft/wiki/Programmer's-Guide#alc\1\">alc\1()</a>" \

3
doc/Doxyfile-public

@ -58,7 +58,8 @@ ALIASES = \
"def_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>" \
"requires_vk11=@xrefitem requires-vk11 \"Requires Vulkan 1.1\" \"Functionality requiring Vulkan 1.1\"" \
"requires_vk12=@xrefitem requires-vk12 \"Requires Vulkan 1.2\" \"Functionality requiring Vulkan 1.2\"" \
"requires_vk_extension=@xrefitem requires-vk-extension \"Requires Vulkan extension\" \"Functionality requiring specific Vulkan extension\"" \
"requires_vk_extension=@xrefitem requires-vk-extension \"Requires Vulkan extension\" \"Functionality requiring a specific Vulkan extension\"" \
"requires_vk_feature=@xrefitem requires-vk-feature \"Requires Vulkan feature\" \"Functionality requiring a specific Vulkan feature\"" \
"vk_extension{2}=@m_class{m-doc-external} <a href=\"https://www.khronos.org/registry/vulkan/specs/1.2-extensions/man/html/VK_\1_\2.html\">\1_\2</a>" \
"fn_al{1}=@m_class{m-doc-external} <a href=\"https://github.com/kcat/openal-soft/wiki/Programmer's-Guide#al\1\">al\1()</a>" \
"fn_alc{1}=@m_class{m-doc-external} <a href=\"https://github.com/kcat/openal-soft/wiki/Programmer's-Guide#alc\1\">alc\1()</a>" \

3
doc/coding-style.dox

@ -253,7 +253,8 @@ for specific extensions not part of the core OpenGL ES specification and
WebGL specification. When there is more than just a single platform, first come
desktop requirements, then ES requirements and WebGL requirements last.
For Vulkan, the command is @c \@requires_vk_extension:
For Vulkan, the command is @c \@requires_vkXX, @c \@requires_vk_extension, and
because Vulkan contain feature bits, also @c \@requires_vk_feature.
@snippet coding-style.h requires_vk_extension

48
doc/vulkan.dox

@ -55,22 +55,48 @@ is usually supported everywhere, even if the drivers don't have Vulkan 1.2).
- @subpage requires-vk11
- @subpage requires-vk12
- @subpage requires-vk-extension
- @subpage requires-vk-feature
*/
/** @page requires-vk11 Functionality requiring Vulkan 1.1
* @m_footernavigation
* @m_since_latest
*/
@m_footernavigation
@m_since_latest
APIs listed here require a particular Vulkan version to be supported by the
instance / device or, if specified, an extension to be supported and enabled on
the instance / device using @ref Vk::InstanceCreateInfo::addEnabledExtensions()
/ @ref Vk::DeviceCreateInfo::addEnabledExtensions().
*/
/** @page requires-vk12 Functionality requiring Vulkan 1.2
* @m_footernavigation
* @m_since_latest
*/
/** @page requires-vk-extension Functionality requiring specific Vulkan extension
* @m_footernavigation
* @m_since_latest
*/
@m_footernavigation
@m_since_latest
APIs listed here require a particular Vulkan version to be supported by the
instance / device or, if specified, an extension to be supported and enabled on
the instance / device using @ref Vk::InstanceCreateInfo::addEnabledExtensions()
/ @ref Vk::DeviceCreateInfo::addEnabledExtensions().
*/
/** @page requires-vk-extension Functionality requiring a specific Vulkan extension
@m_footernavigation
@m_since_latest
APIs listed here require a Vulkan extension to be supported and enabled on the
instance / device using @ref Vk::InstanceCreateInfo::addEnabledExtensions() /
@ref Vk::DeviceCreateInfo::addEnabledExtensions().
*/
/**
@page requires-vk-feature Functionality requiring a specific Vulkan feature
@m_footernavigation
@m_since_latest
APIs listed here require a Vulkan feature to be supported and enabled on the
device using @ref Vk::DeviceCreateInfo::setEnabledFeatures(). Note that some
features are coming from extensions and thus require also the corresponding
extension to be enabled.
*/
}

Loading…
Cancel
Save