Browse Source

Doc++

pull/617/head
Vladimír Vondruš 3 years ago
parent
commit
9c0dd1435f
  1. 9
      src/Magnum/DebugTools/FrameProfiler.h
  2. 4
      src/Magnum/MeshTools/CompressIndices.cpp
  3. 2
      src/Magnum/SceneTools/FlattenMeshHierarchy.h
  4. 2
      src/Magnum/ShaderTools/AbstractConverter.h
  5. 6
      src/Magnum/Trade/MeshData.h
  6. 6
      src/Magnum/Trade/SceneData.h

9
src/Magnum/DebugTools/FrameProfiler.h

@ -375,10 +375,11 @@ class MAGNUM_DEBUGTOOLS_EXPORT FrameProfiler {
/**
* @brief Print an overview of all measurements to a console at given rate
*
* Expected to be called every frame. On every `frequency`th frame
* prints the same information as @ref statistics(), but in addition,
* if the output is a TTY, it's colored and overwrites itself instead
* of filling up the terminal history.
* Expected to be called every frame. If profiling is enabled, on every
* `frequency`th frame prints the same information as @ref statistics(),
* but in addition, if the output is a TTY, it's colored and overwrites
* itself instead of filling up the terminal history. If profiling is
* disabled, does nothing.
* @see @ref isMeasurementAvailable(), @ref isEnabled()
* @ref Corrade::Utility::Debug::isTty()
*/

4
src/Magnum/MeshTools/CompressIndices.cpp

@ -39,8 +39,8 @@ namespace Magnum { namespace MeshTools {
namespace {
template<class T, class U> inline Containers::Array<char> compress(const Containers::StridedArrayView1D<const U>& indices, Long offset) {
/* Can't use Utility::copy() here because we're copying from a larger type
to a smaller one (and subtracting an offset in addition) */
/* Can't use Math::castInto() here because we're subtracting an offset in
addition */
Containers::Array<char> buffer(indices.size()*sizeof(T));
for(std::size_t i = 0; i != indices.size(); ++i) {
T index = static_cast<T>(indices[i] - offset);

2
src/Magnum/SceneTools/FlattenMeshHierarchy.h

@ -26,7 +26,7 @@
*/
/** @file
* @brief Function @ref Magnum::SceneTools::flattenMeshHierarchy2D(), @ref Magnum::SceneTools::flattenMeshHierarchy3D()
* @brief Function @ref Magnum::SceneTools::flattenMeshHierarchy2D(), @ref Magnum::SceneTools::flattenMeshHierarchy2DInto(), @ref Magnum::SceneTools::flattenMeshHierarchy3D(), @ref Magnum::SceneTools::flattenMeshHierarchy3DInto()
* @m_since_latest
*/

2
src/Magnum/ShaderTools/AbstractConverter.h

@ -349,6 +349,8 @@ produce the usual assertions.
that exposes functionality of all shader converter plugins through a
command line interface.
<b></b>
@m_class{m-block m-warning}
@par Multiple shader sources

6
src/Magnum/Trade/MeshData.h

@ -58,8 +58,10 @@ identifier using @ref meshAttributeCustom(MeshAttribute) and
@ref meshAttributeCustom(UnsignedShort). Unlike the builtin ones, these can
be of any type. An importer that exposes custom attributes then may also
provide a string mapping using @ref AbstractImporter::meshAttributeForName()
and @ref AbstractImporter::meshAttributeName(). See documentation of a
particular importer for details.
and @ref AbstractImporter::meshAttributeName(); conversely a scene converter
supporting custom mesh attributes can have the string mapping specified via
@ref AbstractSceneConverter::setMeshAttributeName(). See documentation of a
particular importer and scene converter for details.
@see @ref MeshAttributeData, @ref VertexFormat
*/
/* 16 bits because 8 bits is not enough to cover all potential per-edge,

6
src/Magnum/Trade/SceneData.h

@ -118,8 +118,10 @@ to and from a numeric identifier using @ref sceneFieldCustom(SceneField) and
@ref sceneFieldCustom(UnsignedInt). Unlike the builtin ones, these can be of
any type. An importer that exposes custom fields then may also provide a string
mapping using @ref AbstractImporter::sceneFieldForName() and
@ref AbstractImporter::sceneFieldName(). See documentation of a particular
importer for details.
@ref AbstractImporter::sceneFieldName(); conversely a scene converter
supporting custom scene fields can have the string mapping specified via
@ref AbstractSceneConverter::setSceneFieldName(). See documentation of a
particular importer and scene converter for details.
@see @ref SceneFieldData, @ref SceneFieldType
*/
enum class SceneField: UnsignedInt {

Loading…
Cancel
Save