ic
/
magnum
mirror of https://github.com/mosra/magnum.git
6
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

Update documentation of utilities for the new theme.

pull/225/head
Vladimír Vondruš 9 years ago
parent
36f5030ffd
commit
6029cfae62
5 changed files with 92 additions and 53 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 20
      src/Magnum/Audio/magnum-al-info.cpp
  2. 23
      src/Magnum/Platform/magnum-info.cpp
  3. 44
      src/Magnum/Text/fontconverter.cpp
  4. 32
      src/Magnum/TextureTools/distancefieldconverter.cpp
  5. 26
      src/Magnum/Trade/imageconverter.cpp

20
src/Magnum/Audio/magnum-al-info.cpp
Unescape View File

@ -33,19 +33,25 @@ namespace Magnum {
/** @page magnum-al-info Magnum OpenAL Info /** @page magnum-al-info Magnum OpenAL Info
@brief Displays information about Magnum OpenAL capabilities @brief Displays information about Magnum OpenAL capabilities
@m_footernavigation
@section magnum-al-info-usage Usage @section magnum-al-info-usage Usage
magnum-al-info [-h|--help] [-s|--short] [--extension-strings] @code{.shell-session}
magnum-al-info [-h|--help] [-s|--short] [--extension-strings]
@endcode
Arguments: Arguments:
- `-h`,` --help` -- display this help message and exit
- `-s`, `--short` -- display just essential info and exit - `-h`,` --help` --- display this help message and exit
- `--extension-strings` -- list all extension strings provided by the driver - `-s`, `--short` --- display just essential info and exit
- `--extension-strings` --- list all extension strings provided by the driver
(implies `--short`) (implies `--short`)
@section magnum-al-info-example Example output @section magnum-al-info-example Example output
``` @code{.shell-session}
+---------------------------------------------------------+ +---------------------------------------------------------+
| Information about Magnum engine and OpenAL capabilities | | Information about Magnum engine and OpenAL capabilities |
+---------------------------------------------------------+ +---------------------------------------------------------+
@ -64,8 +70,8 @@ Vendor extension support:
ALC_ENUMERATION_EXT SUPPORTED ALC_ENUMERATION_EXT SUPPORTED
ALC_SOFTX_HRTF - ALC_SOFTX_HRTF -
ALC_SOFT_HRTF SUPPORTED ALC_SOFT_HRTF SUPPORTED
...
``` @endcode
*/ */

23
src/Magnum/Platform/magnum-info.cpp
Unescape View File

@ -83,20 +83,27 @@ namespace Magnum {
/** @page magnum-info Magnum Info /** @page magnum-info Magnum Info
@brief Displays information about Magnum engine and OpenGL capabilities @brief Displays information about Magnum engine and OpenGL capabilities
@m_footernavigation
@section magnum-info-usage Usage @section magnum-info-usage Usage
magnum-info [--magnum-...] [-h|--help] [-s|--short] [--all-extensions] [--limits] @code{.shell-session}
magnum-info [--magnum-...] [-h|--help] [-s|--short] [--all-extensions]
[--limits]
@endcode
Arguments: Arguments:
- `-h`, `--help` -- display this help message and exit
- `-s`, `--short` -- display just essential info and exit - `-h`, `--help` --- display this help message and exit
- `--all-extensions` -- display extensions also for fully supported versions - `-s`, `--short` --- display just essential info and exit
- `--limits` -- display also limits and implementation-defined values - `--all-extensions` --- display extensions also for fully supported versions
- `--magnum-...` -- engine-specific options (see @ref Context for details) - `--limits` --- display also limits and implementation-defined values
- `--magnum-...` --- engine-specific options (see @ref Context for details)
@section magnum-info-example Example output @section magnum-info-example Example output
``` @code{.shell-session}
+---------------------------------------------------------+ +---------------------------------------------------------+
| Information about Magnum engine and OpenGL capabilities | | Information about Magnum engine and OpenGL capabilities |
+---------------------------------------------------------+ +---------------------------------------------------------+
@ -131,7 +138,7 @@ Vendor extension support:
GL_ARB_robustness - GL_ARB_robustness -
GL_ARB_robustness_isolation - GL_ARB_robustness_isolation -
... ...
``` @endcode
*/ */

44
src/Magnum/Text/fontconverter.cpp
Unescape View File

@ -62,27 +62,34 @@ namespace Magnum {
@page magnum-fontconverter Font conversion utility @page magnum-fontconverter Font conversion utility
@brief Converts font to raster one of given atlas size @brief Converts font to raster one of given atlas size
@m_footernavigation
@section magnum-fontconverter-usage Usage @section magnum-fontconverter-usage Usage
magnum-fontconverter [--magnum-...] [-h|--help] --font FONT --converter CONVERTER [--plugin-dir DIR] [--characters CHARACTERS] [--font-size N] [--atlas-size "X Y"] [--output-size "X Y"] [--radius N] [--] input output @code{.shell-session}
magnum-fontconverter [--magnum-...] [-h|--help] --font FONT
--converter CONVERTER [--plugin-dir DIR] [--characters CHARACTERS]
[--font-size N] [--atlas-size "X Y"] [--output-size "X Y"] [--radius N]
[--] input output
@endcode
Arguments: Arguments:
- `input` -- input font - `input` --- input font
- `output` -- output filename prefix - `output` --- output filename prefix
- `-h`, `--help` -- display help message and exit - `-h`, `--help` --- display help message and exit
- `--font FONT` -- font plugin - `--font FONT` --- font plugin
- `--converter CONVERTER` -- font converter plugin - `--converter CONVERTER` --- font converter plugin
- `--plugin-dir DIR` -- base plugin dir (defaults to plugin directory in - `--plugin-dir DIR` --- base plugin dir (defaults to plugin directory in
Magnum install location) Magnum install location)
- `--characters CHARACTERS` -- characters to include in the output (default: - `--characters CHARACTERS` --- characters to include in the output (default:
`abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789?!:;,. `) `abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789?!:;,. `)
- `--font-size N` -- input font size (default: `128`) - `--font-size N` --- input font size (default: `128`)
- `--atlas-size "X Y"` -- glyph atlas size (default: `"2048 2048"`) - `--atlas-size "X Y"` --- glyph atlas size (default: `"2048 2048"`)
- `--output-size "X Y"` -- output atlas size. If set to zero size, distance - `--output-size "X Y"` --- output atlas size. If set to zero size, distance
field computation will not be used. (default: `"256 256"`) field computation will not be used. (default: `"256 256"`)
- `--radius N` -- distance field computation radius (default: `24`) - `--radius N` --- distance field computation radius (default: `24`)
- `--magnum-...` -- engine-specific options (see @ref Context for details) - `--magnum-...` --- engine-specific options (see @ref Context for details)
The resulting font files can be then used as specified in the documentation of The resulting font files can be then used as specified in the documentation of
`converter` plugin. `converter` plugin.
@ -93,11 +100,14 @@ Making raster font from TTF file with default set of characters using
@ref Text::FreeTypeFont "FreeTypeFont" font plugin and @ref Text::FreeTypeFont "FreeTypeFont" font plugin and
@ref Text::MagnumFontConverter "MagnumFontConverter" converter plugin: @ref Text::MagnumFontConverter "MagnumFontConverter" converter plugin:
magnum-fontconverter --font FreeTypeFont --converter MagnumFontConverter DejaVuSans.ttf myfont @code{.shell-session}
magnum-fontconverter --font FreeTypeFont --converter MagnumFontConverter DejaVuSans.ttf myfont
@endcode
According to `MagnumFontConverter` plugin documentation, this will generate According to @ref Text::MagnumFontConverter "MagnumFontConverter" plugin
files `myfont.conf` and `myfont.tga` in current directory. You can then load documentation, this will generate files `myfont.conf` and `myfont.tga` in
and use them with the @ref Text::MagnumFont "MagnumFont" plugin. current directory. You can then load and use them via the
@ref Text::MagnumFont "MagnumFont" plugin.
*/ */
namespace Text { namespace Text {

32
src/Magnum/TextureTools/distancefieldconverter.cpp
Unescape View File

@ -67,22 +67,30 @@ namespace Magnum {
/** @page magnum-distancefieldconverter Distance Field conversion utility /** @page magnum-distancefieldconverter Distance Field conversion utility
@brief Converts red channel of an image to distance field representation @brief Converts red channel of an image to distance field representation
@m_footernavigation
@section magnum-distancefieldconverter-usage Usage @section magnum-distancefieldconverter-usage Usage
magnum-distancefieldconverter [--magnum-...] [-h|--help] [--importer IMPORTER] [--converter CONVERTER] [--plugin-dir DIR] --output-size "X Y" --radius N [--] input output @code{.shell-session}
magnum-distancefieldconverter [--magnum-...] [-h|--help] [--importer IMPORTER]
[--converter CONVERTER] [--plugin-dir DIR] --output-size "X Y" --radius N
[--] input output
@endcode
Arguments: Arguments:
- `input` -- input image - `input` --- input image
- `output` -- output image - `output` --- output image
- `-h`, `--help` -- display help message and exit - `-h`, `--help` --- display help message and exit
- `--importer IMPORTER` -- image importer plugin (default: @ref Trade::AnyImageImporter "AnyImageImporter") - `--importer IMPORTER` --- image importer plugin (default:
- `--converter CONVERTER` -- image converter plugin (default: @ref Trade::AnyImageConverter "AnyImageConverter") @ref Trade::AnyImageImporter "AnyImageImporter")
- `--plugin-dir DIR` -- base plugin dir (defaults to plugin directory in - `--converter CONVERTER` --- image converter plugin (default:
@ref Trade::AnyImageConverter "AnyImageConverter")
- `--plugin-dir DIR` --- base plugin dir (defaults to plugin directory in
Magnum install location) Magnum install location)
- `--output-size "X Y"` -- size of output image - `--output-size "X Y"` --- size of output image
- `--radius N` -- distance field computation radius - `--radius N` --- distance field computation radius
- `--magnum-...` -- engine-specific options (see @ref Context for details) - `--magnum-...` --- engine-specific options (see @ref Context for details)
Images with @ref PixelFormat::Red, @ref PixelFormat::RGB or @ref PixelFormat::RGBA Images with @ref PixelFormat::Red, @ref PixelFormat::RGB or @ref PixelFormat::RGBA
are accepted on input. are accepted on input.
@ -93,7 +101,9 @@ the algorithm and parameters.
@section magnum-distancefield-example Example usage @section magnum-distancefield-example Example usage
magnum-distancefieldconverter --output-size "256 256" --radius 24 logo-src.png logo.png @code{.shell-session}
magnum-distancefieldconverter --output-size "256 256" --radius 24 logo-src.png logo.png
@endcode
This will open monochrome `logo-src.png` image using any plugin that can open This will open monochrome `logo-src.png` image using any plugin that can open
PNG files and converts it to 256x256 distance field `logo.png` using any plugin PNG files and converts it to 256x256 distance field `logo.png` using any plugin

26
src/Magnum/Trade/imageconverter.cpp
Unescape View File

@ -36,31 +36,37 @@
namespace Magnum { namespace Magnum {
/** /** @page magnum-imageconverter Image conversion utility
@page magnum-imageconverter Image conversion utility
@brief Converts images of different formats @brief Converts images of different formats
@m_footernavigation
@section magnum-imageconverter-usage Usage @section magnum-imageconverter-usage Usage
magnum-imageconverter [-h|--help] [--importer IMPORTER] [--converter CONVERTER] [--plugin-dir DIR] [--] input output @code{.shell-session}
magnum-imageconverter [-h|--help] [--importer IMPORTER] [--converter CONVERTER]
[--plugin-dir DIR] [--] input output
@endcode
Arguments: Arguments:
- `input` -- input image - `input` --- input image
- `output` -- output image - `output` --- output image
- `-h`, `--help` -- display this help message and exit - `-h`, `--help` --- display this help message and exit
- `--importer IMPORTER` -- image importer plugin (default: - `--importer IMPORTER` --- image importer plugin (default:
@ref Trade::AnyImageImporter "AnyImageImporter") @ref Trade::AnyImageImporter "AnyImageImporter")
- `--converter CONVERTER` -- image converter plugin (default: - `--converter CONVERTER` --- image converter plugin (default:
@ref Trade::AnyImageConverter "AnyImageConverter") @ref Trade::AnyImageConverter "AnyImageConverter")
- `--plugin-dir DIR` -- base plugin dir (defaults to plugin directory in - `--plugin-dir DIR` --- base plugin dir (defaults to plugin directory in
Magnum install location) Magnum install location)
@section magnum-imageconverter-example Example usage @section magnum-imageconverter-example Example usage
Converting a JPEG file to a PNG: Converting a JPEG file to a PNG:
magnum-imageconverter image.jpg image.png @code{.shell-session}
magnum-imageconverter image.jpg image.png
@endcode
*/ */

Write Preview
Loading…
Cancel
Save