Browse Source

Trade: doc++

pull/565/merge
Vladimír Vondruš 4 years ago
parent
commit
a4561716f6
  1. 57
      src/Magnum/Trade/AbstractImageConverter.h

57
src/Magnum/Trade/AbstractImageConverter.h

@ -572,36 +572,39 @@ based on what features are supported.
You don't need to do most of the redundant sanity checks, these things are You don't need to do most of the redundant sanity checks, these things are
checked by the implementation: checked by the implementation:
- The function @ref doConvert(const ImageView2D&) is called only if - The @ref doConvert(const ImageView2D&) function is called only if
@ref ImageConverterFeature::Convert2D is supported and equivalently for the @ref ImageConverterFeature::Convert2D is supported; equivalently for the
1D and 3D case. 1D and 3D case.
- The function @ref doConvert(const CompressedImageView2D&) is called only if - The @ref doConvert(const CompressedImageView2D&) function is called only if
@ref ImageConverterFeature::ConvertCompressed2D is supported and @ref ImageConverterFeature::ConvertCompressed2D is supported; equivalently
equivalently for the 1D and 3D case. for the 1D and 3D case.
- The function @ref doConvertToData(const ImageView2D&) is called only if - The @ref doConvertToData(const ImageView2D&) function is called only if
@ref ImageConverterFeature::Convert2DToData is supported and equivalently @ref ImageConverterFeature::Convert2DToData is supported; equivalently
for the 1D and 3D case. for the 1D and 3D case.
- The function @ref doConvertToData(Containers::ArrayView<const ImageView2D>) - The @ref doConvertToData(Containers::ArrayView<const ImageView2D>) function
is called only if @ref ImageConverterFeature::ConvertLevels2DToData is is called only if @ref ImageConverterFeature::ConvertLevels2DToData is
supported and equivalently for the 1D and 3D case. supported; equivalently for the 1D and 3D case.
- The function @ref doConvertToData(const CompressedImageView2D&) is called - The @ref doConvertToData(const CompressedImageView2D&) function is called
only if @ref ImageConverterFeature::ConvertCompressed2DToData is supported only if @ref ImageConverterFeature::ConvertCompressed2DToData is supported;
and equivalently for the 1D and 3D case. equivalently for the 1D and 3D case.
- The function @ref doConvertToData(Containers::ArrayView<const CompressedImageView2D>) - The @ref doConvertToData(Containers::ArrayView<const CompressedImageView2D>)
is called only if @ref ImageConverterFeature::ConvertCompressedLevels2DToData function is called only if
is supported and equivalently for the 1D and 3D case. @ref ImageConverterFeature::ConvertCompressedLevels2DToData is supported;
- The function @ref doConvertToFile(const ImageView2D&, Containers::StringView) equivalently for the 1D and 3D case.
is called only if @ref ImageConverterFeature::Convert2DToFile is supported - The @ref doConvertToFile(const ImageView2D&, Containers::StringView)
and equivalently for the 1D and 3D case. function is called only if @ref ImageConverterFeature::Convert2DToFile is
- The function @ref doConvertToFile(Containers::ArrayView<const ImageView2D>, Containers::StringView) supported; equivalently for the 1D and 3D case.
is called only if @ref ImageConverterFeature::ConvertLevels2DToFile is - The @ref doConvertToFile(Containers::ArrayView<const ImageView2D>, Containers::StringView)
supported and equivalently for the 1D and 3D case. function is called only if @ref ImageConverterFeature::ConvertLevels2DToFile
- The function @ref doConvertToFile(const CompressedImageView2D&, Containers::StringView) is supported; equivalently for the 1D and 3D case.
is called only if @ref ImageConverterFeature::ConvertCompressed2DToFile is - The @ref doConvertToFile(const CompressedImageView2D&, Containers::StringView)
supported and equivalently for the 1D and 3D case. function is called only if
- The function @ref doConvertToFile(Containers::ArrayView<const CompressedImageView2D>, Containers::StringView) @ref ImageConverterFeature::ConvertCompressed2DToFile is supported;
is called only if @ref ImageConverterFeature::ConvertCompressedLevels2DToFile equivalently for the 1D and 3D case.
is supported and equivalently for the 1D and 3D case. - The @ref doConvertToFile(Containers::ArrayView<const CompressedImageView2D>, Containers::StringView)
function is called only if
@ref ImageConverterFeature::ConvertCompressedLevels2DToFile is supported;
equivalently for the 1D and 3D case.
- All @ref doConvertToData() and @ref doConvertToFile() functions taking a - All @ref doConvertToData() and @ref doConvertToFile() functions taking a
single (compressed) image are called only if the image has a non-zero size single (compressed) image are called only if the image has a non-zero size
in all dimensions and the view is not @cpp nullptr @ce. Note that this does in all dimensions and the view is not @cpp nullptr @ce. Note that this does

Loading…
Cancel
Save