Browse Source

doc: utilities don't require their dependencies to be enabled.

Probably a leftover from when these dependencies were handled in a
much shittier way? For as long as I remember, enabling WITH_GL_INFO
always enabled WITH_GL and WITH_WINDOWLESSWHATEVERAPPLICATION
implicitly.
pull/542/merge
Vladimír Vondruš 4 years ago
parent
commit
aaeca5c855
  1. 25
      doc/building.dox
  2. 9
      src/Magnum/Audio/al-info.cpp
  3. 8
      src/Magnum/Platform/gl-info.cpp
  4. 10
      src/Magnum/SceneTools/sceneconverter.cpp
  5. 6
      src/Magnum/ShaderTools/shaderconverter.cpp
  6. 8
      src/Magnum/Text/fontconverter.cpp
  7. 9
      src/Magnum/TextureTools/distancefieldconverter.cpp
  8. 8
      src/Magnum/Trade/imageconverter.cpp
  9. 8
      src/Magnum/Vk/vk-info.cpp

25
doc/building.dox

@ -610,26 +610,27 @@ There are also a few command-line utilities, also all disabled by default:
- `WITH_GL_INFO` --- Build the @ref magnum-gl-info "magnum-gl-info"
executable, which provides information about the engine OpenGL
capabilities. Requires `TARGET_GL` to be enabled; enables building of one
of the windowless application libraries based on the target platform.
capabilities. Requires `TARGET_GL` to be enabled; enables also building of
the @ref GL library and one of the windowless application libraries based
on the target platform.
- `WITH_VK_INFO` --- Build the @ref magnum-vk-info "magnum-vk-info"
executable, which provides information about the engine Vulkan
capabilities. Requires `TARGET_VK` to be enabled; enables building of the
@ref Vk library.
capabilities. Requires `TARGET_VK` to be enabled; enables also building of
the @ref Vk library.
- `WITH_AL_INFO` --- Build the @ref magnum-al-info "magnum-al-info"
executable, which provides information about the engine OpenAL
capabilities.
capabilities. Enables also building of the @ref Audio library.
- `WITH_DISTANCEFIELDCONVERTER` --- Build the
@ref magnum-distancefieldconverter "magnum-distancefieldconverter"
executable for converting black&white images to distance field textures.
Enables also building of the @ref TextureTools library. Available only on
desktop GL. Requires `TARGET_GL` to be enabled; enables building of one of
the windowless application libraries based on the target platform.
Available only on desktop GL. Requires `TARGET_GL` to be enabled; enables
also building of the @ref TextureTools and @ref GL libraries and one of the
windowless application libraries based on the target platform.
- `WITH_FONTCONVERTER` --- Build the @ref magnum-fontconverter "magnum-fontconverter"
executable for converting fonts of different formats. Enables also building
of the @ref Text library. Available only on desktop GL. Requires
`TARGET_GL` to be enabled; enables building of one of the windowless
application libraries based on the target platform.
executable for converting fonts of different formats. Available only on
desktop GL. Requires `TARGET_GL` to be enabled; enables also building of
the @ref Text and @ref GL libraries and one of the windowless application
libraries based on the target platform.
- `WITH_IMAGECONVERTER` --- Build the @ref magnum-imageconverter "magnum-imageconverter"
executable for converting images of different formats. Enables also
building of the @ref Trade library.

9
src/Magnum/Audio/al-info.cpp

@ -39,11 +39,10 @@ namespace Magnum {
@m_div{m-button m-primary} <a href="https://magnum.graphics/showcase/al-info/">@m_div{m-big}Live web version @m_enddiv @m_div{m-small} uses WebAssembly & WebAudio @m_enddiv </a> @m_enddiv
This utility depends on the [OpenAL](https://www.openal.org/) library. It is
built if both `WITH_AUDIO` and `WITH_AL_INFO` is enabled when building Magnum.
To use this utility with CMake, you need to request the `al-info` component of
the `Magnum` package and use the `Magnum::al-info` target for example in a
custom command:
This utility is built if `WITH_AL_INFO` is enabled when building Magnum. To use
this utility with CMake, you need to request the `al-info` component of the
`Magnum` package and use the `Magnum::al-info` target for example in a custom
command:
@code{.cmake}
find_package(Magnum REQUIRED al-info)

8
src/Magnum/Platform/gl-info.cpp

@ -91,10 +91,10 @@ namespace Magnum {
@m_div{m-button m-primary} <a href="https://magnum.graphics/showcase/gl-info/">@m_div{m-big}Live web version @m_enddiv @m_div{m-small} uses WebAssembly & WebGL @m_enddiv </a> @m_enddiv
This utility is built if both `WITH_GL` and `WITH_GL_INFO` is enabled when
building Magnum. To use this utility with CMake, you need to request the
`gl-info` component of the `Magnum` package and use the `Magnum::gl-info`
target for example in a custom command:
This utility is built if `WITH_GL_INFO` is enabled when building Magnum. To use
this utility with CMake, you need to request the `gl-info` component of the
`Magnum` package and use the `Magnum::gl-info` target for example in a custom
command:
@code{.cmake}
find_package(Magnum REQUIRED gl-info)

10
src/Magnum/SceneTools/sceneconverter.cpp

@ -60,10 +60,10 @@ namespace Magnum {
@m_footernavigation
@m_keywords{magnum-sceneconverter sceneconverter}
This utility is built if both `WITH_TRADE` and `WITH_SCENECONVERTER` is enabled
when building Magnum. To use this utility with CMake, you need to request the
`sceneconverter` component of the `Magnum` package and use the
`Magnum::sceneconverter` target for example in a custom command:
This utility is built if `WITH_SCENECONVERTER` is enabled when building Magnum.
To use this utility with CMake, you need to request the `sceneconverter`
component of the `Magnum` package and use the `Magnum::sceneconverter` target
for example in a custom command:
@code{.cmake}
find_package(Magnum REQUIRED imageconverter)
@ -71,7 +71,7 @@ find_package(Magnum REQUIRED imageconverter)
add_custom_command(OUTPUT ... COMMAND Magnum::sceneconverter ...)
@endcode
See @ref building, @ref cmake and the @ref Trade namespace for more
See @ref building and @ref cmake and the @ref Trade namespace for more
information.
@section magnum-sceneconverter-usage Usage

6
src/Magnum/ShaderTools/shaderconverter.cpp

@ -45,9 +45,9 @@ namespace Magnum {
@m_footernavigation
@m_keywords{magnum-shaderconverter shaderconverter}
This utility is built if both `WITH_SHADERTOOLS` and `WITH_SHADERCONVERTER` is
enabled when building Magnum. To use this utility with CMake, you need to
request the `shaderconverter` component of the `Magnum` package and use the
This utility is built if `WITH_SHADERCONVERTER` is enabled when building
Magnum. To use this utility with CMake, you need to request the
`shaderconverter` component of the `Magnum` package and use the
`Magnum::shaderconverter` target for example in a custom command:
@code{.cmake}

8
src/Magnum/Text/fontconverter.cpp

@ -65,10 +65,10 @@ namespace Magnum {
@m_footernavigation
@m_keywords{magnum-fontconverter fontconverter}
This utility is built if both `WITH_TEXT` and `WITH_FONTCONVERTER` is enabled
when building Magnum. To use this utility with CMake, you need to request the
`fontconverter` component of the `Magnum` package and use the
`Magnum::fontconverter` target for example in a custom command:
This utility is built if `WITH_FONTCONVERTER` is enabled when building Magnum.
To use this utility with CMake, you need to request the `fontconverter`
component of the `Magnum` package and use the `Magnum::fontconverter` target
for example in a custom command:
@code{.cmake}
find_package(Magnum REQUIRED fontconverter)

9
src/Magnum/TextureTools/distancefieldconverter.cpp

@ -72,11 +72,10 @@ namespace Magnum {
@m_footernavigation
@m_keywords{magnum-distancefieldconverter distancefieldconverter}
This utility is built if both `WITH_TEXTURETOOLS` and
`WITH_DISTANCEFIELDCONVERTER` is enabled when building Magnum. To use this
utility with CMake, you need to request the `distancefieldconverter` component
of the `Magnum` package and use the `Magnum::distancefieldconverter` target for
example in a custom command:
This utility is built if `WITH_DISTANCEFIELDCONVERTER` is enabled when building
Magnum. To use this utility with CMake, you need to request the
`distancefieldconverter` component of the `Magnum` package and use the
`Magnum::distancefieldconverter` target for example in a custom command:
@code{.cmake}
find_package(Magnum REQUIRED distancefieldconverter)

8
src/Magnum/Trade/imageconverter.cpp

@ -51,10 +51,10 @@ namespace Magnum {
@m_footernavigation
@m_keywords{magnum-imageconverter imageconverter}
This utility is built if both `WITH_TRADE` and `WITH_IMAGECONVERTER` is enabled
when building Magnum. To use this utility with CMake, you need to request the
`imageconverter` component of the `Magnum` package and use the
`Magnum::imageconverter` target for example in a custom command:
This utility is built if `WITH_IMAGECONVERTER` is enabled when building Magnum.
To use this utility with CMake, you need to request the `imageconverter`
component of the `Magnum` package and use the `Magnum::imageconverter` target
for example in a custom command:
@code{.cmake}
find_package(Magnum REQUIRED imageconverter)

8
src/Magnum/Vk/vk-info.cpp

@ -43,10 +43,10 @@ namespace Magnum {
@m_footernavigation
@m_keywords{magnum-vk-info vk-info}
This utility is built if both `WITH_VK` and `WITH_VK_INFO` is enabled when
building Magnum. To use this utility with CMake, you need to request the
`vk-info` component of the `Magnum` package and use the `Magnum::vk-info`
target for example in a custom command:
This utility is built if `WITH_VK_INFO` is enabled when building Magnum. To use
this utility with CMake, you need to request the `vk-info` component of the
`Magnum` package and use the `Magnum::vk-info` target for example in a custom
command:
@code{.cmake}
find_package(Magnum REQUIRED vk-info)

Loading…
Cancel
Save