Browse Source

doc: don't link to deprecated APIs, again.

This time for real.
pull/499/head
Vladimír Vondruš 4 years ago
parent
commit
2510a88b8f
  1. 8
      doc/changelog-old.dox
  2. 27
      doc/changelog.dox
  3. 4
      doc/opengl-mapping.dox
  4. 4
      doc/shaders.dox
  5. 2
      src/Magnum/GL/Attribute.h
  6. 7
      src/Magnum/GL/Context.h
  7. 3
      src/Magnum/Trade/AnimationData.h
  8. 3
      src/Magnum/Trade/SkinData.h
  9. 10
      src/MagnumPlugins/AnySceneImporter/AnySceneImporter.h

8
doc/changelog-old.dox

@ -818,9 +818,9 @@ a high-level overview.
@cpp Trade::MeshData3D @ce @cpp Trade::MeshData3D @ce
- @ref Trade::AbstractImageConverter member functions were changed to - @ref Trade::AbstractImageConverter member functions were changed to
non-@cpp const @ce to make implementation of complex converter plugins possible non-@cpp const @ce to make implementation of complex converter plugins possible
- New @ref Trade::AbstractImageConverter::exportToCompressedImage() plugin - New @cpp Trade::AbstractImageConverter::exportToCompressedImage() @ce
interface and @ref Trade::AbstractImageConverter::exportToData(), plugin interface and @cpp Trade::AbstractImageConverter::exportToData() @ce,
@ref Trade::AbstractImageConverter::exportToFile() taking @cpp Trade::AbstractImageConverter::exportToFile() @ce taking
@ref CompressedImageView as a parameter @ref CompressedImageView as a parameter
- Providing access to plugin manager in @ref Trade::AbstractImporter, - Providing access to plugin manager in @ref Trade::AbstractImporter,
@ref Trade::AbstractImageConverter and @ref Audio::AbstractImporter plugin @ref Trade::AbstractImageConverter and @ref Audio::AbstractImporter plugin
@ -865,7 +865,7 @@ a high-level overview.
- R-value @ref Image "Image*" no longer restricts conversion to - R-value @ref Image "Image*" no longer restricts conversion to
@ref ImageView as it is a valid use case (for example passing output from @ref ImageView as it is a valid use case (for example passing output from
@ref GL::Framebuffer::read() "Framebuffer::read()" directly to @ref GL::Framebuffer::read() "Framebuffer::read()" directly to
@ref Trade::AbstractImageConverter::exportToFile()) @cpp Trade::AbstractImageConverter::exportToFile() @ce)
- It's no longer possible to call @ref Image::data() "Image*::data()" on - It's no longer possible to call @ref Image::data() "Image*::data()" on
r-value instances as that would cause accessing freed data. Use r-value instances as that would cause accessing freed data. Use
@ref Image::release() instead. @ref Image::release() instead.

27
doc/changelog.dox

@ -261,7 +261,7 @@ See also:
transformation, instanced texture offset and texture arrays transformation, instanced texture offset and texture arrays
- Support for instanced drawing in @ref Shaders::MeshVisualizerGL2D and - Support for instanced drawing in @ref Shaders::MeshVisualizerGL2D and
@ref Shaders::MeshVisualizerGL3D for better feature parity with the other @ref Shaders::MeshVisualizerGL3D for better feature parity with the other
sahders shaders
- Added @ref Shaders::PhongGL::setNormalTextureScale(), consuming the - Added @ref Shaders::PhongGL::setNormalTextureScale(), consuming the
recently added @ref Trade::MaterialAttribute::NormalTextureScale material recently added @ref Trade::MaterialAttribute::NormalTextureScale material
attribute attribute
@ -833,13 +833,13 @@ See also:
@subsection changelog-latest-deprecated Deprecated APIs @subsection changelog-latest-deprecated Deprecated APIs
- The (mutually exclusive) @ref MAGNUM_TARGET_HEADLESS and - The (mutually exclusive) @cpp MAGNUM_TARGET_HEADLESS @ce and
@ref MAGNUM_TARGET_DESKTOP_GLES options, CMake variables and preprocessor @cpp MAGNUM_TARGET_DESKTOP_GLES @ce options, CMake variables and
variables are deprecated in favor of @ref MAGNUM_TARGET_EGL. It's enabled preprocessor variables are deprecated in favor of @ref MAGNUM_TARGET_EGL.
by default on GLES and disabled by default on desktop GL --- disabling it It's enabled by default on GLES and disabled by default on desktop GL ---
on GLES will force creation of a GLES context using the GLX / WGL libraries disabling it on GLES will force creation of a GLES context using the GLX /
(if available); enabling it on desktop GL will allow running windowless WGL libraries (if available); enabling it on desktop GL will allow running
applications on headless machines. windowless applications on headless machines.
- All @ref building-features "CMake build options" are now prefixed with - All @ref building-features "CMake build options" are now prefixed with
`MAGNUM_`. For backwards compatibility, unless @ref MAGNUM_BUILD_DEPRECATED `MAGNUM_`. For backwards compatibility, unless @ref MAGNUM_BUILD_DEPRECATED
is disabled and unless a prefixed option is already set during the initial is disabled and unless a prefixed option is already set during the initial
@ -1212,12 +1212,11 @@ See also:
implement through the redesigned @ref Trade::MaterialData APIs. However implement through the redesigned @ref Trade::MaterialData APIs. However
these APIs were mainly used to populate the contents in asset importers, so these APIs were mainly used to populate the contents in asset importers, so
this shouldn't cause any breakages in user code. this shouldn't cause any breakages in user code.
- @ref Trade::MaterialData::flags() now calculates the output on-the-fly - The deprecated @ref Trade::MaterialData::flags() now calculates the output
based on what attributes are present. This means that arbitrary extra bits on-the-fly based on what attributes are present. This means that arbitrary
passed to the constructor from @cpp AbstractMaterialData @ce subclasses are extra bits passed to the constructor from @cpp AbstractMaterialData @ce
now discarded, and thus subclasses have to override the subclasses are now discarded, and thus subclasses have to override the
@ref Trade::MaterialData::flags() "flags()" function to keep the same @cpp flags() @ce function to keep the same behavior.
behavior.
- @ref Trade::MaterialData, which the deprecated - @ref Trade::MaterialData, which the deprecated
@cpp Trade::AbstractMaterialData @ce aliases to, doesn't have a @cpp Trade::AbstractMaterialData @ce aliases to, doesn't have a
@cpp virtual @ce destructor as subclasses with extra data members aren't a @cpp virtual @ce destructor as subclasses with extra data members aren't a

4
doc/opengl-mapping.dox

@ -225,7 +225,7 @@ OpenGL function | Matching API
@fn_gl{GetShader}, \n @fn_gl{GetShaderInfoLog} | @ref GL::Shader::compile() @fn_gl{GetShader}, \n @fn_gl{GetShaderInfoLog} | @ref GL::Shader::compile()
@fn_gl{GetShaderPrecisionFormat} | | @fn_gl{GetShaderPrecisionFormat} | |
@fn_gl{GetShaderSource} | not queryable but tracked in @ref GL::Shader::sources() @fn_gl{GetShaderSource} | not queryable but tracked in @ref GL::Shader::sources()
@fn_gl{GetString} | @ref GL::Context::supportedExtensions(), \n @ref GL::Context::rendererString(), \n @ref GL::Context::shadingLanguageVersionString(), \n @ref GL::Context::vendorString(), \n @ref GL::Context::versionString() @fn_gl{GetString} | @ref GL::Context::extensionStrings(), \n @ref GL::Context::rendererString(), \n @ref GL::Context::shadingLanguageVersionString(), \n @ref GL::Context::vendorString(), \n @ref GL::Context::versionString()
@fn_gl{GetSubroutineIndex} | | @fn_gl{GetSubroutineIndex} | |
@fn_gl{GetSubroutineUniformLocation} | | @fn_gl{GetSubroutineUniformLocation} | |
@fn_gl{GetSync} | | @fn_gl{GetSync} | |
@ -536,7 +536,7 @@ glGet() parameter | Matching API
@def_gl{MIN_PROGRAM_TEXEL_OFFSET}, \n @def_gl{MAX_PROGRAM_TEXEL_OFFSET} | @ref GL::AbstractShaderProgram::minTexelOffset(), \n @ref GL::AbstractShaderProgram::maxTexelOffset() @def_gl{MIN_PROGRAM_TEXEL_OFFSET}, \n @def_gl{MAX_PROGRAM_TEXEL_OFFSET} | @ref GL::AbstractShaderProgram::minTexelOffset(), \n @ref GL::AbstractShaderProgram::maxTexelOffset()
@def_gl{MIN_PROGRAM_TEXTURE_GATHER_OFFSET}, \n @def_gl{MAX_PROGRAM_TEXTURE_GATHER_OFFSET} | | @def_gl{MIN_PROGRAM_TEXTURE_GATHER_OFFSET}, \n @def_gl{MAX_PROGRAM_TEXTURE_GATHER_OFFSET} | |
@def_gl{MIN_SAMPLE_SHADING_VALUE} | | @def_gl{MIN_SAMPLE_SHADING_VALUE} | |
@def_gl{NUM_EXTENSIONS} | @ref GL::Context::supportedExtensions() @def_gl{NUM_EXTENSIONS} | @ref GL::Context::extensionStrings()
@def_gl{NUM_PROGRAM_BINARY_FORMATS}, \n @def_gl{PROGRAM_BINARY_FORMATS} | | @def_gl{NUM_PROGRAM_BINARY_FORMATS}, \n @def_gl{PROGRAM_BINARY_FORMATS} | |
@def_gl{NUM_SHADER_BINARY_FORMATS}, \n @def_gl{SHADER_BINARY_FORMATS} | | @def_gl{NUM_SHADER_BINARY_FORMATS}, \n @def_gl{SHADER_BINARY_FORMATS} | |
@def_gl{NUM_SPIR_V_EXTENSIONS} | | @def_gl{NUM_SPIR_V_EXTENSIONS} | |

4
doc/shaders.dox

@ -233,8 +233,8 @@ using the usual vertex color attribute, only instanced:
Unless the shader requires a texture to work (which is the case of Unless the shader requires a texture to work (which is the case of
@ref Shaders::VectorGL and @ref Shaders::DistanceFieldVectorGL), by default all @ref Shaders::VectorGL and @ref Shaders::DistanceFieldVectorGL), by default all
shaders are just colored. Enabling a texture is done via a flag (such as shaders are just colored. Enabling a texture is done via a flag (such as
@ref Shaders::Phong::Flag::DiffuseTexture) and then the texture is bound via an @ref Shaders::PhongGL::Flag::DiffuseTexture) and then the texture is bound via
appropriate `bind*Texture()` call. In most cases the texture value is an appropriate `bind*Texture()` call. In most cases the texture value is
multiplied with the corresponding color uniform. multiplied with the corresponding color uniform.
@snippet MagnumShaders-gl.cpp shaders-textures @snippet MagnumShaders-gl.cpp shaders-textures

2
src/Magnum/GL/Attribute.h

@ -97,7 +97,7 @@ template<UnsignedInt location, class T> class Attribute {
* @m_since{2020,06} * @m_since{2020,06}
* *
* Is @cpp 1 @ce for non-matrix attributes. * Is @cpp 1 @ce for non-matrix attributes.
* @see @ref vectorSize() * @see @ref vectorStride()
*/ */
Vectors = Implementation::Attribute<T>::Vectors, Vectors = Implementation::Attribute<T>::Vectors,

7
src/Magnum/GL/Context.h

@ -662,9 +662,8 @@ class MAGNUM_GL_EXPORT Context {
* The result is *not* cached, repeated queries will result in repeated * The result is *not* cached, repeated queries will result in repeated
* OpenGL calls. Note that this function returns list of all extensions * OpenGL calls. Note that this function returns list of all extensions
* reported by the driver (even those not supported by Magnum), see * reported by the driver (even those not supported by Magnum), see
* @ref supportedExtensions(), @ref Extension::extensions() or * @ref Extension::extensions() or @ref isExtensionSupported() for
* @ref isExtensionSupported() for alternatives. The returned views are * alternatives. The returned views are always @relativeref{Corrade,Containers::StringViewFlag::NullTerminated}
* always @relativeref{Corrade,Containers::StringViewFlag::NullTerminated}
* and @relativeref{Corrade::Containers::StringViewFlag,Global}. * and @relativeref{Corrade::Containers::StringViewFlag,Global}.
* @see @fn_gl{Get} with @def_gl_keyword{NUM_EXTENSIONS}, * @see @fn_gl{Get} with @def_gl_keyword{NUM_EXTENSIONS},
* @fn_gl{GetString} with @def_gl_keyword{EXTENSIONS} * @fn_gl{GetString} with @def_gl_keyword{EXTENSIONS}
@ -772,7 +771,7 @@ class MAGNUM_GL_EXPORT Context {
* Can be used e.g. for listing extensions available on current * Can be used e.g. for listing extensions available on current
* hardware, but for general usage prefer @ref isExtensionSupported() const, * hardware, but for general usage prefer @ref isExtensionSupported() const,
* as it does most operations in compile time. * as it does most operations in compile time.
* @see @ref supportedExtensions(), @ref Extension::extensions(), * @see @ref extensionStrings(), @ref Extension::extensions(),
* @ref MAGNUM_ASSERT_GL_EXTENSION_SUPPORTED() * @ref MAGNUM_ASSERT_GL_EXTENSION_SUPPORTED()
*/ */
bool isExtensionSupported(const Extension& extension) const { bool isExtensionSupported(const Extension& extension) const {

3
src/Magnum/Trade/AnimationData.h

@ -554,8 +554,7 @@ class MAGNUM_TRADE_EXPORT AnimationData {
* @ref AnimationTrackTargetType::Scaling2D, * @ref AnimationTrackTargetType::Scaling2D,
* @ref AnimationTrackTargetType::Scaling3D specifies object which * @ref AnimationTrackTargetType::Scaling3D specifies object which
* property is modified. * property is modified.
* @see @ref trackCount(), @ref AbstractImporter::object2D(), * @see @ref trackCount(), @ref AbstractImporter::scene()
* @ref AbstractImporter::object3D()
*/ */
UnsignedLong trackTarget(UnsignedInt id) const; UnsignedLong trackTarget(UnsignedInt id) const;

3
src/Magnum/Trade/SkinData.h

@ -96,8 +96,7 @@ template<UnsignedInt dimensions> class SkinData {
* @brief Joint IDs * @brief Joint IDs
* *
* IDs of objects that act as joints. * IDs of objects that act as joints.
* @see @ref AbstractImporter::object2D(), * @see @ref AbstractImporter::scene(), @ref releaseJointData()
* @ref AbstractImporter::object3D(), @ref releaseJointData()
*/ */
Containers::ArrayView<const UnsignedInt> joints() const { return _jointData; } Containers::ArrayView<const UnsignedInt> joints() const { return _jointData; }

10
src/MagnumPlugins/AnySceneImporter/AnySceneImporter.h

@ -141,11 +141,11 @@ is emitted in case an option set is not present in the default configuration of
the target plugin. the target plugin.
Calls to the @ref animation(), @ref scene(), @ref light(), @ref camera(), Calls to the @ref animation(), @ref scene(), @ref light(), @ref camera(),
@ref object2D(), @ref object3D(), @ref skin2D(), @ref skin3D(), @ref mesh(), @ref skin2D(), @ref skin3D(), @ref mesh(), @ref material(), @ref texture(),
@ref material(), @ref texture(), @ref image1D(), @ref image2D(), @ref image3D() @ref image1D(), @ref image2D(), @ref image3D() and corresponding
and corresponding count-/name-related functions are then proxied to the count-/name-related functions are then proxied to the concrete implementation.
concrete implementation. The @ref close() function closes and discards the The @ref close() function closes and discards the internally instantiated
internally instantiated plugin; @ref isOpened() works as usual. 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

Loading…
Cancel
Save