Browse Source

Doc++

pull/107/head
Vladimír Vondruš 11 years ago
parent
commit
ce72c4d637
  1. 3
      src/Magnum/AbstractFramebuffer.h
  2. 6
      src/Magnum/AbstractShaderProgram.h
  3. 3
      src/Magnum/AbstractTexture.h
  4. 3
      src/Magnum/Buffer.h
  5. 3
      src/Magnum/TransformFeedback.h

3
src/Magnum/AbstractFramebuffer.h

@ -162,7 +162,8 @@ The engine tracks currently bound framebuffer and current viewport to avoid
unnecessary calls to @fn_gl{BindFramebuffer} and @fn_gl{Viewport} when unnecessary calls to @fn_gl{BindFramebuffer} and @fn_gl{Viewport} when
switching framebuffers. Framebuffer limits and implementation-defined values switching framebuffers. Framebuffer limits and implementation-defined values
(such as @ref maxViewportSize()) are cached, so repeated queries don't result (such as @ref maxViewportSize()) are cached, so repeated queries don't result
in repeated @fn_gl{Get} calls. in repeated @fn_gl{Get} calls. See also @ref Context::resetState() and
@ref Context::State::Framebuffers.
If extension @extension{ARB,direct_state_access} (part of OpenGL 4.5) is If extension @extension{ARB,direct_state_access} (part of OpenGL 4.5) is
available, @ref blit() function uses DSA to avoid unnecessary call to available, @ref blit() function uses DSA to avoid unnecessary call to

6
src/Magnum/AbstractShaderProgram.h

@ -373,8 +373,10 @@ also @ref Attribute::DataType enum for additional type options.
@anchor AbstractShaderProgram-performance-optimization @anchor AbstractShaderProgram-performance-optimization
## Performance optimizations ## Performance optimizations
Shader limits (such as @ref maxVertexAttributes()) are cached, so repeated The engine tracks currently used shader program to avoid unnecessary calls to
queries don't result in repeated @fn_gl{Get} calls. @fn_gl{UseProgram}. Shader limits (such as @ref maxVertexAttributes()) are
cached, so repeated queries don't result in repeated @fn_gl{Get} calls. See
also @ref Context::resetState() and @ref Context::State::Shaders.
If extension @extension{ARB,separate_shader_objects} (part of OpenGL 4.1), If extension @extension{ARB,separate_shader_objects} (part of OpenGL 4.1),
@extension{EXT,direct_state_access} desktop extension, @es_extension{EXT,separate_shader_objects} @extension{EXT,direct_state_access} desktop extension, @es_extension{EXT,separate_shader_objects}

3
src/Magnum/AbstractTexture.h

@ -74,7 +74,8 @@ avoid unnecessary calls to @fn_gl{ActiveTexture} and @fn_gl{BindTexture}.
Texture configuration functions use dedicated highest available texture unit Texture configuration functions use dedicated highest available texture unit
to not affect active bindings in user units. Texture limits and to not affect active bindings in user units. Texture limits and
implementation-defined values (such as @ref maxColorSamples()) are cached, so implementation-defined values (such as @ref maxColorSamples()) are cached, so
repeated queries don't result in repeated @fn_gl{Get} calls. repeated queries don't result in repeated @fn_gl{Get} calls. See also
@ref Context::resetState() and @ref Context::State::Textures.
If @extension{ARB,direct_state_access} (part of OpenGL 4.5) is available, If @extension{ARB,direct_state_access} (part of OpenGL 4.5) is available,
@ref bind(Int) and @ref unbind(Int) use @fn_gl{BindTextureUnit}. Otherwise, if @ref bind(Int) and @ref unbind(Int) use @fn_gl{BindTextureUnit}. Otherwise, if

3
src/Magnum/Buffer.h

@ -210,7 +210,8 @@ and @ref unmap() use that target instead of binding the buffer to some specific
target. You can also use @ref setTargetHint() to possibly reduce unnecessary target. You can also use @ref setTargetHint() to possibly reduce unnecessary
rebinding. Buffer limits and implementation-defined values (such as rebinding. Buffer limits and implementation-defined values (such as
@ref maxUniformBindings()) are cached, so repeated queries don't result in @ref maxUniformBindings()) are cached, so repeated queries don't result in
repeated @fn_gl{Get} calls. repeated @fn_gl{Get} calls. See also @ref Context::resetState() and
@ref Context::State::Buffers.
If either @extension{ARB,direct_state_access} (part of OpenGL 4.5) or If either @extension{ARB,direct_state_access} (part of OpenGL 4.5) or
@extension{EXT,direct_state_access} desktop extension is available, functions @extension{EXT,direct_state_access} desktop extension is available, functions

3
src/Magnum/TransformFeedback.h

@ -49,7 +49,8 @@ namespace Implementation { struct TransformFeedbackState; }
The engine tracks currently bound transform feedback to avoid unnecessary calls The engine tracks currently bound transform feedback to avoid unnecessary calls
to @fn_gl{BindTransformFeedback}. Transform feedback limits and to @fn_gl{BindTransformFeedback}. Transform feedback limits and
implementation-defined values (such as @ref maxSeparateComponents()) are implementation-defined values (such as @ref maxSeparateComponents()) are
cached, so repeated queries don't result in repeated @fn_gl{Get} calls. cached, so repeated queries don't result in repeated @fn_gl{Get} calls. See
also @ref Context::resetState() and @ref Context::State::TransformFeedback.
If @extension{ARB,direct_state_access} (part of OpenGL 4.5) is available, If @extension{ARB,direct_state_access} (part of OpenGL 4.5) is available,
functions @ref attachBuffer() and @ref attachBuffers() use DSA to avoid functions @ref attachBuffer() and @ref attachBuffers() use DSA to avoid

Loading…
Cancel
Save