Browse Source

Doc++, updated credits and changelog.

pull/364/head
Vladimír Vondruš 7 years ago
parent
commit
8131701e7e
  1. 2
      doc/changelog.dox
  2. 2
      doc/credits.dox
  3. 2
      src/Magnum/GL/AbstractFramebuffer.h
  4. 8
      src/Magnum/GL/Texture.h

2
doc/changelog.dox

@ -459,6 +459,8 @@ See also:
[mosra/magnum#211](https://github.com/mosra/magnum/issues/211)) [mosra/magnum#211](https://github.com/mosra/magnum/issues/211))
- Fixed Gentoo build instructions (see - Fixed Gentoo build instructions (see
[mosra/magnum#344](https://github.com/mosra/magnum/pull/344)) [mosra/magnum#344](https://github.com/mosra/magnum/pull/344))
- Various documentation improvements and copy editing (see
[mosra/magnum#361](https://github.com/mosra/magnum/pull/361))
@subsection changelog-latest-deprecated Deprecated APIs @subsection changelog-latest-deprecated Deprecated APIs

2
doc/credits.dox

@ -146,6 +146,8 @@ Are the below lists missing your name or something's wrong?
--- initial macOS port, various other improvements --- initial macOS port, various other improvements
- **Nathan Ollerenshaw** ([\@matjam](https://github.com/matjam)) --- Ubuntu - **Nathan Ollerenshaw** ([\@matjam](https://github.com/matjam)) --- Ubuntu
packages in a PPA repository packages in a PPA repository
- **Nick Skelsey** ([\@NSkelsey](https://github.com/NSkelsey)) ---
documentation copy-editing
- **Nicholas "LB" Branden** ([\@LB--](https://github.com/LB--)) --- warning - **Nicholas "LB" Branden** ([\@LB--](https://github.com/LB--)) --- warning
fixes, Windows buildsystem improvements fixes, Windows buildsystem improvements
- **Olga Turanksaya** ([\@olga-python](https://github.com/olga-python)) --- - **Olga Turanksaya** ([\@olga-python](https://github.com/olga-python)) ---

2
src/Magnum/GL/AbstractFramebuffer.h

@ -382,7 +382,7 @@ class MAGNUM_GL_EXPORT AbstractFramebuffer {
* given image. The storage is not reallocated if it is large enough to * given image. The storage is not reallocated if it is large enough to
* contain the new data --- however if you want to read into existing * contain the new data --- however if you want to read into existing
* memory or *ensure* a reallocation does not happen, use * memory or *ensure* a reallocation does not happen, use
* @ref read(const Range2Di&, MutableImageView2D&) instead. * @ref read(const Range2Di&, const MutableImageView2D&) instead.
* *
* On OpenGL ES 2.0 and WebGL 1.0, if @ref PixelStorage::skip() is set, * On OpenGL ES 2.0 and WebGL 1.0, if @ref PixelStorage::skip() is set,
* the functionality is emulated by adjusting the data pointer. If * the functionality is emulated by adjusting the data pointer. If

8
src/Magnum/GL/Texture.h

@ -757,7 +757,7 @@ template<UnsignedInt dimensions> class Texture: public AbstractTexture {
* @ref imageSize(). The storage is not reallocated if it is large * @ref imageSize(). The storage is not reallocated if it is large
* enough to contain the new data --- however if you want to read into * enough to contain the new data --- however if you want to read into
* existing memory or *ensure* a reallocation does not happen, use * existing memory or *ensure* a reallocation does not happen, use
* @ref image(Int, BasicMutableImageView<dimensions>&) instead. * @ref image(Int, const BasicMutableImageView<dimensions>&) instead.
* *
* If @gl_extension{ARB,direct_state_access} (part of OpenGL 4.5) is * If @gl_extension{ARB,direct_state_access} (part of OpenGL 4.5) is
* not available, the texture is bound before the operation (if not * not available, the texture is bound before the operation (if not
@ -834,7 +834,7 @@ template<UnsignedInt dimensions> class Texture: public AbstractTexture {
* size is taken using @ref imageSize(). The storage is not reallocated * size is taken using @ref imageSize(). The storage is not reallocated
* if it is large enough to contain the new data --- however if you * if it is large enough to contain the new data --- however if you
* want to read into existing memory or *ensure* a reallocation does * want to read into existing memory or *ensure* a reallocation does
* not happen, use @ref compressedImage(Int, BasicMutableCompressedImageView<dimensions>&) * not happen, use @ref compressedImage(Int, const BasicMutableCompressedImageView<dimensions>&)
* instead. * instead.
* *
* If @gl_extension{ARB,direct_state_access} (part of OpenGL 4.5) is * If @gl_extension{ARB,direct_state_access} (part of OpenGL 4.5) is
@ -920,7 +920,7 @@ template<UnsignedInt dimensions> class Texture: public AbstractTexture {
* given image. The storage is not reallocated if it is large enough to * given image. The storage is not reallocated if it is large enough to
* contain the new data --- however if you want to read into existing * contain the new data --- however if you want to read into existing
* memory or *ensure* a reallocation does not happen, use * memory or *ensure* a reallocation does not happen, use
* @ref subImage(Int, const RangeTypeFor<dimensions, Int>&, BasicMutableImageView<dimensions>&) * @ref subImage(Int, const RangeTypeFor<dimensions, Int>&, const BasicMutableImageView<dimensions>&)
* instead. * instead.
* *
* The operation is protected from buffer overflow. * The operation is protected from buffer overflow.
@ -990,7 +990,7 @@ template<UnsignedInt dimensions> class Texture: public AbstractTexture {
* storage is not reallocated if it is large enough to contain the new * storage is not reallocated if it is large enough to contain the new
* data --- however if you want to read into existing memory or * data --- however if you want to read into existing memory or
* *ensure* a reallocation does not happen, use * *ensure* a reallocation does not happen, use
* @ref compressedSubImage(Int, const RangeTypeFor<dimensions, Int>&, BasicMutableCompressedImageView<dimensions>&) * @ref compressedSubImage(Int, const RangeTypeFor<dimensions, Int>&, const BasicMutableCompressedImageView<dimensions>&)
* instead. * instead.
* @see @fn_gl2{GetTextureLevelParameter,GetTexLevelParameter}, * @see @fn_gl2{GetTextureLevelParameter,GetTexLevelParameter},
* eventually @fn_gl{GetTexLevelParameter} with * eventually @fn_gl{GetTexLevelParameter} with

Loading…
Cancel
Save