Browse Source

Document how *Flag::Quiet and *Flag::Verbose is used by plugins.

pull/620/head
Vladimír Vondruš 3 years ago
parent
commit
73f5f0b8b0
  1. 5
      src/MagnumPlugins/AnyImageConverter/AnyImageConverter.h
  2. 5
      src/MagnumPlugins/AnyImageImporter/AnyImageImporter.h
  3. 5
      src/MagnumPlugins/AnySceneConverter/AnySceneConverter.h
  4. 5
      src/MagnumPlugins/AnySceneImporter/AnySceneImporter.h
  5. 5
      src/MagnumPlugins/AnyShaderConverter/AnyConverter.h
  6. 4
      src/MagnumPlugins/TgaImageConverter/TgaImageConverter.h
  7. 4
      src/MagnumPlugins/TgaImporter/TgaImporter.h

5
src/MagnumPlugins/AnyImageConverter/AnyImageConverter.h

@ -134,6 +134,11 @@ empty string.
The output of the @ref convertToFile() function called on the concrete The output of the @ref convertToFile() function called on the concrete
implementation is then proxied back. implementation is then proxied back.
Besides delegating the flags, the @ref AnyImageConverter itself recognizes
@ref ImageConverterFlag::Verbose, printing info about the concrete plugin being
used when the flag is enabled. @ref ImageConverterFlag::Quiet is recognized as
well and causes all warnings to be suppressed.
*/ */
class MAGNUM_ANYIMAGECONVERTER_EXPORT AnyImageConverter: public AbstractImageConverter { class MAGNUM_ANYIMAGECONVERTER_EXPORT AnyImageConverter: public AbstractImageConverter {
public: public:

5
src/MagnumPlugins/AnyImageImporter/AnyImageImporter.h

@ -161,6 +161,11 @@ Calls to the @ref image1DCount() / @ref image2DCount() / @ref image3DCount(),
and @ref image1D() / @ref image2D() / @ref image3D() functions are then proxied and @ref image1D() / @ref image2D() / @ref image3D() functions are then proxied
to the concrete implementation. The @ref close() function closes and discards to the concrete implementation. The @ref close() function closes and discards
the internally instantiated plugin; @ref isOpened() works as usual. the internally instantiated plugin; @ref isOpened() works as usual.
Besides delegating the flags, the @ref AnyImageImporter itself recognizes
@ref ImporterFlag::Verbose, printing info about the concrete plugin being used
when the flag is enabled. @ref ImporterFlag::Quiet is recognized as well and
causes all warnings to be suppressed.
*/ */
class MAGNUM_ANYIMAGEIMPORTER_EXPORT AnyImageImporter: public AbstractImporter { class MAGNUM_ANYIMAGEIMPORTER_EXPORT AnyImageImporter: public AbstractImporter {
public: public:

5
src/MagnumPlugins/AnySceneConverter/AnySceneConverter.h

@ -121,6 +121,11 @@ advertising support for any actual data types. These are included only once
Calls to the @ref endFile(), @ref add() and related functions are then proxied Calls to the @ref endFile(), @ref add() and related functions are then proxied
to the concrete implementation. The @ref abort() function aborts and destroys to the concrete implementation. The @ref abort() function aborts and destroys
the internally instantiated plugin; @ref isConverting() works as usual. the internally instantiated plugin; @ref isConverting() works as usual.
Besides delegating the flags, the @ref AnySceneConverter itself recognizes
@ref SceneConverterFlag::Verbose, printing info about the concrete plugin being
used when the flag is enabled. @ref SceneConverterFlag::Quiet is recognized as
well and causes all warnings to be suppressed.
*/ */
class MAGNUM_ANYSCENECONVERTER_EXPORT AnySceneConverter: public AbstractSceneConverter { class MAGNUM_ANYSCENECONVERTER_EXPORT AnySceneConverter: public AbstractSceneConverter {
public: public:

5
src/MagnumPlugins/AnySceneImporter/AnySceneImporter.h

@ -157,6 +157,11 @@ plugin; @ref isOpened() works as usual.
While the @ref meshAttributeName(), @ref meshAttributeForName(), While the @ref meshAttributeName(), @ref meshAttributeForName(),
@ref sceneFieldName() and @ref sceneFieldForName() APIs can be called without a @ref sceneFieldName() and @ref sceneFieldForName() APIs can be called without a
file opened, they return an empty string or an invalid attribute in that case. file opened, they return an empty string or an invalid attribute in that case.
Besides delegating the flags, the @ref AnySceneImporter itself recognizes
@ref ImporterFlag::Verbose, printing info about the concrete plugin being used
when the flag is enabled. @ref ImporterFlag::Quiet is recognized as well and
causes all warnings to be suppressed.
*/ */
class MAGNUM_ANYSCENEIMPORTER_EXPORT AnySceneImporter: public AbstractImporter { class MAGNUM_ANYSCENEIMPORTER_EXPORT AnySceneImporter: public AbstractImporter {
public: public:

5
src/MagnumPlugins/AnyShaderConverter/AnyConverter.h

@ -146,6 +146,11 @@ present in the default configuration of the target plugin.
The output of the @ref validateFile() / @ref validateData(), The output of the @ref validateFile() / @ref validateData(),
@ref convertFileToFile() / @ref convertFileToData() / @ref convertDataToData() @ref convertFileToFile() / @ref convertFileToData() / @ref convertDataToData()
function called on the concrete implementation is then proxied back. function called on the concrete implementation is then proxied back.
Besides delegating the flags, the @ref AnyConverter itself recognizes
@ref ConverterFlag::Verbose, printing info about the concrete plugin being used
when the flag is enabled. @ref ConverterFlag::Quiet is recognized as well and
causes all warnings to be suppressed.
*/ */
class MAGNUM_ANYSHADERCONVERTER_EXPORT AnyConverter: public AbstractConverter { class MAGNUM_ANYSHADERCONVERTER_EXPORT AnyConverter: public AbstractConverter {
public: public:

4
src/MagnumPlugins/TgaImageConverter/TgaImageConverter.h

@ -114,6 +114,10 @@ While TGA files can have several extensions, @ref extension() always returns
@cpp "tga" @ce as that's the most common one. As TGA doesn't have a registered @cpp "tga" @ce as that's the most common one. As TGA doesn't have a registered
MIME type, @ref mimeType() returns @cpp "image/x-tga" @ce. MIME type, @ref mimeType() returns @cpp "image/x-tga" @ce.
The converter recognizes @ref ImageConverterFlag::Verbose, printing additional
info when the flag is enabled. @ref ImageConverterFlag::Quiet is recognized as
well and causes all conversion warnings to be suppressed.
@section Trade-TgaImageConverter-configuration Plugin-specific configuration @section Trade-TgaImageConverter-configuration Plugin-specific configuration
It's possible to tune various output options through @ref configuration(). See It's possible to tune various output options through @ref configuration(). See

4
src/MagnumPlugins/TgaImporter/TgaImporter.h

@ -108,6 +108,10 @@ RLE compression is supported, paletted images are not.
If a TGA 2 footer is recognized in the file, the optional extension and If a TGA 2 footer is recognized in the file, the optional extension and
developer area blocks at the end of the file are ignored. developer area blocks at the end of the file are ignored.
The importer recognizes @ref ImporterFlag::Verbose, printing additional info
when the flag is enabled. @ref ImporterFlag::Quiet is recognized as well and
causes all import warnings to be suppressed.
*/ */
class MAGNUM_TGAIMPORTER_EXPORT TgaImporter: public AbstractImporter { class MAGNUM_TGAIMPORTER_EXPORT TgaImporter: public AbstractImporter {
public: public:

Loading…
Cancel
Save