diff --git a/doc/changelog-old.dox b/doc/changelog-old.dox index 4f2bb2b79..823ba5289 100644 --- a/doc/changelog-old.dox +++ b/doc/changelog-old.dox @@ -818,9 +818,9 @@ a high-level overview. @cpp Trade::MeshData3D @ce - @ref Trade::AbstractImageConverter member functions were changed to non-@cpp const @ce to make implementation of complex converter plugins possible -- New @ref Trade::AbstractImageConverter::exportToCompressedImage() plugin - interface and @ref Trade::AbstractImageConverter::exportToData(), - @ref Trade::AbstractImageConverter::exportToFile() taking +- New @cpp Trade::AbstractImageConverter::exportToCompressedImage() @ce + plugin interface and @cpp Trade::AbstractImageConverter::exportToData() @ce, + @cpp Trade::AbstractImageConverter::exportToFile() @ce taking @ref CompressedImageView as a parameter - Providing access to plugin manager in @ref Trade::AbstractImporter, @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 @ref ImageView as it is a valid use case (for example passing output from @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 r-value instances as that would cause accessing freed data. Use @ref Image::release() instead. diff --git a/doc/changelog.dox b/doc/changelog.dox index f252b5bcf..f050ad18f 100644 --- a/doc/changelog.dox +++ b/doc/changelog.dox @@ -261,7 +261,7 @@ See also: transformation, instanced texture offset and texture arrays - Support for instanced drawing in @ref Shaders::MeshVisualizerGL2D and @ref Shaders::MeshVisualizerGL3D for better feature parity with the other - sahders + shaders - Added @ref Shaders::PhongGL::setNormalTextureScale(), consuming the recently added @ref Trade::MaterialAttribute::NormalTextureScale material attribute @@ -833,13 +833,13 @@ See also: @subsection changelog-latest-deprecated Deprecated APIs -- The (mutually exclusive) @ref MAGNUM_TARGET_HEADLESS and - @ref MAGNUM_TARGET_DESKTOP_GLES options, CMake variables and preprocessor - variables are deprecated in favor of @ref MAGNUM_TARGET_EGL. It's enabled - by default on GLES and disabled by default on desktop GL --- disabling it - on GLES will force creation of a GLES context using the GLX / WGL libraries - (if available); enabling it on desktop GL will allow running windowless - applications on headless machines. +- The (mutually exclusive) @cpp MAGNUM_TARGET_HEADLESS @ce and + @cpp MAGNUM_TARGET_DESKTOP_GLES @ce options, CMake variables and + preprocessor variables are deprecated in favor of @ref MAGNUM_TARGET_EGL. + It's enabled by default on GLES and disabled by default on desktop GL --- + disabling it on GLES will force creation of a GLES context using the GLX / + WGL libraries (if available); enabling it on desktop GL will allow running + windowless applications on headless machines. - All @ref building-features "CMake build options" are now prefixed with `MAGNUM_`. For backwards compatibility, unless @ref MAGNUM_BUILD_DEPRECATED 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 these APIs were mainly used to populate the contents in asset importers, so this shouldn't cause any breakages in user code. -- @ref Trade::MaterialData::flags() now calculates the output on-the-fly - based on what attributes are present. This means that arbitrary extra bits - passed to the constructor from @cpp AbstractMaterialData @ce subclasses are - now discarded, and thus subclasses have to override the - @ref Trade::MaterialData::flags() "flags()" function to keep the same - behavior. +- The deprecated @ref Trade::MaterialData::flags() now calculates the output + on-the-fly based on what attributes are present. This means that arbitrary + extra bits passed to the constructor from @cpp AbstractMaterialData @ce + subclasses are now discarded, and thus subclasses have to override the + @cpp flags() @ce function to keep the same behavior. - @ref Trade::MaterialData, which the deprecated @cpp Trade::AbstractMaterialData @ce aliases to, doesn't have a @cpp virtual @ce destructor as subclasses with extra data members aren't a diff --git a/doc/opengl-mapping.dox b/doc/opengl-mapping.dox index c5cf38f5c..1f99591e9 100644 --- a/doc/opengl-mapping.dox +++ b/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{GetShaderPrecisionFormat} | | @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{GetSubroutineUniformLocation} | | @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_TEXTURE_GATHER_OFFSET}, \n @def_gl{MAX_PROGRAM_TEXTURE_GATHER_OFFSET} | | @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_SHADER_BINARY_FORMATS}, \n @def_gl{SHADER_BINARY_FORMATS} | | @def_gl{NUM_SPIR_V_EXTENSIONS} | | diff --git a/doc/shaders.dox b/doc/shaders.dox index 9489b5853..bde05664b 100644 --- a/doc/shaders.dox +++ b/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 @ref Shaders::VectorGL and @ref Shaders::DistanceFieldVectorGL), by default all 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 -appropriate `bind*Texture()` call. In most cases the texture value is +@ref Shaders::PhongGL::Flag::DiffuseTexture) and then the texture is bound via +an appropriate `bind*Texture()` call. In most cases the texture value is multiplied with the corresponding color uniform. @snippet MagnumShaders-gl.cpp shaders-textures diff --git a/src/Magnum/GL/Attribute.h b/src/Magnum/GL/Attribute.h index b0c52735e..e6993dad6 100644 --- a/src/Magnum/GL/Attribute.h +++ b/src/Magnum/GL/Attribute.h @@ -97,7 +97,7 @@ template class Attribute { * @m_since{2020,06} * * Is @cpp 1 @ce for non-matrix attributes. - * @see @ref vectorSize() + * @see @ref vectorStride() */ Vectors = Implementation::Attribute::Vectors, diff --git a/src/Magnum/GL/Context.h b/src/Magnum/GL/Context.h index 4f2d202e9..22e844be2 100644 --- a/src/Magnum/GL/Context.h +++ b/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 * OpenGL calls. Note that this function returns list of all extensions * reported by the driver (even those not supported by Magnum), see - * @ref supportedExtensions(), @ref Extension::extensions() or - * @ref isExtensionSupported() for alternatives. The returned views are - * always @relativeref{Corrade,Containers::StringViewFlag::NullTerminated} + * @ref Extension::extensions() or @ref isExtensionSupported() for + * alternatives. The returned views are always @relativeref{Corrade,Containers::StringViewFlag::NullTerminated} * and @relativeref{Corrade::Containers::StringViewFlag,Global}. * @see @fn_gl{Get} with @def_gl_keyword{NUM_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 * hardware, but for general usage prefer @ref isExtensionSupported() const, * 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() */ bool isExtensionSupported(const Extension& extension) const { diff --git a/src/Magnum/Trade/AnimationData.h b/src/Magnum/Trade/AnimationData.h index 317a3fb3b..7967705ad 100644 --- a/src/Magnum/Trade/AnimationData.h +++ b/src/Magnum/Trade/AnimationData.h @@ -554,8 +554,7 @@ class MAGNUM_TRADE_EXPORT AnimationData { * @ref AnimationTrackTargetType::Scaling2D, * @ref AnimationTrackTargetType::Scaling3D specifies object which * property is modified. - * @see @ref trackCount(), @ref AbstractImporter::object2D(), - * @ref AbstractImporter::object3D() + * @see @ref trackCount(), @ref AbstractImporter::scene() */ UnsignedLong trackTarget(UnsignedInt id) const; diff --git a/src/Magnum/Trade/SkinData.h b/src/Magnum/Trade/SkinData.h index a3c5fa8f5..483fb9770 100644 --- a/src/Magnum/Trade/SkinData.h +++ b/src/Magnum/Trade/SkinData.h @@ -96,8 +96,7 @@ template class SkinData { * @brief Joint IDs * * IDs of objects that act as joints. - * @see @ref AbstractImporter::object2D(), - * @ref AbstractImporter::object3D(), @ref releaseJointData() + * @see @ref AbstractImporter::scene(), @ref releaseJointData() */ Containers::ArrayView joints() const { return _jointData; } diff --git a/src/MagnumPlugins/AnySceneImporter/AnySceneImporter.h b/src/MagnumPlugins/AnySceneImporter/AnySceneImporter.h index 8ceade25e..0a905fd16 100644 --- a/src/MagnumPlugins/AnySceneImporter/AnySceneImporter.h +++ b/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. Calls to the @ref animation(), @ref scene(), @ref light(), @ref camera(), -@ref object2D(), @ref object3D(), @ref skin2D(), @ref skin3D(), @ref mesh(), -@ref material(), @ref texture(), @ref image1D(), @ref image2D(), @ref image3D() -and corresponding count-/name-related functions are then proxied to the -concrete implementation. The @ref close() function closes and discards the -internally instantiated plugin; @ref isOpened() works as usual. +@ref skin2D(), @ref skin3D(), @ref mesh(), @ref material(), @ref texture(), +@ref image1D(), @ref image2D(), @ref image3D() and corresponding +count-/name-related functions are then proxied to the concrete implementation. +The @ref close() function closes and discards the internally instantiated +plugin; @ref isOpened() works as usual. While the @ref meshAttributeName(), @ref meshAttributeForName(), @ref sceneFieldName() and @ref sceneFieldForName() APIs can be called without a