Browse Source

doc: cnsistently reference all Magnum CLI tools from related APIs.

pull/525/head
Vladimír Vondruš 5 years ago
parent
commit
43c70b11dd
  1. 10
      src/Magnum/Audio/Context.h
  2. 7
      src/Magnum/GL/Context.h
  3. 4
      src/Magnum/ShaderTools/AbstractConverter.h
  4. 5
      src/Magnum/Text/AbstractFontConverter.h
  5. 6
      src/Magnum/Trade/AbstractImageConverter.h
  6. 6
      src/Magnum/Trade/AbstractImporter.h
  7. 6
      src/Magnum/Trade/AbstractSceneConverter.h
  8. 7
      src/Magnum/Vk/Device.h
  9. 7
      src/Magnum/Vk/Instance.h

10
src/Magnum/Audio/Context.h

@ -86,6 +86,16 @@ class MAGNUM_AUDIO_EXPORT Extension {
/**
@brief OpenAL context
Provides access to OpenAL version and extension information and manages
Magnum's internal OpenAL context.
@m_class{m-note m-success}
@par
There's also the @ref magnum-al-info "magnum-al-info" tool that provides
access to OpenAL version and extension information through a command line
interface.
@section AL-Context-command-line Command-line options
The context is configurable through command-line options, that can be passed

7
src/Magnum/GL/Context.h

@ -123,6 +123,13 @@ class MAGNUM_GL_EXPORT Extension {
Provides access to OpenGL version and extension information and manages
Magnum's internal OpenGL state tracker.
@m_class{m-note m-success}
@par
There's also the @ref magnum-gl-info "magnum-gl-info" tool that provides
access to OpenGL version, extension and platform-specific limit information
through a command line interface.
@section GL-Context-usage Creating a context
In order to use any Magnum OpenGL functionality, an instance of this class has

4
src/Magnum/ShaderTools/AbstractConverter.h

@ -318,7 +318,9 @@ assertions.
@m_class{m-note m-success}
@par
There's also a @ref magnum-shaderconverter "magnum-shaderconverter" tool, exposing functionality of all shader converter plugins on a command line.
There's also the @ref magnum-shaderconverter "magnum-shaderconverter" tool
that exposes functionality of all shader converter plugins through a
command line interface.
@m_class{m-block m-warning}

5
src/Magnum/Text/AbstractFontConverter.h

@ -129,8 +129,9 @@ font conversion on command-line.
@m_class{m-note m-success}
@par
There's also a @ref magnum-fontconverter "magnum-fontconverter" tool,
exposing functionality of all font converter plugins on a command line.
There's also the @ref magnum-fontconverter "magnum-fontconverter" tool that
exposes functionality of all font converter plugins through a command line
interface.
@section Text-AbstractFontConverter-subclassing Subclassing

6
src/Magnum/Trade/AbstractImageConverter.h

@ -491,9 +491,9 @@ image converter plugins.
@m_class{m-note m-success}
@par
There's also a @ref magnum-imageconverter "magnum-imageconverter" tool,
exposing functionality of all image converter plugins on a command line as
well as performing introspection of image files.
There's also the @ref magnum-imageconverter "magnum-imageconverter" tool
that exposes functionality of all image converter plugins through a command
line interface.
@subsection Trade-AbstractImageConverter-usage-file-levels Saving a set of mip levels

6
src/Magnum/Trade/AbstractImporter.h

@ -233,9 +233,9 @@ importer plugins.
@m_class{m-note m-success}
@par
There are also @ref magnum-imageconverter "magnum-imageconverter" and
@ref magnum-sceneconverter "magnum-sceneconverter" tools which you can use
to perform introspection of image and scene files.
There's also the @ref magnum-imageconverter "magnum-imageconverter" and
@ref magnum-sceneconverter "magnum-sceneconverter" tools that you can use
to perform introspection and conversion of image and scene files.
@subsection Trade-AbstractImporter-usage-callbacks Loading data from memory, using file callbacks

6
src/Magnum/Trade/AbstractSceneConverter.h

@ -190,9 +190,9 @@ scene converter plugins.
@m_class{m-note m-success}
@par
There's also a @ref magnum-sceneconverter "magnum-sceneconverter" tool,
exposing functionality of all scene converter plugins on a command line as
well as performing introspection of scene files.
There's also the @ref magnum-sceneconverter "magnum-sceneconverter" tool
that exposes functionality of all scene converter plugins through a command
line interface.
@subsection Trade-AbstractSceneConverter-usage-mesh Converting mesh data

7
src/Magnum/Vk/Device.h

@ -57,6 +57,13 @@ Wraps a @type_vk_keyword{Device} and stores device-specific Vulkan function
pointers. A device provides an abstraction over a physical GPU or a CPU with
Vulkan capabilities.
@m_class{m-note m-success}
@par
There's also the @ref magnum-vk-info "magnum-vk-info" tool that provides
access to Vulkan instance and device version, layer, extension and feature
information through a command line interface.
@section Vk-Device-creation Device creation
With an @ref Instance ready, a device has to be picked first. Commonly it's

7
src/Magnum/Vk/Instance.h

@ -56,6 +56,13 @@ pointers. An instance provides device enumeration and management of Vulkan
layers that enable additional functionality such as command validation or
tracing / debugging.
@m_class{m-note m-success}
@par
There's also the @ref magnum-vk-info "magnum-vk-info" tool that provides
access to Vulkan instance and device version, layer, extension and feature
information through a command line interface.
@section Vk-Instance-creation Instance creation
While an @ref Instance can be default-constructed without much fuss, it's

Loading…
Cancel
Save