Browse Source

GL: minor doc improvements for textures.

Not great, not terrible.
pull/525/head
Vladimír Vondruš 5 years ago
parent
commit
1e835c2552
  1. 8
      src/Magnum/GL/AbstractTexture.h
  2. 15
      src/Magnum/GL/Texture.h

8
src/Magnum/GL/AbstractTexture.h

@ -55,10 +55,10 @@ namespace Implementation {
/**
@brief Base for textures
Encapsulates one OpenGL texture object. See @ref Texture, @ref TextureArray,
@ref CubeMapTexture, @ref CubeMapTextureArray, @ref RectangleTexture,
@ref BufferTexture and @ref MultisampleTexture documentation for more
information and usage examples.
Wraps an OpenGL texture object. Meant to be only used through
subclasses, see @ref Texture, @ref TextureArray, @ref CubeMapTexture,
@ref CubeMapTextureArray, @ref RectangleTexture, @ref BufferTexture and
@ref MultisampleTexture documentation for more information and usage examples.
@section GL-AbstractTexture-webgl-restrictions WebGL restrictions

15
src/Magnum/GL/Texture.h

@ -65,8 +65,7 @@ namespace Implementation {
/**
@brief Texture
Template class for one- to three-dimensional textures. See also
@ref AbstractTexture documentation for more information.
Template class for one- to three-dimensional textures. See @ref AbstractTexture documentation for a common interface shared by all texture types.
@section GL-Texture-usage Usage
@ -83,12 +82,12 @@ trilinear anisotropic filtering, i.e. the best you can ask for:
of the mip chain or call @ref setMinificationFilter() with another value to
disable mipmapping.
In shader, the texture is used via @glsl sampler1D @ce / @glsl sampler2D @ce /
@glsl sampler3D @ce, @glsl sampler1DShadow @ce / @glsl sampler2DShadow @ce /
@glsl sampler3DShadow @ce, @glsl isampler1D @ce / @glsl isampler2D @ce /
@glsl isampler3D @ce or @glsl usampler1D @ce / @glsl usampler2D @ce /
@glsl usampler3D @ce. See @ref AbstractShaderProgram documentation for more
information about usage in shaders.
In a shader, the texture is used via @glsl sampler1D @ce / @glsl sampler2D @ce
/ @glsl sampler3D @ce, @glsl sampler1DShadow @ce / @glsl sampler2DShadow @ce,
@glsl isampler1D @ce / @glsl isampler2D @ce / @glsl isampler3D @ce or
@glsl usampler1D @ce / @glsl usampler2D @ce / @glsl usampler3D @ce. See
@ref AbstractShaderProgram documentation for more information about usage in
shaders.
@see @ref Texture1D, @ref Texture2D, @ref Texture3D, @ref TextureArray,
@ref CubeMapTexture, @ref CubeMapTextureArray, @ref RectangleTexture,

Loading…
Cancel
Save