Browse Source

doc: mention also OpenGL version for optionally used extensions.

pull/51/head
Vladimír Vondruš 12 years ago
parent
commit
29deb70f23
  1. 6
      src/Magnum/AbstractObject.h
  2. 12
      src/Magnum/AbstractShaderProgram.h
  3. 16
      src/Magnum/AbstractTexture.h
  4. 16
      src/Magnum/Buffer.h
  5. 12
      src/Magnum/Framebuffer.h
  6. 12
      src/Magnum/Mesh.h
  7. 12
      src/Magnum/Query.h
  8. 8
      src/Magnum/RectangleTexture.h
  9. 12
      src/Magnum/Renderbuffer.h
  10. 12
      src/Magnum/Shader.h
  11. 9
      src/Magnum/Texture.h

6
src/Magnum/AbstractObject.h

@ -50,9 +50,9 @@ class MAGNUM_EXPORT AbstractObject {
* @brief Max object label length * @brief Max object label length
* *
* 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{KHR,debug} desktop or ES extension is * OpenGL calls. If OpenGL 4.3 is not supported and @extension{KHR,debug}
* not available, returns `0`. Note that @extension2{EXT,debug_label} * desktop or ES extension is not available, returns `0`. Note that
* has no such limit. * @extension2{EXT,debug_label} has no such limit.
* @see @ref AbstractQuery::setLabel(), @ref AbstractShaderProgram::setLabel(), * @see @ref AbstractQuery::setLabel(), @ref AbstractShaderProgram::setLabel(),
* @ref AbstractTexture::setLabel(), @ref Buffer::setLabel(), * @ref AbstractTexture::setLabel(), @ref Buffer::setLabel(),
* @ref BufferTexture::setLabel(), @ref Framebuffer::setLabel(), * @ref BufferTexture::setLabel(), @ref Framebuffer::setLabel(),

12
src/Magnum/AbstractShaderProgram.h

@ -517,9 +517,9 @@ class MAGNUM_EXPORT AbstractShaderProgram: public AbstractObject {
* @brief %Shader program label * @brief %Shader program label
* *
* The result is *not* cached, repeated queries will result in repeated * The result is *not* cached, repeated queries will result in repeated
* OpenGL calls. If neither @extension{KHR,debug} nor * OpenGL calls. If OpenGL 4.3 is not supported and neither
* @extension2{EXT,debug_label} desktop or ES extension is available, * @extension{KHR,debug} nor @extension2{EXT,debug_label} desktop or ES
* this function returns empty string. * extension is available, this function returns empty string.
* @see @fn_gl{GetObjectLabel} with @def_gl{PROGRAM} or * @see @fn_gl{GetObjectLabel} with @def_gl{PROGRAM} or
* @fn_gl_extension2{GetObjectLabel,EXT,debug_label} with * @fn_gl_extension2{GetObjectLabel,EXT,debug_label} with
* @def_gl{PROGRAM_OBJECT_EXT} * @def_gl{PROGRAM_OBJECT_EXT}
@ -530,9 +530,9 @@ class MAGNUM_EXPORT AbstractShaderProgram: public AbstractObject {
* @brief Set shader program label * @brief Set shader program label
* @return Reference to self (for method chaining) * @return Reference to self (for method chaining)
* *
* Default is empty string. If neither @extension{KHR,debug} nor * Default is empty string. If OpenGL 4.3 is not supported and neither
* @extension2{EXT,debug_label} desktop or ES extension is available, * @extension{KHR,debug} nor @extension2{EXT,debug_label} desktop or ES
* this function does nothing. * extension is available, this function does nothing.
* @see @ref maxLabelLength(), @fn_gl{ObjectLabel} with * @see @ref maxLabelLength(), @fn_gl{ObjectLabel} with
* @def_gl{PROGRAM} or @fn_gl_extension2{LabelObject,EXT,debug_label} * @def_gl{PROGRAM} or @fn_gl_extension2{LabelObject,EXT,debug_label}
* with @def_gl{PROGRAM_OBJECT_EXT} * with @def_gl{PROGRAM_OBJECT_EXT}

16
src/Magnum/AbstractTexture.h

@ -83,8 +83,8 @@ You can use functions @ref Texture::invalidateImage() and
@ref Texture::invalidateSubImage() "invalidateSubImage()" if you don't need @ref Texture::invalidateSubImage() "invalidateSubImage()" if you don't need
texture data anymore to avoid unnecessary memory operations performed by OpenGL texture data anymore to avoid unnecessary memory operations performed by OpenGL
in order to preserve the data. If running on OpenGL ES or extension in order to preserve the data. If running on OpenGL ES or extension
@extension{ARB,invalidate_subdata} is not available, these functions do @extension{ARB,invalidate_subdata} (part of OpenGL 4.3) is not available, these
nothing. functions do nothing.
@todo all texture [level] parameters, global texture parameters @todo all texture [level] parameters, global texture parameters
@todo Add glPixelStore encapsulation @todo Add glPixelStore encapsulation
@ -180,9 +180,9 @@ class MAGNUM_EXPORT AbstractTexture: public AbstractObject {
* @brief %Texture label * @brief %Texture label
* *
* The result is *not* cached, repeated queries will result in repeated * The result is *not* cached, repeated queries will result in repeated
* OpenGL calls. If neither @extension{KHR,debug} nor * OpenGL calls. If OpenGL 4.3 is not supported and neither
* @extension2{EXT,debug_label} desktop or ES extension is available, * @extension{KHR,debug} nor @extension2{EXT,debug_label} desktop or ES
* this function returns empty string. * extension is available, this function returns empty string.
* @see @fn_gl{GetObjectLabel} or * @see @fn_gl{GetObjectLabel} or
* @fn_gl_extension2{GetObjectLabel,EXT,debug_label} with * @fn_gl_extension2{GetObjectLabel,EXT,debug_label} with
* @def_gl{TEXTURE} * @def_gl{TEXTURE}
@ -193,9 +193,9 @@ class MAGNUM_EXPORT AbstractTexture: public AbstractObject {
* @brief Set texture label * @brief Set texture label
* @return Reference to self (for method chaining) * @return Reference to self (for method chaining)
* *
* Default is empty string. If neither @extension{KHR,debug} nor * Default is empty string. If OpenGL 4.3 is not supported and neither
* @extension2{EXT,debug_label} desktop or ES extension is available, * @extension{KHR,debug} nor @extension2{EXT,debug_label} desktop or ES
* this function does nothing. * extension is available, this function does nothing.
* @see @ref maxLabelLength(), @fn_gl{ObjectLabel} or * @see @ref maxLabelLength(), @fn_gl{ObjectLabel} or
* @fn_gl_extension2{LabelObject,EXT,debug_label} with * @fn_gl_extension2{LabelObject,EXT,debug_label} with
* @def_gl{TEXTURE} * @def_gl{TEXTURE}

16
src/Magnum/Buffer.h

@ -185,8 +185,8 @@ and @ref unmap() use DSA functions to avoid unnecessary calls to
You can use functions @ref invalidateData() and @ref invalidateSubData() if you You can use functions @ref invalidateData() and @ref invalidateSubData() if you
don't need buffer data anymore to avoid unnecessary memory operations performed don't need buffer data anymore to avoid unnecessary memory operations performed
by OpenGL in order to preserve the data. If running on OpenGL ES or extension by OpenGL in order to preserve the data. If running on OpenGL ES or extension
@extension{ARB,invalidate_subdata} is not available, these functions do @extension{ARB,invalidate_subdata} (part of OpenGL 4.3) is not available, these
nothing. functions do nothing.
*/ */
class MAGNUM_EXPORT Buffer: public AbstractObject { class MAGNUM_EXPORT Buffer: public AbstractObject {
friend struct Implementation::BufferState; friend struct Implementation::BufferState;
@ -544,9 +544,9 @@ class MAGNUM_EXPORT Buffer: public AbstractObject {
* @brief %Buffer label * @brief %Buffer label
* *
* The result is *not* cached, repeated queries will result in repeated * The result is *not* cached, repeated queries will result in repeated
* OpenGL calls. If neither @extension{KHR,debug} nor * OpenGL calls. If OpenGL 4.3 is not supported and neither
* @extension2{EXT,debug_label} desktop or ES extension is available, * @extension{KHR,debug} nor @extension2{EXT,debug_label} desktop or ES
* this function returns empty string. * extension is available, this function returns empty string.
* @see @fn_gl{GetObjectLabel} with @def_gl{BUFFER} or * @see @fn_gl{GetObjectLabel} with @def_gl{BUFFER} or
* @fn_gl_extension2{GetObjectLabel,EXT,debug_label} with * @fn_gl_extension2{GetObjectLabel,EXT,debug_label} with
* @def_gl{BUFFER_OBJECT_EXT} * @def_gl{BUFFER_OBJECT_EXT}
@ -557,9 +557,9 @@ class MAGNUM_EXPORT Buffer: public AbstractObject {
* @brief Set buffer label * @brief Set buffer label
* @return Reference to self (for method chaining) * @return Reference to self (for method chaining)
* *
* Default is empty string. If neither @extension{KHR,debug} nor * Default is empty string. If OpenGL 4.3 is not supported and neither
* @extension2{EXT,debug_label} desktop or ES extension is available, * @extension{KHR,debug} nor @extension2{EXT,debug_label} desktop or ES
* this function does nothing. * extension is available, this function does nothing.
* @see @ref maxLabelLength(), @fn_gl{ObjectLabel} with @def_gl{BUFFER} * @see @ref maxLabelLength(), @fn_gl{ObjectLabel} with @def_gl{BUFFER}
* or @fn_gl_extension2{LabelObject,EXT,debug_label} with * or @fn_gl_extension2{LabelObject,EXT,debug_label} with
* @def_gl{BUFFER_OBJECT_EXT} * @def_gl{BUFFER_OBJECT_EXT}

12
src/Magnum/Framebuffer.h

@ -333,9 +333,9 @@ class MAGNUM_EXPORT Framebuffer: public AbstractFramebuffer, public AbstractObje
* @brief %Framebuffer label * @brief %Framebuffer label
* *
* The result is *not* cached, repeated queries will result in repeated * The result is *not* cached, repeated queries will result in repeated
* OpenGL calls. If neither @extension{KHR,debug} nor * OpenGL calls. If OpenGL 4.3 is not supported and neither
* @extension2{EXT,debug_label} desktop or ES extension is available, * @extension{KHR,debug} nor @extension2{EXT,debug_label} desktop or ES
* this function returns empty string. * extension is available, this function returns empty string.
* @see @fn_gl{GetObjectLabel} or * @see @fn_gl{GetObjectLabel} or
* @fn_gl_extension2{GetObjectLabel,EXT,debug_label} with * @fn_gl_extension2{GetObjectLabel,EXT,debug_label} with
* @def_gl{FRAMEBUFFER} * @def_gl{FRAMEBUFFER}
@ -346,9 +346,9 @@ class MAGNUM_EXPORT Framebuffer: public AbstractFramebuffer, public AbstractObje
* @brief Set framebuffer label * @brief Set framebuffer label
* @return Reference to self (for method chaining) * @return Reference to self (for method chaining)
* *
* Default is empty string. If neither @extension{KHR,debug} nor * Default is empty string. If OpenGL 4.3 is not supported and neither
* @extension2{EXT,debug_label} desktop or ES extension is available, * @extension{KHR,debug} nor @extension2{EXT,debug_label} desktop or ES
* this function does nothing. * extension is available, this function does nothing.
* @see @ref maxLabelLength(), @fn_gl{ObjectLabel} or * @see @ref maxLabelLength(), @fn_gl{ObjectLabel} or
* @fn_gl_extension2{LabelObject,EXT,debug_label} with * @fn_gl_extension2{LabelObject,EXT,debug_label} with
* @def_gl{FRAMEBUFFER} * @def_gl{FRAMEBUFFER}

12
src/Magnum/Mesh.h

@ -426,9 +426,9 @@ class MAGNUM_EXPORT Mesh: public AbstractObject {
* @brief %Mesh label * @brief %Mesh label
* *
* The result is *not* cached, repeated queries will result in repeated * The result is *not* cached, repeated queries will result in repeated
* OpenGL calls. If neither @extension{KHR,debug} nor * OpenGL calls. If OpenGL 4.3 is not supported and neither
* @extension2{EXT,debug_label} desktop or ES extension is available, * @extension{KHR,debug} nor @extension2{EXT,debug_label} desktop or ES
* this function returns empty string. * extension is available, this function returns empty string.
* @see @fn_gl{GetObjectLabel} with @def_gl{VERTEX_ARRAY} or * @see @fn_gl{GetObjectLabel} with @def_gl{VERTEX_ARRAY} or
* @fn_gl_extension2{GetObjectLabel,EXT,debug_label} with * @fn_gl_extension2{GetObjectLabel,EXT,debug_label} with
* @def_gl{VERTEX_ARRAY_OBJECT_EXT} * @def_gl{VERTEX_ARRAY_OBJECT_EXT}
@ -439,9 +439,9 @@ class MAGNUM_EXPORT Mesh: public AbstractObject {
* @brief Set mesh label * @brief Set mesh label
* @return Reference to self (for method chaining) * @return Reference to self (for method chaining)
* *
* Default is empty string. If neither @extension{KHR,debug} nor * Default is empty string. If OpenGL 4.3 is not supported and neither
* @extension2{EXT,debug_label} desktop or ES extension is available, * @extension{KHR,debug} nor @extension2{EXT,debug_label} desktop or ES
* this function does nothing. * extension is available, this function does nothing.
* @see @ref maxLabelLength(), @fn_gl{ObjectLabel} with * @see @ref maxLabelLength(), @fn_gl{ObjectLabel} with
* @def_gl{VERTEX_ARRAY} or @fn_gl_extension2{LabelObject,EXT,debug_label} * @def_gl{VERTEX_ARRAY} or @fn_gl_extension2{LabelObject,EXT,debug_label}
* with @def_gl{VERTEX_ARRAY_OBJECT_EXT} * with @def_gl{VERTEX_ARRAY_OBJECT_EXT}

12
src/Magnum/Query.h

@ -64,9 +64,9 @@ class MAGNUM_EXPORT AbstractQuery: public AbstractObject {
* @brief %Query label * @brief %Query label
* *
* The result is *not* cached, repeated queries will result in repeated * The result is *not* cached, repeated queries will result in repeated
* OpenGL calls. If neither @extension{KHR,debug} nor * OpenGL calls. If OpenGL 4.3 is not supported and neither
* @extension2{EXT,debug_label} desktop or ES extension is available, * @extension{KHR,debug} nor @extension2{EXT,debug_label} desktop or ES
* this function returns empty string. * extension is available, this function returns empty string.
* @see @fn_gl{GetObjectLabel} with @def_gl{QUERY} or * @see @fn_gl{GetObjectLabel} with @def_gl{QUERY} or
* @fn_gl_extension2{GetObjectLabel,EXT,debug_label} with * @fn_gl_extension2{GetObjectLabel,EXT,debug_label} with
* @def_gl{QUERY_OBJECT_EXT} * @def_gl{QUERY_OBJECT_EXT}
@ -77,9 +77,9 @@ class MAGNUM_EXPORT AbstractQuery: public AbstractObject {
* @brief Set query label * @brief Set query label
* @return Reference to self (for method chaining) * @return Reference to self (for method chaining)
* *
* Default is empty string. If neither @extension{KHR,debug} nor * Default is empty string. If OpenGL 4.3 is not supported and neither
* @extension2{EXT,debug_label} desktop or ES extension is available, * @extension{KHR,debug} nor @extension2{EXT,debug_label} desktop or ES
* this function does nothing. * extension is available, this function does nothing.
* @see @ref maxLabelLength(), @fn_gl{ObjectLabel} with * @see @ref maxLabelLength(), @fn_gl{ObjectLabel} with
* @def_gl{QUERY} or @fn_gl_extension2{LabelObject,EXT,debug_label} * @def_gl{QUERY} or @fn_gl_extension2{LabelObject,EXT,debug_label}
* with @def_gl{QUERY_OBJECT_EXT} * with @def_gl{QUERY_OBJECT_EXT}

8
src/Magnum/RectangleTexture.h

@ -166,10 +166,10 @@ class RectangleTexture: public AbstractTexture {
* allowed. * allowed.
* *
* If @extension{EXT,direct_state_access} is not available, the texture * If @extension{EXT,direct_state_access} is not available, the texture
* is bound to some layer before the operation. If OpenGL 4.2, * is bound to some layer before the operation. If @extension{ARB,texture_storage}
* @extension{ARB,texture_storage}, OpenGL ES 3.0 or * (part of OpenGL 4.2), OpenGL ES 3.0 or @es_extension{EXT,texture_storage}
* @es_extension{EXT,texture_storage} in OpenGL ES 2.0 is not * in OpenGL ES 2.0 is not available, the feature is emulated with
* available, the feature is emulated with @ref setImage() call. * @ref setImage() call.
* @see @fn_gl{ActiveTexture}, @fn_gl{BindTexture} and @fn_gl{TexStorage2D} * @see @fn_gl{ActiveTexture}, @fn_gl{BindTexture} and @fn_gl{TexStorage2D}
* or @fn_gl_extension{TextureStorage2D,EXT,direct_state_access}, * or @fn_gl_extension{TextureStorage2D,EXT,direct_state_access},
* eventually @fn_gl{TexImage2D} or * eventually @fn_gl{TexImage2D} or

12
src/Magnum/Renderbuffer.h

@ -115,9 +115,9 @@ class MAGNUM_EXPORT Renderbuffer: public AbstractObject {
* @brief %Renderbuffer label * @brief %Renderbuffer label
* *
* The result is *not* cached, repeated queries will result in repeated * The result is *not* cached, repeated queries will result in repeated
* OpenGL calls. If neither @extension{KHR,debug} nor * OpenGL calls. If OpenGL 4.3 is not supported and neither
* @extension2{EXT,debug_label} desktop or ES extension is available, * @extension{KHR,debug} nor @extension2{EXT,debug_label} desktop or ES
* this function returns empty string. * extension is available, this function returns empty string.
* @see @fn_gl{GetObjectLabel} or * @see @fn_gl{GetObjectLabel} or
* @fn_gl_extension2{GetObjectLabel,EXT,debug_label} with * @fn_gl_extension2{GetObjectLabel,EXT,debug_label} with
* @def_gl{RENDERBUFFER} * @def_gl{RENDERBUFFER}
@ -128,9 +128,9 @@ class MAGNUM_EXPORT Renderbuffer: public AbstractObject {
* @brief Set renderbuffer label * @brief Set renderbuffer label
* @return Reference to self (for method chaining) * @return Reference to self (for method chaining)
* *
* Default is empty string. If neither @extension{KHR,debug} nor * Default is empty string. If OpenGL 4.3 is not supported and neither
* @extension2{EXT,debug_label} desktop or ES extension is available, * @extension{KHR,debug} nor @extension2{EXT,debug_label} desktop or ES
* this function does nothing. * extension is available, this function does nothing.
* @see @ref maxLabelLength(), @fn_gl{ObjectLabel} or * @see @ref maxLabelLength(), @fn_gl{ObjectLabel} or
* @fn_gl_extension2{LabelObject,EXT,debug_label} with * @fn_gl_extension2{LabelObject,EXT,debug_label} with
* @def_gl{RENDERBUFFER} * @def_gl{RENDERBUFFER}

12
src/Magnum/Shader.h

@ -471,9 +471,9 @@ class MAGNUM_EXPORT Shader: public AbstractObject {
* @brief %Shader label * @brief %Shader label
* *
* The result is *not* cached, repeated queries will result in repeated * The result is *not* cached, repeated queries will result in repeated
* OpenGL calls. If neither @extension{KHR,debug} nor * OpenGL calls. If OpenGL 4.3 is not supported and neither
* @extension2{EXT,debug_label} desktop or ES extension is available, * @extension{KHR,debug} nor @extension2{EXT,debug_label} desktop or ES
* this function returns empty string. * extension is available, this function returns empty string.
* @see @fn_gl{GetObjectLabel} with @def_gl{SHADER} or * @see @fn_gl{GetObjectLabel} with @def_gl{SHADER} or
* @fn_gl_extension2{GetObjectLabel,EXT,debug_label} with * @fn_gl_extension2{GetObjectLabel,EXT,debug_label} with
* @def_gl{SHADER_OBJECT_EXT} * @def_gl{SHADER_OBJECT_EXT}
@ -484,9 +484,9 @@ class MAGNUM_EXPORT Shader: public AbstractObject {
* @brief Set shader label * @brief Set shader label
* @return Reference to self (for method chaining) * @return Reference to self (for method chaining)
* *
* Default is empty string. If neither @extension{KHR,debug} nor * Default is empty string. If OpenGL 4.3 is not supported and neither
* @extension2{EXT,debug_label} desktop or ES extension is available, * @extension{KHR,debug} nor @extension2{EXT,debug_label} desktop or ES
* this function does nothing. * extension is available, this function does nothing.
* @see @ref maxLabelLength(), @fn_gl{ObjectLabel} with * @see @ref maxLabelLength(), @fn_gl{ObjectLabel} with
* @def_gl{SHADER} or @fn_gl_extension2{LabelObject,EXT,debug_label} * @def_gl{SHADER} or @fn_gl_extension2{LabelObject,EXT,debug_label}
* with @def_gl{SHADER_OBJECT_EXT} * with @def_gl{SHADER_OBJECT_EXT}

9
src/Magnum/Texture.h

@ -296,11 +296,10 @@ template<UnsignedInt dimensions> class Texture: public AbstractTexture {
* allowed. * allowed.
* *
* If @extension{EXT,direct_state_access} is not available, the texture * If @extension{EXT,direct_state_access} is not available, the texture
* is bound to some layer before the operation. If OpenGL 4.2, * is bound to some layer before the operation. If @extension{ARB,texture_storage}
* @extension{ARB,texture_storage}, OpenGL ES 3.0 or * (part of OpenGL 4.2), OpenGL ES 3.0 or @es_extension{EXT,texture_storage}
* @es_extension{EXT,texture_storage} in OpenGL ES 2.0 is not * in OpenGL ES 2.0 is not available, the feature is emulated with
* available, the feature is emulated with sequence of @ref setImage() * sequence of @ref setImage() calls.
* calls.
* @see @fn_gl{ActiveTexture}, @fn_gl{BindTexture} and * @see @fn_gl{ActiveTexture}, @fn_gl{BindTexture} and
* @fn_gl{TexStorage1D}/@fn_gl{TexStorage2D}/@fn_gl{TexStorage3D} * @fn_gl{TexStorage1D}/@fn_gl{TexStorage2D}/@fn_gl{TexStorage3D}
* or @fn_gl_extension{TextureStorage1D,EXT,direct_state_access}/ * or @fn_gl_extension{TextureStorage1D,EXT,direct_state_access}/

Loading…
Cancel
Save