Browse Source

Doc++

pull/68/head
Vladimír Vondruš 12 years ago
parent
commit
056ada8b99
  1. 2
      doc/cmake.dox
  2. 2
      doc/opengl-support.dox
  3. 4
      src/Magnum/AbstractFramebuffer.h
  4. 4
      src/Magnum/Framebuffer.h
  5. 6
      src/Magnum/Renderbuffer.h
  6. 4
      src/Magnum/Renderer.h
  7. 8
      src/Magnum/TextureArray.h

2
doc/cmake.dox

@ -103,7 +103,7 @@ Platform namespace is split into more components:
- `%WindowlessWglApplication` -- @ref Platform::WindowlessWglApplication "WindowlessWglApplication" - `%WindowlessWglApplication` -- @ref Platform::WindowlessWglApplication "WindowlessWglApplication"
For manual context creation (without application wrappers) there are also For manual context creation (without application wrappers) there are also
platform-specific context libraries (see @ref platfom-custom for more platform-specific context libraries (see @ref platform-custom for more
information): information):
- `CglContext` -- CGL context - `CglContext` -- CGL context

2
doc/opengl-support.dox

@ -108,7 +108,7 @@ following:
%Extension | Status %Extension | Status
-------------------------------------------- | ------ -------------------------------------------- | ------
@extension{ARB,instanced_arrays} | done @extension{ARB,instanced_arrays} | done
@extension{ARB,blend_func_extended} | missing limit query @extension{ARB,blend_func_extended} | done
@extension{ARB,explicit_attrib_location} | done (shading language only) @extension{ARB,explicit_attrib_location} | done (shading language only)
@extension{ARB,occlusion_query2} | done @extension{ARB,occlusion_query2} | done
@extension{ARB,sampler_objects} | | @extension{ARB,sampler_objects} | |

4
src/Magnum/AbstractFramebuffer.h

@ -195,8 +195,8 @@ class MAGNUM_EXPORT AbstractFramebuffer {
* @brief Max supported dual-source draw buffer count * @brief Max supported dual-source draw buffer count
* *
* The result is cached, repeated queries don't result in repeated * The result is cached, repeated queries don't result in repeated
* OpenGL calls. If extension @extension{ARB,blend_func_extended} is * OpenGL calls. If extension @extension{ARB,blend_func_extended} (part
* not available, returns `0`. * of OpenGL 3.3) is not available, returns `0`.
* @see @ref DefaultFramebuffer::mapForDraw(), @ref Framebuffer::mapForDraw(), * @see @ref DefaultFramebuffer::mapForDraw(), @ref Framebuffer::mapForDraw(),
* @fn_gl{Get} with @def_gl{MAX_DUAL_SOURCE_DRAW_BUFFERS} * @fn_gl{Get} with @def_gl{MAX_DUAL_SOURCE_DRAW_BUFFERS}
* @requires_gl Multiple blending inputs are not available in * @requires_gl Multiple blending inputs are not available in

4
src/Magnum/Framebuffer.h

@ -293,8 +293,8 @@ class MAGNUM_EXPORT Framebuffer: public AbstractFramebuffer, public AbstractObje
* @brief Max supported color attachment count * @brief Max supported color attachment count
* *
* The result is cached, repeated queries don't result in repeated * The result is cached, repeated queries don't result in repeated
* OpenGL calls. If ES extension @extension{NV,fbo_color_attachments} * OpenGL calls. If neither OpenGL ES 3.0 nor ES extension
* is not available, returns `0`. * @extension{NV,fbo_color_attachments} is available, returns `0`.
* @see @ref mapForDraw(), @fn_gl{Get} with @def_gl{MAX_COLOR_ATTACHMENTS} * @see @ref mapForDraw(), @fn_gl{Get} with @def_gl{MAX_COLOR_ATTACHMENTS}
*/ */
static Int maxColorAttachments(); static Int maxColorAttachments();

6
src/Magnum/Renderbuffer.h

@ -75,9 +75,9 @@ class MAGNUM_EXPORT Renderbuffer: public AbstractObject {
* @brief Max supported sample count * @brief Max supported sample count
* *
* The result is cached, repeated queries don't result in repeated * The result is cached, repeated queries don't result in repeated
* OpenGL calls. If ES extension @es_extension{ANGLE,framebuffer_multisample} * OpenGL calls. If neither OpenGL ES 3.0 nor ES extension
* or @es_extension{NV,framebuffer_multisample} is not available, * @es_extension{ANGLE,framebuffer_multisample} /
* returns `0`. * @es_extension{NV,framebuffer_multisample} is available, returns `0`.
* @see @ref setStorageMultisample(), @fn_gl{Get} with @def_gl{MAX_SAMPLES} * @see @ref setStorageMultisample(), @fn_gl{Get} with @def_gl{MAX_SAMPLES}
*/ */
static Int maxSamples(); static Int maxSamples();

4
src/Magnum/Renderer.h

@ -452,8 +452,8 @@ class MAGNUM_EXPORT Renderer {
* *
* Initial value is `1.0f`. * Initial value is `1.0f`.
* @see @ref Feature::ProgramPointSize, @fn_gl{PointSize} * @see @ref Feature::ProgramPointSize, @fn_gl{PointSize}
* @requires_gl In OpenGL ES use `gl_PointSize` builtin vertex shader * @requires_gl Use `gl_PointSize` builtin vertex shader variable in
* variable. * OpenGL ES instead.
*/ */
static void setPointSize(Float size); static void setPointSize(Float size);
#endif #endif

8
src/Magnum/TextureArray.h

@ -400,13 +400,19 @@ template<UnsignedInt dimensions> class TextureArray: public AbstractTexture {
/** /**
@brief One-dimensional texture array @brief One-dimensional texture array
@requires_gl30 %Extension @extension{EXT,texture_array}
@requires_gl Only @ref Magnum::Texture2DArray "Texture2DArray" is available in @requires_gl Only @ref Magnum::Texture2DArray "Texture2DArray" is available in
OpenGL ES. OpenGL ES.
*/ */
typedef TextureArray<1> Texture1DArray; typedef TextureArray<1> Texture1DArray;
#endif #endif
/** @brief Two-dimensional texture array */ /**
@brief Two-dimensional texture array
@requires_gl30 %Extension @extension{EXT,texture_array}
@requires_gles30 %Array textures are not available in OpenGL ES 2.0.
*/
typedef TextureArray<2> Texture2DArray; typedef TextureArray<2> Texture2DArray;
} }

Loading…
Cancel
Save