Browse Source

Doc++

pull/374/head
Vladimír Vondruš 7 years ago
parent
commit
a18ec9b6d8
  1. 4
      doc/platform.dox
  2. 32
      src/Magnum/GL/Buffer.h
  3. 8
      src/Magnum/Trade/AbstractImporter.h

4
doc/platform.dox

@ -144,8 +144,8 @@ this:
@snippet MagnumPlatform.cpp configuration @snippet MagnumPlatform.cpp configuration
However, sometimes you would need to configure the application based on some However, sometimes you would need to configure the application based on some
configuration file or system introspection. In that case you can pass `nullptr` configuration file or system introspection. In that case you can pass
instead of @ref Platform::Sdl2Application::Configuration "Configuration" @ref NoCreate instead of @ref Platform::Sdl2Application::Configuration "Configuration"
instance and then specify it later with @ref Platform::Sdl2Application::create() "create()": instance and then specify it later with @ref Platform::Sdl2Application::create() "create()":
@snippet MagnumPlatform.cpp createcontext @snippet MagnumPlatform.cpp createcontext

32
src/Magnum/GL/Buffer.h

@ -656,14 +656,15 @@ class MAGNUM_GL_EXPORT Buffer: public AbstractObject {
* @brief Bind ranges of buffers to given range of indexed targets * @brief Bind ranges of buffers to given range of indexed targets
* *
* Binds first buffer in the list to @p firstIndex, second to * Binds first buffer in the list to @p firstIndex, second to
* `firstIndex + 1` etc. Second parameter is offset, third is size. If * @cpp firstIndex + 1 @ce etc. Second parameter is offset, third is
* any buffer is `nullptr`, given indexed target is unbound. The range * size. If any buffer is @cpp nullptr @ce, given indexed target is
* of indices must respect limits for given @p target. The offsets must * unbound. The range of indices must respect limits for given
* respect alignment, which is 4 bytes for @ref Target::AtomicCounter * @p target. The offsets must respect alignment, which is 4 bytes for
* and implementation-defined for other targets. All the buffers must * @ref Target::AtomicCounter and implementation-defined for other
* have allocated data store. If @gl_extension{ARB,multi_bind} (part of * targets. All the buffers must have allocated data store. If
* OpenGL 4.4) is not available, the feature is emulated with sequence * @gl_extension{ARB,multi_bind} (part of OpenGL 4.4) is not available,
* of @ref bind(Target, UnsignedInt, GLintptr, GLsizeiptr) / * the feature is emulated with sequence of
* @ref bind(Target, UnsignedInt, GLintptr, GLsizeiptr) /
* @ref unbind(Target, UnsignedInt) calls. * @ref unbind(Target, UnsignedInt) calls.
* @note This function is meant to be used only internally from * @note This function is meant to be used only internally from
* @ref AbstractShaderProgram subclasses. See its documentation * @ref AbstractShaderProgram subclasses. See its documentation
@ -690,12 +691,13 @@ class MAGNUM_GL_EXPORT Buffer: public AbstractObject {
* @brief Bind buffers to given range of indexed targets * @brief Bind buffers to given range of indexed targets
* *
* Binds first buffer in the list to @p firstIndex, second to * Binds first buffer in the list to @p firstIndex, second to
* `firstIndex + 1` etc. If any buffer is `nullptr`, given indexed * @cpp firstIndex + 1 @ce etc. If any buffer is @cpp nullptr @ce,
* target is unbound. The range of indices must respect limits for * given indexed target is unbound. The range of indices must respect
* given @p target. All the buffers must have allocated data store. If * limits for given @p target. All the buffers must have allocated data
* @gl_extension{ARB,multi_bind} (part of OpenGL 4.4) is not available, * store. If @gl_extension{ARB,multi_bind} (part of OpenGL 4.4) is not
* the feature is emulated with sequence of @ref bind(Target, UnsignedInt) * available, the feature is emulated with sequence of
* / @ref unbind(Target, UnsignedInt) calls. * @ref bind(Target, UnsignedInt) / @ref unbind(Target, UnsignedInt)
* calls.
* @note This function is meant to be used only internally from * @note This function is meant to be used only internally from
* @ref AbstractShaderProgram subclasses. See its documentation * @ref AbstractShaderProgram subclasses. See its documentation
* for more information. * for more information.
@ -1134,7 +1136,7 @@ class MAGNUM_GL_EXPORT Buffer: public AbstractObject {
* @param length Length of the mapped memory in bytes * @param length Length of the mapped memory in bytes
* @param flags Flags. At least @ref MapFlag::Read or * @param flags Flags. At least @ref MapFlag::Read or
* @ref MapFlag::Write must be specified. * @ref MapFlag::Write must be specified.
* @return Sized view to buffer data or `nullptr` on error * @return Sized view to buffer data or @cpp nullptr @ce on error
* *
* If neither @gl_extension{ARB,direct_state_access} (part of OpenGL 4.5) * If neither @gl_extension{ARB,direct_state_access} (part of OpenGL 4.5)
* nor @gl_extension{EXT,direct_state_access} desktop extension is * nor @gl_extension{EXT,direct_state_access} desktop extension is

8
src/Magnum/Trade/AbstractImporter.h

@ -584,7 +584,7 @@ class MAGNUM_TRADE_EXPORT AbstractImporter: public PluginManager::AbstractManagi
* @brief Two-dimensional object * @brief Two-dimensional object
* @param id Object ID, from range [0, @ref object2DCount()). * @param id Object ID, from range [0, @ref object2DCount()).
* *
* Returns given object or `nullptr` if importing failed. * Returns given object or @cpp nullptr @ce if importing failed.
*/ */
std::unique_ptr<ObjectData2D> object2D(UnsignedInt id); std::unique_ptr<ObjectData2D> object2D(UnsignedInt id);
@ -611,7 +611,7 @@ class MAGNUM_TRADE_EXPORT AbstractImporter: public PluginManager::AbstractManagi
* @brief Three-dimensional object * @brief Three-dimensional object
* @param id Object ID, from range [0, @ref object3DCount()). * @param id Object ID, from range [0, @ref object3DCount()).
* *
* Returns given object or `nullptr` if importing failed. * Returns given object or @cpp nullptr @ce if importing failed.
*/ */
std::unique_ptr<ObjectData3D> object3D(UnsignedInt id); std::unique_ptr<ObjectData3D> object3D(UnsignedInt id);
@ -692,7 +692,7 @@ class MAGNUM_TRADE_EXPORT AbstractImporter: public PluginManager::AbstractManagi
* @brief Material * @brief Material
* @param id Material ID, from range [0, @ref materialCount()). * @param id Material ID, from range [0, @ref materialCount()).
* *
* Returns given material or `nullptr` if importing failed. * Returns given material or @cpp nullptr @ce if importing failed.
*/ */
std::unique_ptr<AbstractMaterialData> material(UnsignedInt id); std::unique_ptr<AbstractMaterialData> material(UnsignedInt id);
@ -812,7 +812,7 @@ class MAGNUM_TRADE_EXPORT AbstractImporter: public PluginManager::AbstractManagi
* The importer might provide access to its internal data structures * The importer might provide access to its internal data structures
* for currently opened document through this function. See * for currently opened document through this function. See
* documentation of a particular plugin for more information about * documentation of a particular plugin for more information about
* returned type and contents. Returns `nullptr` by default. * returned type and contents. Returns @cpp nullptr @ce by default.
* @see @ref AbstractMaterialData::importerState(), * @see @ref AbstractMaterialData::importerState(),
* @ref AnimationData::importerState(), @ref CameraData::importerState(), * @ref AnimationData::importerState(), @ref CameraData::importerState(),
* @ref ImageData::importerState(), @ref LightData::importerState(), * @ref ImageData::importerState(), @ref LightData::importerState(),

Loading…
Cancel
Save