Browse Source

doc: avoid referencing the deprecated Math::swizzle() function.

mousecapture
Vladimír Vondruš 6 years ago
parent
commit
3b940f2509
  1. 4
      doc/changelog-old.dox
  2. 2
      src/Magnum/GL/Texture.h
  3. 2
      src/Magnum/Math/Vector3.h
  4. 6
      src/Magnum/Math/Vector4.h

4
doc/changelog-old.dox

@ -422,7 +422,7 @@ for a high-level overview.
- Removed deprecated @cpp Matrix2 @ce and @cpp Matrix2d @ce typedefs, use - Removed deprecated @cpp Matrix2 @ce and @cpp Matrix2d @ce typedefs, use
@ref Matrix2x2 and @ref Matrix2x2d instead @ref Matrix2x2 and @ref Matrix2x2d instead
- Removed deprecated `Magnum/Swizzle.h` header and @cpp Magnum::swizzle() @ce - Removed deprecated `Magnum/Swizzle.h` header and @cpp Magnum::swizzle() @ce
function, use @ref Magnum/Math/Swizzle.h and @ref Math::swizzle() function, use @ref Magnum/Math/Swizzle.h and @cpp Math::swizzle() @ce
instead instead
- Removed deprecated @cpp *::maxSupported*() @ce limit queries, use the - Removed deprecated @cpp *::maxSupported*() @ce limit queries, use the
less verbose @cpp *::max*() @ce versions instead less verbose @cpp *::max*() @ce versions instead
@ -708,7 +708,7 @@ for a high-level overview.
- @cpp Matrix2 @ce and @cpp Matrix2d @ce is deprecated, use @ref Matrix2x2 - @cpp Matrix2 @ce and @cpp Matrix2d @ce is deprecated, use @ref Matrix2x2
and @ref Matrix2x2d instead and @ref Matrix2x2d instead
- @cpp swizzle() @ce is deprecated, all of its functionality has been moved - @cpp swizzle() @ce is deprecated, all of its functionality has been moved
into @ref Math::swizzle() into @cpp Math::swizzle() @ce
- @cpp Buffer::setData() @ce and @cpp Buffer::setSubData() @ce overloads - @cpp Buffer::setData() @ce and @cpp Buffer::setSubData() @ce overloads
taking pair of data pointer and size are deprecated, use taking pair of data pointer and size are deprecated, use
@cpp Containers::ArrayReference @ce-based @cpp Buffer::setData() @ce and @cpp Containers::ArrayReference @ce-based @cpp Buffer::setData() @ce and

2
src/Magnum/GL/Texture.h

@ -601,7 +601,7 @@ template<UnsignedInt dimensions> class Texture: public AbstractTexture {
* You can use letters @cpp 'r' @ce, @cpp 'g' @ce, @cpp 'b' @ce, * You can use letters @cpp 'r' @ce, @cpp 'g' @ce, @cpp 'b' @ce,
* @cpp 'a' @ce for addressing components or letters @cpp '0' @ce and * @cpp 'a' @ce for addressing components or letters @cpp '0' @ce and
* @cpp '1' @ce for zero and one, similarly as in the * @cpp '1' @ce for zero and one, similarly as in the
* @ref Math::swizzle() function. Example usage: * @ref Math::gather() function. Example usage:
* *
* @snippet MagnumGL.cpp Texture-setSwizzle * @snippet MagnumGL.cpp Texture-setSwizzle
* *

2
src/Magnum/Math/Vector3.h

@ -223,7 +223,7 @@ template<class T> class Vector3: public Vector<3, T> {
* @brief XY part of the vector * @brief XY part of the vector
* @return First two components of the vector * @return First two components of the vector
* *
* @see @ref swizzle() * @see @ref gather(), @ref scatter()
*/ */
Vector2<T>& xy() { return Vector2<T>::from(Vector<3, T>::data()); } Vector2<T>& xy() { return Vector2<T>::from(Vector<3, T>::data()); }
constexpr const Vector2<T> xy() const { constexpr const Vector2<T> xy() const {

6
src/Magnum/Math/Vector4.h

@ -182,7 +182,7 @@ template<class T> class Vector4: public Vector<4, T> {
* @brief XYZ part of the vector * @brief XYZ part of the vector
* @return First three components of the vector * @return First three components of the vector
* *
* @see @ref swizzle(), @ref rgb() * @see @ref rgb(), @ref gather(), @ref scatter()
*/ */
Vector3<T>& xyz() { return Vector3<T>::from(Vector<4, T>::data()); } Vector3<T>& xyz() { return Vector3<T>::from(Vector<4, T>::data()); }
constexpr const Vector3<T> xyz() const { constexpr const Vector3<T> xyz() const {
@ -194,7 +194,7 @@ template<class T> class Vector4: public Vector<4, T> {
* @return First three components of the vector * @return First three components of the vector
* *
* Equivalent to @ref xyz(). * Equivalent to @ref xyz().
* @see @ref swizzle() * @see @ref gather(), @ref scatter()
*/ */
Vector3<T>& rgb() { return Vector3<T>::from(Vector<4, T>::data()); } Vector3<T>& rgb() { return Vector3<T>::from(Vector<4, T>::data()); }
constexpr const Vector3<T> rgb() const { constexpr const Vector3<T> rgb() const {
@ -205,7 +205,7 @@ template<class T> class Vector4: public Vector<4, T> {
* @brief XY part of the vector * @brief XY part of the vector
* @return First two components of the vector * @return First two components of the vector
* *
* @see @ref swizzle() * @see @ref gather(), @ref scatter()
*/ */
Vector2<T>& xy() { return Vector2<T>::from(Vector<4, T>::data()); } Vector2<T>& xy() { return Vector2<T>::from(Vector<4, T>::data()); }
constexpr const Vector2<T> xy() const { constexpr const Vector2<T> xy() const {

Loading…
Cancel
Save