Browse Source

Doc++, updated credits & changelog.

pull/594/head
Vladimír Vondruš 4 years ago
parent
commit
82c9485bc1
  1. 10
      doc/changelog.dox
  2. 6
      doc/credits.dox
  3. 12
      src/Magnum/GL/AbstractShaderProgram.h
  4. 1
      src/Magnum/GL/Buffer.cpp
  5. 8
      src/Magnum/GL/Buffer.h
  6. 1
      src/Magnum/GL/TransformFeedback.cpp
  7. 10
      src/Magnum/GL/TransformFeedback.h

10
doc/changelog.dox

@ -382,6 +382,9 @@ See also:
- Added an @ref GL::AbstractShaderProgram::setTransformFeedbackOutputs()
overload taking a @relativeref{Corrade,Containers::ArrayView} instead of
a @ref std::initializer_list
- Added @ref GL::Buffer::bind() and @ref GL::TransformFeedback::attachBuffers()
overloads taking a @relativeref{Corrade,Containers::ArrayView} instead of a
@ref std::initializer_list (see [mosra/magnum#588](https://github.com/mosra/magnum/pull/588))
- @ref GL::Buffer::data() and @ref GL::Buffer::subData() is now available on
WebGL 2.0 as well if Emscripten 2.0.17+ is used (see
[mosra/magnum#560](https://github.com/mosra/magnum/pull/560))
@ -1089,6 +1092,13 @@ See also:
on ES2 builds by mistake --- the @gl_extension{EXT,texture_sRGB_R8} and
@gl_extension{EXT,texture_sRGB_RG8} extensions require OpenGL ES 3.0 at
least
- @ref GL::Buffer::bind() and @ref GL::TransformFeedback::attachBuffers()
overloads that used to take a @ref std::initializer_list of @ref std::tuple
are removed, as they caused ambiguity with a new
@relativeref{Corrade,Containers::Triple} overload. If your code used
@ref std::make_tuple() previously, change it to a simple @cpp {} @ce, if
you were already using C++14 @cpp {} @ce tuple construction, you don't need
to change anything.
- @ref Math::Complex::fromMatrix() and @ref Math::Quaternion::fromMatrix()
now additionaly assert that the input matrix is a pure rotation without any
reflections. Before it only asserted for orthogonality, but that led to

6
doc/credits.dox

@ -146,9 +146,9 @@ Are the below lists missing your name or something's wrong?
improvements to Debian package building experience
- **Hilario Pérez Corona** ([\@hpcorona](https://github.com/hpcorona)) ---
improvements to @cb{.cmake} android_create_apk() @ce
- **Hugo Amnov** ([\@hugoam](https://github.com/hugoam)) --- Additions and
performance optimization in the @ref GL library, buildsystem improvements
and STL usage cleanup
- **Hugo Amnov** ([\@hugoam](https://github.com/hugoam)) --- Additions,
usability improvements and performance optimization in the @ref GL library,
buildsystem improvements and STL usage cleanup
- **Ivan P.** ([\@uzername](https://github.com/uzername)) --- documentation
improvements
- **Ivan Sanz Carasa** ([\@isc30](https://github.com/isc30)) --- buildsystem

12
src/Magnum/GL/AbstractShaderProgram.h

@ -303,8 +303,8 @@ layout(binding = 1) uniform sampler2D specularTexture;
If you don't have the required version/extension, declare the uniforms without
the `binding` qualifier and set the texture binding unit using
@ref setUniform(Int, const T&) "setUniform(Int, Int)". Note that additional
syntax changes may be needed for GLSL ES.
@ref setUniform(Int, Int). Note that additional syntax changes may be needed
for GLSL ES.
@code{.glsl}
uniform sampler2D diffuseTexture;
@ -315,13 +315,11 @@ uniform sampler2D specularTexture;
@see @ref Shader::maxTextureImageUnits(), @ref maxImageUnits()
@requires_gl42 Extension @gl_extension{ARB,shading_language_420pack} for explicit
texture binding unit instead of using
@ref setUniform(Int, const T&) "setUniform(Int, Int)".
texture binding unit instead of using @ref setUniform(Int, Int).
@requires_gles31 Explicit texture binding unit is not supported in OpenGL ES
3.0 and older. Use @ref setUniform(Int, const T&) "setUniform(Int, Int)"
instead.
3.0 and older. Use @ref setUniform(Int, Int) instead.
@requires_gles Explicit texture binding unit is not supported in WebGL. Use
@ref setUniform(Int, const T&) "setUniform(Int, Int)" instead.
@ref setUniform(Int, Int) instead.
@subsection GL-AbstractShaderProgram-transform-feedback Specifying transform feedback binding points

1
src/Magnum/GL/Buffer.cpp

@ -4,6 +4,7 @@
Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019,
2020, 2021, 2022 Vladimír Vondruš <mosra@centrum.cz>
Copyright © 2022 Pablo Escobar <mail@rvrs.in>
Copyright @ 2022 Hugo Amiard <hugo.amiard@wonderlandengine.com>
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),

8
src/Magnum/GL/Buffer.h

@ -6,6 +6,7 @@
Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019,
2020, 2021, 2022 Vladimír Vondruš <mosra@centrum.cz>
Copyright © 2022 Pablo Escobar <mail@rvrs.in>
Copyright @ 2022 Hugo Amiard <hugo.amiard@wonderlandengine.com>
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
@ -735,6 +736,7 @@ class MAGNUM_GL_EXPORT Buffer: public AbstractObject {
/**
* @brief Bind ranges of buffers to given range of indexed targets
* @m_since_latest
*
* Binds first buffer in the list to @p firstIndex, second to
* @cpp firstIndex + 1 @ce etc. Second parameter is offset, third is
@ -768,11 +770,15 @@ class MAGNUM_GL_EXPORT Buffer: public AbstractObject {
*/
static void bind(Target target, UnsignedInt firstIndex, Containers::ArrayView<const Containers::Triple<Buffer*, GLintptr, GLsizeiptr>> buffers);
/** @overload */
/**
* @overload
* @m_since_latest
*/
static void bind(Target target, UnsignedInt firstIndex, std::initializer_list<Containers::Triple<Buffer*, GLintptr, GLsizeiptr>> buffers);
/**
* @brief Bind buffers to given range of indexed targets
* @m_since_latest
*
* Binds first buffer in the list to @p firstIndex, second to
* @cpp firstIndex + 1 @ce etc. If any buffer is @cpp nullptr @ce,

1
src/Magnum/GL/TransformFeedback.cpp

@ -3,6 +3,7 @@
Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019,
2020, 2021, 2022 Vladimír Vondruš <mosra@centrum.cz>
Copyright @ 2022 Hugo Amiard <hugo.amiard@wonderlandengine.com>
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),

10
src/Magnum/GL/TransformFeedback.h

@ -5,6 +5,7 @@
Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019,
2020, 2021, 2022 Vladimír Vondruš <mosra@centrum.cz>
Copyright @ 2022 Hugo Amiard <hugo.amiard@wonderlandengine.com>
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
@ -321,6 +322,7 @@ class MAGNUM_GL_EXPORT TransformFeedback: public AbstractObject {
/**
* @brief Attach ranges of buffers
* @return Reference to self (for method chaining)
* @m_since_latest
*
* Attches first buffer in the list to @p firstIndex, second to
* `firstIndex + 1` etc. Second parameter is offset, third is size. If
@ -332,7 +334,7 @@ class MAGNUM_GL_EXPORT TransformFeedback: public AbstractObject {
* @gl_extension{ARB,direct_state_access} (part of OpenGL 4.5) is not
* available, the transform feedback object is bound (if not already)
* and the operation is then done equivalently to
* @ref Buffer::bind(Buffer::Target, UnsignedInt, std::initializer_list<std::tuple<Buffer*, GLintptr, GLsizeiptr>>).
* @ref Buffer::bind(Buffer::Target, UnsignedInt, Containers::ArrayView<const Containers::Triple<Buffer*, GLintptr, GLsizeiptr>>).
* @note This function is meant to be used only internally from
* @ref AbstractShaderProgram subclasses. See its documentation
* for more information.
@ -342,12 +344,16 @@ class MAGNUM_GL_EXPORT TransformFeedback: public AbstractObject {
*/
TransformFeedback& attachBuffers(UnsignedInt firstIndex, Containers::ArrayView<const Containers::Triple<Buffer*, GLintptr, GLsizeiptr>> buffers);
/** @overload */
/**
* @overload
* @m_since_latest
*/
TransformFeedback& attachBuffers(UnsignedInt firstIndex, std::initializer_list<Containers::Triple<Buffer*, GLintptr, GLsizeiptr>> buffers);
/**
* @brief Attach buffers
* @return Reference to self (for method chaining)
* @m_since_latest
*
* Attches first buffer in the list to @p firstIndex, second to
* `firstIndex + 1` etc. If any buffer is @cpp nullptr @ce, given index

Loading…
Cancel
Save