Browse Source

Doc++

pull/549/head
Vladimír Vondruš 4 years ago
parent
commit
812e93ae94
  1. 6
      src/Magnum/Mesh.h
  2. 13
      src/Magnum/PixelFormat.h
  3. 17
      src/Magnum/VertexFormat.h

6
src/Magnum/Mesh.h

@ -216,9 +216,9 @@ constexpr bool isMeshPrimitiveImplementationSpecific(MeshPrimitive primitive) {
@brief Wrap an implementation-specific mesh primitive identifier in @ref MeshPrimitive @brief Wrap an implementation-specific mesh primitive identifier in @ref MeshPrimitive
@m_since{2020,06} @m_since{2020,06}
Sets the highest bit on @p primitive to mark it as implementation-specific. Sets the highest bit on @p implementationSpecific to mark it as
Expects that @p primitive fits into the remaining bits. Use implementation-specific. Expects that @p implementationSpecific fits into the
@ref meshPrimitiveUnwrap() for the inverse operation. remaining 31 bits. Use @ref meshPrimitiveUnwrap() for the inverse operation.
@see @ref isMeshPrimitiveImplementationSpecific() @see @ref isMeshPrimitiveImplementationSpecific()
*/ */
template<class T> constexpr MeshPrimitive meshPrimitiveWrap(T implementationSpecific) { template<class T> constexpr MeshPrimitive meshPrimitiveWrap(T implementationSpecific) {

13
src/Magnum/PixelFormat.h

@ -793,9 +793,9 @@ constexpr bool isPixelFormatImplementationSpecific(PixelFormat format) {
/** /**
@brief Wrap an implementation-specific pixel format identifier in @ref PixelFormat @brief Wrap an implementation-specific pixel format identifier in @ref PixelFormat
Sets the highest bit on @p format to mark it as implementation-specific. Sets the highest bit on @p implementationSpecific to mark it as
Expects that @p format fits into the remaining bits. Use @ref pixelFormatUnwrap() implementation-specific. Expects that @p implementationSpecific fits into the
for the inverse operation. remaining 31 bits. Use @ref pixelFormatUnwrap() for the inverse operation.
@see @ref isPixelFormatImplementationSpecific(), @ref compressedPixelFormatWrap() @see @ref isPixelFormatImplementationSpecific(), @ref compressedPixelFormatWrap()
*/ */
template<class T> constexpr PixelFormat pixelFormatWrap(T implementationSpecific) { template<class T> constexpr PixelFormat pixelFormatWrap(T implementationSpecific) {
@ -2361,9 +2361,10 @@ constexpr bool isCompressedPixelFormatImplementationSpecific(CompressedPixelForm
/** /**
@brief Wrap an implementation-specific pixel format identifier in a @ref CompressedPixelFormat @brief Wrap an implementation-specific pixel format identifier in a @ref CompressedPixelFormat
Sets the highest bit on @p format to mark it as implementation-specific. Sets the highest bit on @p implementationSpecific to mark it as
Expects that @p format fits into the remaining bits. Use @ref compressedPixelFormatUnwrap() implementation-specific. Expects that @p implementationSpecific fits into the
for the inverse operation. remaining 31 bits. Use @ref compressedPixelFormatUnwrap() for the inverse
operation.
@see @ref isCompressedPixelFormatImplementationSpecific(), @ref pixelFormatWrap() @see @ref isCompressedPixelFormatImplementationSpecific(), @ref pixelFormatWrap()
*/ */
template<class T> constexpr CompressedPixelFormat compressedPixelFormatWrap(T implementationSpecific) { template<class T> constexpr CompressedPixelFormat compressedPixelFormatWrap(T implementationSpecific) {

17
src/Magnum/VertexFormat.h

@ -42,10 +42,9 @@ namespace Magnum {
@m_since{2020,06} @m_since{2020,06}
Like @ref PixelFormat, but for mesh attributes --- including double-precision Like @ref PixelFormat, but for mesh attributes --- including double-precision
types and matrices. Can act also as a wrapper for implementation-specific mesh types and matrices. Can act also as a wrapper for implementation-specific
attribute type values using @ref vertexFormatWrap() and vertex format values using @ref vertexFormatWrap() and @ref vertexFormatUnwrap().
@ref vertexFormatUnwrap(). Distinction between generic and Distinction between generic and implementation-specific types can be done using
implementation-specific types can be done using
@ref isVertexFormatImplementationSpecific(). @ref isVertexFormatImplementationSpecific().
In case of OpenGL, corresponds to a tuple of @ref GL::DynamicAttribute::Kind, In case of OpenGL, corresponds to a tuple of @ref GL::DynamicAttribute::Kind,
@ -1334,9 +1333,9 @@ constexpr bool isVertexFormatImplementationSpecific(VertexFormat format) {
@brief Wrap an implementation-specific vertex format identifier in @ref VertexFormat @brief Wrap an implementation-specific vertex format identifier in @ref VertexFormat
@m_since{2020,06} @m_since{2020,06}
Sets the highest bit on @p type to mark it as implementation-specific. Expects Sets the highest bit on @p implementationSpecific to mark it as
that @p type fits into the remaining bits. Use @ref vertexFormatUnwrap() implementation-specific. Expects that @p implementationSpecific fits into the
for the inverse operation. remaining 31 bits. Use @ref vertexFormatUnwrap() for the inverse operation.
@see @ref isVertexFormatImplementationSpecific() @see @ref isVertexFormatImplementationSpecific()
*/ */
template<class T> constexpr VertexFormat vertexFormatWrap(T implementationSpecific) { template<class T> constexpr VertexFormat vertexFormatWrap(T implementationSpecific) {
@ -1350,8 +1349,8 @@ template<class T> constexpr VertexFormat vertexFormatWrap(T implementationSpecif
@brief Unwrap an implementation-specific vertex format identifier from @ref VertexFormat @brief Unwrap an implementation-specific vertex format identifier from @ref VertexFormat
@m_since{2020,06} @m_since{2020,06}
Unsets the highest bit from @p type to extract the implementation-specific Unsets the highest bit from @p format to extract the implementation-specific
value. Expects that @p type has it set. Use @ref vertexFormatWrap() for value. Expects that @p format has it set. Use @ref vertexFormatWrap() for
the inverse operation. the inverse operation.
@see @ref isVertexFormatImplementationSpecific() @see @ref isVertexFormatImplementationSpecific()
*/ */

Loading…
Cancel
Save