Browse Source

doc: avoid linking to deprecated features.

pull/371/head
Vladimír Vondruš 6 years ago
parent
commit
513f3f5392
  1. 2
      doc/changelog-old.dox
  2. 26
      doc/changelog.dox
  3. 2
      src/Magnum/Shaders/DistanceFieldVector.h
  4. 8
      src/Magnum/Shaders/VertexColor.h
  5. 5
      src/Magnum/Text/AbstractFont.h
  6. 6
      src/Magnum/Text/DistanceFieldGlyphCache.h
  7. 2
      src/Magnum/TextureTools/DistanceField.h
  8. 2
      src/Magnum/TextureTools/distancefieldconverter.cpp

2
doc/changelog-old.dox

@ -137,7 +137,7 @@ for a high-level overview.
@subsection changelog-2015-05-bugfixes Bug fixes
- Fixed @ref TextureTools::distanceField() to work in GLSL < 4.20 (see
- Fixed @cpp TextureTools::distanceField() @ce to work in GLSL < 4.20 (see
[mosra/magnum#62](https://github.com/mosra/magnum/issues/62)).
- Fixed @ref Shaders::MeshVisualizer to work in GLSL ES.
- Fixed @ref Shaders::Vector "Shaders::*Vector" on Intel GPUs.

26
doc/changelog.dox

@ -848,7 +848,7 @@ Released 2019-10-24, tagged as
@subsubsection changelog-2019-10-changes-texturetools TextureTools library
- @ref TextureTools::distanceField() was updated to work on ES3 SwiftShader
- @ref TextureTools::DistanceField was updated to work on ES3 SwiftShader
contexts (which have broken @glsl gl_VertexID @ce)
@subsubsection changelog-2019-10-changes-platform Platform libraries
@ -1640,10 +1640,10 @@ Released 2018-10-23, tagged as
combined transformation matrix. See @ref Trade::ObjectData2D::transformation()
and @ref Trade::ObjectData3D::transformation() for more information.
- Support for file loading callbacks in @ref Trade::AbstractImporter
- Debug output for @ref Trade::AbstractImporter::Feature,
@ref Trade::AbstractImageConverter::Feature enums and
@ref Trade::AbstractImporter::Features,
@ref Trade::AbstractImageConverter::Features enum sets
- Debug output for @cpp Trade::AbstractImporter::Feature @ce,
@cpp Trade::AbstractImageConverter::Feature @ce enums and
@cpp Trade::AbstractImporter::Features @ce,
@cpp Trade::AbstractImageConverter::Features @ce enum sets
- @ref Trade::AnyImageImporter "AnyImageImporter" plugin now supports
detection and loading of DDS, EXR, HDR, JPEG, PNG and TGA files from data
next to file type detection based on filename
@ -1768,9 +1768,9 @@ Released 2018-10-23, tagged as
@subsubsection changelog-2018-10-changes-texturetools TextureTools library
- Fixed @ref TextureTools::distanceField() to not require more than 8 texture
units, which is the limit on all iOS ES2 contexts, independently on the
device (ES3 contexts have 16).
- Fixed @cpp TextureTools::distanceField() @ce to not require more than 8
texture units, which is the limit on all iOS ES2 contexts, independently on
the device (ES3 contexts have 16).
@subsubsection changelog-2018-10-changes-trade Trade library
@ -1856,7 +1856,7 @@ Released 2018-10-23, tagged as
a proper documented default value instead of being left uninitialized.
- @ref Math::sclerp() was not properly interpolating the translation if
rotation was the same on both sides
- Improved @ref TextureTools::distanceField() to work better on shader
- Improved @cpp TextureTools::distanceField() @ce to work better on shader
compilers that have problems compiling nested loops (WebGL implementations,
some ES2 devices)
- @ref SceneGraph::AbstractObject::addFeature() and
@ -2568,7 +2568,7 @@ a high-level overview.
- Added templated version of @ref GL::Buffer::map() "Buffer::map*()"
functions
- New `BUILD_MULTITHREADED` @ref cmake "CMake option" and a corresponding
@ref MAGNUM_BUILD_MULTITHREADED CMake variable and preprocessor define
@cpp MAGNUM_BUILD_MULTITHREADED @ce CMake variable and preprocessor define
- Added @ref GL::Framebuffer::detach() "Framebuffer::detach()" as a
conunterpart to all the @ref GL::Framebuffer::attachTexture() "attach*()"
functions
@ -2953,8 +2953,8 @@ a high-level overview.
- Various compatibility updates to the @ref Shaders library
- Updates to OpenGL tests to work better on non-NVidia cards
- Various fixes for OpenGL object label queries on AMD drivers
- Fixed @ref TextureTools::distanceField() on 3.0 &lt;= GL < 3.2
- Fixed driver crash on AMD with @ref TextureTools::distanceField()
- Fixed @cpp TextureTools::distanceField() @ce on 3.0 &lt;= GL < 3.2
- Fixed driver crash on AMD with @cpp TextureTools::distanceField() @ce
- @ref GL::Framebuffer::attachCubeMapTexture() "Framebuffer::attachCubeMapTexture()"
incorrectly behaved as a layered attachment (see
[mosra/magnum#123](https://github.com/mosra/magnum/issues/123))
@ -3076,7 +3076,7 @@ a high-level overview.
@ref Magnum/Math/Packing.h header instead
- @ref Trade::MeshData2D and @ref Trade::MeshData3D constructors without the
`colors` parameter are deprecated, use the full ones instead
- @ref Shaders::Generic::Color vertex attribute implicit constructor is
- @cpp Shaders::Generic::Color @ce vertex attribute implicit constructor is
deprecated, use a constructor with explicit component count instead
- The bundled @ref std::optional implementation was causing serious conflicts
with C++17 and it's now deprecated in favor of

2
src/Magnum/Shaders/DistanceFieldVector.h

@ -39,7 +39,7 @@ namespace Magnum { namespace Shaders {
@brief Distance field vector shader
Renders vector graphics in a form of signed distance field. See
@ref TextureTools::distanceField() for more information. Note that the final
@ref TextureTools::DistanceField for more information. Note that the final
rendered outlook will greatly depend on radius of input distance field and
value passed to @ref setSmoothness(). You need to provide @ref Position and
@ref TextureCoordinates attributes in your triangle mesh and call at least

8
src/Magnum/Shaders/VertexColor.h

@ -39,10 +39,10 @@ namespace Magnum { namespace Shaders {
/**
@brief Vertex color shader
Draws vertex-colored mesh. You need to provide @ref Position and @ref Color
attributes in your triangle mesh. By default, the shader renders the mesh in
an identity transformation. Use @ref setTransformationProjectionMatrix() to
configure the shader.
Draws a vertex-colored mesh. You need to provide @ref Position and @ref Color3
/ @ref Color4 attributes in your triangle mesh. By default, the shader renders
the mesh in an identity transformation. Use
@ref setTransformationProjectionMatrix() to configure the shader.
@image html shaders-vertexcolor.png width=256px

5
src/Magnum/Text/AbstractFont.h

@ -345,10 +345,7 @@ class MAGNUM_TEXT_EXPORT AbstractFont: public PluginManager::AbstractPlugin {
* @param size Font size
*
* Closes previous file, if it was opened, and tries to open given
* file. If the plugin has @ref FontFeature::MultiFile, the function
* will use additional files in given path, all sharing common basename
* derived from @p filename. Returns @cpp true @ce on success,
* @cpp false @ce otherwise.
* file. Returns @cpp true @ce on success, @cpp false @ce otherwise.
*/
bool openFile(const std::string& filename, Float size);

6
src/Magnum/Text/DistanceFieldGlyphCache.h

@ -55,7 +55,7 @@ resulting distance field texture.
@ref MAGNUM_TARGET_GL enabled (done by default). See @ref building-features
for more information.
@see @ref TextureTools::distanceField()
@see @ref TextureTools::DistanceField
*/
class MAGNUM_TEXT_EXPORT DistanceFieldGlyphCache: public GlyphCache {
public:
@ -65,8 +65,8 @@ class MAGNUM_TEXT_EXPORT DistanceFieldGlyphCache: public GlyphCache {
* @param size Actual glyph cache texture size
* @param radius Distance field computation radius
*
* See @ref TextureTools::distanceField() for more information about
* the parameters. Sets internal texture format to red channel only. On
* See @ref TextureTools::DistanceField for more information about the
* parameters. Sets internal texture format to red channel only. On
* desktop OpenGL requires @gl_extension{ARB,texture_rg} (also part of
* OpenGL ES 3.0), in ES2 uses @gl_extension{EXT,texture_rg} if
* available or @ref GL::TextureFormat::RGB as fallback.

2
src/Magnum/TextureTools/DistanceField.h

@ -26,7 +26,7 @@
*/
/** @file
* @brief Function @ref Magnum::TextureTools::distanceField()
* @brief Class @ref Magnum::TextureTools::DistanceField
*/
#include "Magnum/configure.h"

2
src/Magnum/TextureTools/distancefieldconverter.cpp

@ -114,7 +114,7 @@ Images with @ref PixelFormat::R8Unorm, @ref PixelFormat::RGB8Unorm or
@ref PixelFormat::RGBA8Unorm are accepted on input.
The resulting image can be then used with @ref Shaders::DistanceFieldVector
shader. See also @ref TextureTools::distanceField() for more information about
shader. See also @ref TextureTools::DistanceField for more information about
the algorithm and parameters.
@section magnum-distancefield-example Example usage

Loading…
Cancel
Save