ic
/
magnum
mirror of https://github.com/mosra/magnum.git
6
0
Fork 0
Code Issues Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
8954 Commits
21 Branches
19 Tags
70 MiB
 
 
 
 
 
Tree: 4d61cda4a3
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '4d61cda4a3'
${ noResults }
magnum/src/Magnum/VertexFormat.h

1486 lines
62 KiB
Raw Blame History

#ifndef Magnum_VertexFormat_h
#define Magnum_VertexFormat_h
/*
This file is part of Magnum.
Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019,
2020, 2021 Vladimír Vondruš <mosra@centrum.cz>
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
*/
/** @file
* @brief Enum @ref Magnum::VertexFormat, function @ref Magnum::isVertexFormatImplementationSpecific(), @ref Magnum::vertexFormatWrap(), @ref Magnum::vertexFormatUnwrap(), @ref Magnum::vertexFormatSize(), @ref Magnum::vertexFormatComponentFormat(), @ref Magnum::vertexFormatComponentCount(), @ref Magnum::vertexFormatVectorCount(), @ref Magnum::vertexFormatVectorStride(), @ref Magnum::isVertexFormatNormalized()
*/
#include <Corrade/Utility/Assert.h>
#include <Corrade/Utility/StlForwardString.h>
#include "Magnum/Magnum.h"
#include "Magnum/visibility.h"
namespace Magnum {
/**
@brief Vertex format
@m_since{2020,06}
Like @ref PixelFormat, but for mesh attributes --- including double-precision
types and matrices. Can act also as a wrapper for implementation-specific mesh
attribute type values using @ref vertexFormatWrap() and
@ref vertexFormatUnwrap(). Distinction between generic and
implementation-specific types can be done using
@ref isVertexFormatImplementationSpecific().
In case of OpenGL, corresponds to a tuple of @ref GL::DynamicAttribute::Kind,
@ref GL::DynamicAttribute::Components and @ref GL::DynamicAttribute::DataType
and is convertible to them using
@ref GL::DynamicAttribute::DynamicAttribute(Kind, UnsignedInt, VertexFormat).
See documentation of each value for more information about the mapping. Note
that not every format is available on all targets, use
@ref GL::hasVertexFormat() to check for its presence.
In case of Vulkan, corresponds to @ref Vk::VertexFormat and is convertible to
it using @ref Vk::vertexFormat(). See documentation of each value for more
information about the mapping. Note that not every format may be available, use
@ref Vk::hasVertexFormat() to check for its presence.
For D3D, corresponds to @m_class{m-doc-external} [DXGI_FORMAT](https://docs.microsoft.com/en-us/windows/win32/api/dxgiformat/ne-dxgiformat-dxgi_format);
for Metal, corresponds to @m_class{m-doc-external} [MTLVertexFormat](https://developer.apple.com/documentation/metal/mtlvertexformat?language=objc).
See documentation of each value for more information about the mapping.
@see @ref Trade::MeshData, @ref Trade::MeshAttributeData,
@ref Trade::MeshAttribute
*/
enum class VertexFormat: UnsignedInt {
/* Zero reserved for an invalid type (but not being a named value) */
/**
* @ref Float.
*
* Corresponds to single-component @ref GL::DynamicAttribute::Kind::Generic
* @ref GL::DynamicAttribute::DataType::Float; @ref Vk::VertexFormat::Float;
* @m_class{m-doc-external} [DXGI_FORMAT_R32_FLOAT](https://docs.microsoft.com/en-us/windows/win32/api/dxgiformat/ne-dxgiformat-dxgi_format)
* or @m_class{m-doc-external} [MTLVertexFormatFloat](https://developer.apple.com/documentation/metal/mtlvertexformat/mtlvertexformatfloat?language=objc).
* @m_keywords{DXGI_FORMAT_R32_FLOAT MTLVertexFormatFloat}
*/
Float = 1,
/**
* @ref Half.
*
* Corresponds to single-component @ref GL::DynamicAttribute::Kind::Generic
* @ref GL::DynamicAttribute::DataType::Half; @ref Vk::VertexFormat::Half;
* @m_class{m-doc-external} [DXGI_FORMAT_R16_FLOAT](https://docs.microsoft.com/en-us/windows/win32/api/dxgiformat/ne-dxgiformat-dxgi_format)
* or @m_class{m-doc-external} [MTLVertexFormatHalf](https://developer.apple.com/documentation/metal/mtlvertexformat/mtlvertexformathalf?language=objc).
* @m_keywords{DXGI_FORMAT_R16_FLOAT MTLVertexFormatHalf}
*/
Half,
/**
* @ref Double.
*
* Corresponds to single-component @ref GL::DynamicAttribute::Kind::Generic
* or @ref GL::DynamicAttribute::Kind::Long
* @ref GL::DynamicAttribute::DataType::Double;
* @ref Vk::VertexFormat::Double. No D3D or Metal equivalent.
*/
Double,
/**
* @ref UnsignedByte.
*
* Corresponds to single-component @ref GL::DynamicAttribute::Kind::Generic
* or @ref GL::DynamicAttribute::Kind::Integral
* @ref GL::DynamicAttribute::DataType::UnsignedByte;
* @ref Vk::VertexFormat::UnsignedByte;
* @m_class{m-doc-external} [DXGI_FORMAT_R8_UINT](https://docs.microsoft.com/en-us/windows/win32/api/dxgiformat/ne-dxgiformat-dxgi_format)
* or @m_class{m-doc-external} [MTLVertexFormatUChar](https://developer.apple.com/documentation/metal/mtlvertexformat/mtlvertexformatuchar?language=objc)
* @m_keywords{DXGI_FORMAT_R8_UINT MTLVertexFormatUChar}
*/
UnsignedByte,
/**
* @ref UnsignedByte, with range @f$ [0, 255] @f$ interpreted as
* @f$ [0.0, 1.0] @f$.
*
* Corresponds to single-component
* @ref GL::DynamicAttribute::Kind::GenericNormalized
* @ref GL::DynamicAttribute::DataType::UnsignedByte;
* @ref Vk::VertexFormat::UnsignedByteNormalized;
* @m_class{m-doc-external} [DXGI_FORMAT_R8_UNORM](https://docs.microsoft.com/en-us/windows/win32/api/dxgiformat/ne-dxgiformat-dxgi_format)
* or @m_class{m-doc-external} [MTLVertexFormatUCharNormalized](https://developer.apple.com/documentation/metal/mtlvertexformat/mtlvertexformatucharnormalized?language=objc).
* @m_keywords{DXGI_FORMAT_R8_UNORM MTLVertexFormatUCharNormalized}
*/
UnsignedByteNormalized,
/**
* @ref Byte.
*
* Corresponds to single-component @ref GL::DynamicAttribute::Kind::Generic
* or @ref GL::DynamicAttribute::Kind::Integral
* @ref GL::DynamicAttribute::DataType::Byte; @ref Vk::VertexFormat::Byte;
* @m_class{m-doc-external} [DXGI_FORMAT_R8_SINT](https://docs.microsoft.com/en-us/windows/win32/api/dxgiformat/ne-dxgiformat-dxgi_format)
* or @m_class{m-doc-external} [MTLVertexFormatChar](https://developer.apple.com/documentation/metal/mtlvertexformat/mtlvertexformatchar?language=objc).
* @m_keywords{DXGI_FORMAT_R8_SINT MTLVertexFormatChar}
*/
Byte,
/**
* @ref Byte, with range @f$ [-127, 127] @f$ interpreted as
* @f$ [-1.0, 1.0] @f$.
*
* Corresponds to single-component
* @ref GL::DynamicAttribute::Kind::GenericNormalized
* @ref GL::DynamicAttribute::DataType::Byte;
* @ref Vk::VertexFormat::ByteNormalized;
* @m_class{m-doc-external} [DXGI_FORMAT_R8_SNORM](https://docs.microsoft.com/en-us/windows/win32/api/dxgiformat/ne-dxgiformat-dxgi_format)
* or @m_class{m-doc-external} [MTLVertexFormatCharNormalized](https://developer.apple.com/documentation/metal/mtlvertexformat/mtlvertexformatcharnormalized?language=objc).
* @m_keywords{DXGI_FORMAT_R8_SNORM MTLVertexFormatCharNormalized}
*/
ByteNormalized,
/**
* @ref UnsignedShort.
*
* Corresponds to single-component @ref GL::DynamicAttribute::Kind::Generic
* or @ref GL::DynamicAttribute::Kind::Integral
* @ref GL::DynamicAttribute::DataType::UnsignedShort;
* @ref Vk::VertexFormat::UnsignedShort;
* @m_class{m-doc-external} [DXGI_FORMAT_R16_UINT](https://docs.microsoft.com/en-us/windows/win32/api/dxgiformat/ne-dxgiformat-dxgi_format)
* or @m_class{m-doc-external} [MTLVertexFormatUShort](https://developer.apple.com/documentation/metal/mtlvertexformat/mtlvertexformatushort?language=objc).
* @m_keywords{DXGI_FORMAT_R16_UINT MTLVertexFormatUShort}
*/
UnsignedShort,
/**
* @ref UnsignedShort, with range @f$ [0, 65535] @f$ interpreted as
* @f$ [0.0, 1.0] @f$.
*
* Corresponds to single-component
* @ref GL::DynamicAttribute::Kind::GenericNormalized
* @ref GL::DynamicAttribute::DataType::UnsignedByte;
* @ref Vk::VertexFormat::UnsignedShortNormalized;
* @m_class{m-doc-external} [DXGI_FORMAT_R16_UNORM](https://docs.microsoft.com/en-us/windows/win32/api/dxgiformat/ne-dxgiformat-dxgi_format)
* or @m_class{m-doc-external} [MTLVertexFormatUShortNormalized](https://developer.apple.com/documentation/metal/mtlvertexformat/mtlvertexformatushortnormalized?language=objc).
* @m_keywords{DXGI_FORMAT_R16_UNORM MTLVertexFormatUShortNormalized}
*/
UnsignedShortNormalized,
/**
* @ref Short.
*
* Corresponds to single-component @ref GL::DynamicAttribute::Kind::Generic
* or @ref GL::DynamicAttribute::Kind::Integral
* @ref GL::DynamicAttribute::DataType::Short;
* @ref Vk::VertexFormat::Short;
* @m_class{m-doc-external} [DXGI_FORMAT_R16_SINT](https://docs.microsoft.com/en-us/windows/win32/api/dxgiformat/ne-dxgiformat-dxgi_format)
* or @m_class{m-doc-external} [MTLVertexFormatShort](https://developer.apple.com/documentation/metal/mtlvertexformat/mtlvertexformatshort?language=objc).
* @m_keywords{DXGI_FORMAT_R16_SINT MTLVertexFormatShort}
*/
Short,
/**
* @ref Short, with range @f$ [-32767, 32767] @f$ interpreted as
* @f$ [-1.0, 1.0] @f$.
*
* Corresponds to single-component
* @ref GL::DynamicAttribute::Kind::GenericNormalized
* @ref GL::DynamicAttribute::DataType::Short;
* @ref Vk::VertexFormat::ShortNormalized;
* @m_class{m-doc-external} [DXGI_FORMAT_R16_SNORM](https://docs.microsoft.com/en-us/windows/win32/api/dxgiformat/ne-dxgiformat-dxgi_format)
* or @m_class{m-doc-external} [MTLVertexFormatShortNormalized](https://developer.apple.com/documentation/metal/mtlvertexformat/mtlvertexformatshortnormalized?language=objc).
* @m_keywords{DXGI_FORMAT_R16_SNORM MTLVertexFormatShortNormalized}
*/
ShortNormalized,
/**
* @ref UnsignedInt.
*
* Corresponds to single-component @ref GL::DynamicAttribute::Kind::Generic
* or @ref GL::DynamicAttribute::Kind::Integral
* @ref GL::DynamicAttribute::DataType::UnsignedInt;
* @ref Vk::VertexFormat::UnsignedInt;
* @m_class{m-doc-external} [DXGI_FORMAT_R32_UINT](https://docs.microsoft.com/en-us/windows/win32/api/dxgiformat/ne-dxgiformat-dxgi_format)
* or @m_class{m-doc-external} [MTLVertexFormatUInt](https://developer.apple.com/documentation/metal/mtlvertexformat/mtlvertexformatuint?language=objc).
* @m_keywords{DXGI_FORMAT_R32_UINT MTLVertexFormatUInt}
*/
UnsignedInt,
/**
* @ref Int.
*
* Corresponds to single-component @ref GL::DynamicAttribute::Kind::Generic
* or @ref GL::DynamicAttribute::Kind::Integral
* @ref GL::DynamicAttribute::DataType::Int; @ref Vk::VertexFormat::Int;
* @m_class{m-doc-external} [DXGI_FORMAT_R32_SINT](https://docs.microsoft.com/en-us/windows/win32/api/dxgiformat/ne-dxgiformat-dxgi_format)
* or @m_class{m-doc-external} [MTLVertexFormatInt](https://developer.apple.com/documentation/metal/mtlvertexformat/mtlvertexformatint?language=objc).
* @m_keywords{DXGI_FORMAT_R32_SINT MTLVertexFormatInt}
*/
Int,
/**
* @ref Vector2. Usually used for 2D positions and 2D texture coordinates.
*
* Corresponds to two-component @ref GL::DynamicAttribute::Kind::Generic
* @ref GL::DynamicAttribute::DataType::Float;
* @ref Vk::VertexFormat::Vector2;
* @m_class{m-doc-external} [DXGI_FORMAT_R32G32_FLOAT](https://docs.microsoft.com/en-us/windows/win32/api/dxgiformat/ne-dxgiformat-dxgi_format)
* or @m_class{m-doc-external} [MTLVertexFormatFloat2](https://developer.apple.com/documentation/metal/mtlvertexformat/mtlvertexformatfloat2?language=objc).
* @m_keywords{DXGI_FORMAT_R32G32_FLOAT MTLVertexFormatFloat2}
*/
Vector2,
/**
* @ref Vector2h. Can be used instead of @ref VertexFormat::Vector2 for 2D
* positions and 2D texture coordinates.
*
* Corresponds to two-component @ref GL::DynamicAttribute::Kind::Generic
* @ref GL::DynamicAttribute::DataType::Half;
* @ref Vk::VertexFormat::Vector2h;
* @m_class{m-doc-external} [DXGI_FORMAT_R16G16_FLOAT](https://docs.microsoft.com/en-us/windows/win32/api/dxgiformat/ne-dxgiformat-dxgi_format)
* or @m_class{m-doc-external} [MTLVertexFormatHalf2](https://developer.apple.com/documentation/metal/mtlvertexformat/mtlvertexformathalf2?language=objc).
* @m_keywords{DXGI_FORMAT_R16G16_FLOAT MTLVertexFormatHalf2}
*/
Vector2h,
/**
* @ref Vector2d.
*
* Corresponds to two-component @ref GL::DynamicAttribute::Kind::Generic
* or @ref GL::DynamicAttribute::Kind::Long
* @ref GL::DynamicAttribute::DataType::Double;
* @ref Vk::VertexFormat::Vector2d. No D3D or Metal equivalent.
*/
Vector2d,
/**
* @ref Vector2ub. Can be used instead of @ref VertexFormat::Vector2 for
* packed 2D positions and 2D texture coordinates, in which case the range
* @f$ [0, 255] @f$ is interpreted as @f$ [0.0, 255.0] @f$.
*
* Corresponds to two-component @ref GL::DynamicAttribute::Kind::Generic
* or @ref GL::DynamicAttribute::Kind::Integral
* @ref GL::DynamicAttribute::DataType::UnsignedByte;
* @ref Vk::VertexFormat::Vector2ub;
* @m_class{m-doc-external} [DXGI_FORMAT_R8G8_UINT](https://docs.microsoft.com/en-us/windows/win32/api/dxgiformat/ne-dxgiformat-dxgi_format)
* or @m_class{m-doc-external} [MTLVertexFormatUChar2](https://developer.apple.com/documentation/metal/mtlvertexformat/mtlvertexformatuchar2?language=objc).
* @m_keywords{DXGI_FORMAT_R8G8_UINT MTLVertexFormatUChar2}
*/
Vector2ub,
/**
* @ref Vector2ub, with range @f$ [0, 255] @f$ interpreted as
* @f$ [0.0, 1.0] @f$. Can be used instead of @ref VertexFormat::Vector2
* for packed 2D positions and 2D texture coordinates.
*
* Corresponds to two-component
* @ref GL::DynamicAttribute::Kind::GenericNormalized
* @ref GL::DynamicAttribute::DataType::UnsignedByte;
* @ref Vk::VertexFormat::Vector2ubNormalized;
* @m_class{m-doc-external} [DXGI_FORMAT_R8G8_UNORM](https://docs.microsoft.com/en-us/windows/win32/api/dxgiformat/ne-dxgiformat-dxgi_format)
* or @m_class{m-doc-external} [MTLVertexFormatUChar2Normalized](https://developer.apple.com/documentation/metal/mtlvertexformat/mtlvertexformatuchar2normalized?language=objc).
* @m_keywords{DXGI_FORMAT_R8G8_UNORM MTLVertexFormatUChar2Normalized}
*/
Vector2ubNormalized,
/**
* @ref Vector2b. Can be used instead of @ref VertexFormat::Vector2 for
* packed 2D positions and 2D texture coordinates, in which case the range
* @f$ [-128, 127] @f$ is interpreted as @f$ [-128.0, 127.0] @f$.
*
* Corresponds to two-component @ref GL::DynamicAttribute::Kind::Generic
* or @ref GL::DynamicAttribute::Kind::Integral
* @ref GL::DynamicAttribute::DataType::Byte;
* @ref Vk::VertexFormat::Vector2b;
* @m_class{m-doc-external} [DXGI_FORMAT_R8G8_SINT](https://docs.microsoft.com/en-us/windows/win32/api/dxgiformat/ne-dxgiformat-dxgi_format)
* or @m_class{m-doc-external} [MTLVertexFormatChar2](https://developer.apple.com/documentation/metal/mtlvertexformat/mtlvertexformatchar2?language=objc).
* @m_keywords{DXGI_FORMAT_R8G8_SINT MTLVertexFormatChar2}
*/
Vector2b,
/**
* @ref Vector2b, with range @f$ [-127, 127] @f$ interpreted as
* @f$ [-1.0, 1.0] @f$. Can be used instead of @ref VertexFormat::Vector2
* for packed 2D positions and 2D texture coordinates.
*
* Corresponds to two-component
* @ref GL::DynamicAttribute::Kind::GenericNormalized
* @ref GL::DynamicAttribute::DataType::Byte;
* @ref Vk::VertexFormat::Vector2bNormalized;
* @m_class{m-doc-external} [DXGI_FORMAT_R8G8_SNORM](https://docs.microsoft.com/en-us/windows/win32/api/dxgiformat/ne-dxgiformat-dxgi_format)
* or @m_class{m-doc-external} [MTLVertexFormatChar2Normalized](https://developer.apple.com/documentation/metal/mtlvertexformat/mtlvertexformatchar2normalized?language=objc).
* @m_keywords{DXGI_FORMAT_R8G8_SNORM MTLVertexFormatChar2Normalized}
*/
Vector2bNormalized,
/**
* @ref Vector2us. Can be used instead of @ref VertexFormat::Vector2 for
* packed 2D positions and 2D texture coordinates, in which case the range
* @f$ [0, 65535] @f$ is interpreted as @f$ [0.0, 65535.0] @f$.
*
* Corresponds to two-component @ref GL::DynamicAttribute::Kind::Generic
* or @ref GL::DynamicAttribute::Kind::Integral
* @ref GL::DynamicAttribute::DataType::UnsignedShort;
* @ref Vk::VertexFormat::Vector2usNormalized;
* @m_class{m-doc-external} [DXGI_FORMAT_R16G16_UINT](https://docs.microsoft.com/en-us/windows/win32/api/dxgiformat/ne-dxgiformat-dxgi_format)
* or @m_class{m-doc-external} [MTLVertexFormatUShort2](https://developer.apple.com/documentation/metal/mtlvertexformat/mtlvertexformatushort2?language=objc).
* @m_keywords{DXGI_FORMAT_R16G16_UINT MTLVertexFormatUShort2}
*/
Vector2us,
/**
* @ref Vector2us, with range @f$ [0, 65535] @f$ interpreted as
* @f$ [0.0, 1.0] @f$. Can be used instead of @ref VertexFormat::Vector2
* for packed 2D positions and 2D texture coordinates.
*
* Corresponds to two-component
* @ref GL::DynamicAttribute::Kind::GenericNormalized
* @ref GL::DynamicAttribute::DataType::UnsignedByte;
* @ref Vk::VertexFormat::Vector2usNormalized;
* @m_class{m-doc-external} [DXGI_FORMAT_R16G16_UNORM](https://docs.microsoft.com/en-us/windows/win32/api/dxgiformat/ne-dxgiformat-dxgi_format)
* or @m_class{m-doc-external} [MTLVertexFormatUShort2Normalized](https://developer.apple.com/documentation/metal/mtlvertexformat/mtlvertexformatushort2normalized?language=objc).
* @m_keywords{DXGI_FORMAT_R16G16_UNORM MTLVertexFormatUShort2Normalized}
*/
Vector2usNormalized,
/**
* @ref Vector2s. Can be used instead of @ref VertexFormat::Vector2 for
* packed 2D positions and 2D texture coordinates, in which case the range
* @f$ [-32768, 32767] @f$ is interpreted as @f$ [-32768.0, 32767.0] @f$.
*
* Corresponds to two-component @ref GL::DynamicAttribute::Kind::Generic
* or @ref GL::DynamicAttribute::Kind::Integral
* @ref GL::DynamicAttribute::DataType::Short;
* @ref Vk::VertexFormat::Vector2s;
* @m_class{m-doc-external} [DXGI_FORMAT_R16G16_SINT](https://docs.microsoft.com/en-us/windows/win32/api/dxgiformat/ne-dxgiformat-dxgi_format)
* or @m_class{m-doc-external} [MTLVertexFormatShort2](https://developer.apple.com/documentation/metal/mtlvertexformat/mtlvertexformatshort2?language=objc).
* @m_keywords{DXGI_FORMAT_R16G16_SINT MTLVertexFormatShort2}
*/
Vector2s,
/**
* @ref Vector2s, with range @f$ [-32767, 32767] @f$ interpreted as
* @f$ [-1.0, 1.0] @f$. Can be used instead of @ref VertexFormat::Vector2
* for packed 2D positions and 2D texture coordinates.
*
* Corresponds to two-component
* @ref GL::DynamicAttribute::Kind::GenericNormalized
* @ref GL::DynamicAttribute::DataType::Short;
* @ref Vk::VertexFormat::Vector2sNormalized;
* @m_class{m-doc-external} [DXGI_FORMAT_R16G16_SNORM](https://docs.microsoft.com/en-us/windows/win32/api/dxgiformat/ne-dxgiformat-dxgi_format)
* or @m_class{m-doc-external} [MTLVertexFormatShort2Normalized](https://developer.apple.com/documentation/metal/mtlvertexformat/mtlvertexformatshort2normalized?language=objc).
* @m_keywords{DXGI_FORMAT_R16G16_SNORM MTLVertexFormatShort2Normalized}
*/
Vector2sNormalized,
/**
* @ref Vector2ui.
*
* Corresponds to two-component @ref GL::DynamicAttribute::Kind::Generic
* or @ref GL::DynamicAttribute::Kind::Integral
* @ref GL::DynamicAttribute::DataType::UnsignedInt;
* @ref Vk::VertexFormat::Vector2ui;
* @m_class{m-doc-external} [DXGI_FORMAT_R32G32_UINT](https://docs.microsoft.com/en-us/windows/win32/api/dxgiformat/ne-dxgiformat-dxgi_format)
* or @m_class{m-doc-external} [MTLVertexFormatUInt2](https://developer.apple.com/documentation/metal/mtlvertexformat/mtlvertexformatuint2?language=objc).
* @m_keywords{DXGI_FORMAT_R32G32_UINT MTLVertexFormatUInt2}
*/
Vector2ui,
/**
* @ref Vector2i.
*
* Corresponds to two-component @ref GL::DynamicAttribute::Kind::Generic
* or @ref GL::DynamicAttribute::Kind::Integral
* @ref GL::DynamicAttribute::DataType::Int;
* @ref Vk::VertexFormat::Vector2i;
* @m_class{m-doc-external} [DXGI_FORMAT_R32G32_SINT](https://docs.microsoft.com/en-us/windows/win32/api/dxgiformat/ne-dxgiformat-dxgi_format)
* or @m_class{m-doc-external} [MTLVertexFormatInt2](https://developer.apple.com/documentation/metal/mtlvertexformat/mtlvertexformatint2?language=objc).
* @m_keywords{DXGI_FORMAT_R32G32_SINT MTLVertexFormatInt2}
*/
Vector2i,
/**
* @ref Vector3 or @ref Color3. Usually used for 3D positions, normals and
* three-component colors.
*
* Corresponds to three-component @ref GL::DynamicAttribute::Kind::Generic
* @ref GL::DynamicAttribute::DataType::Float;
* @ref Vk::VertexFormat::Vector3;
* @m_class{m-doc-external} [DXGI_FORMAT_R32G32B32_FLOAT](https://docs.microsoft.com/en-us/windows/win32/api/dxgiformat/ne-dxgiformat-dxgi_format)
* or @m_class{m-doc-external} [MTLVertexFormatFloat3](https://developer.apple.com/documentation/metal/mtlvertexformat/mtlvertexformatfloat3?language=objc).
* @m_keywords{DXGI_FORMAT_R32G32B32_FLOAT MTLVertexFormatFloat3}
*/
Vector3,
/**
* @ref Vector3h or @ref Color3h. Can be used instead of
* @ref VertexFormat::Vector3 for packed 3D positions and three-component
* colors.
*
* Corresponds to three-component @ref GL::DynamicAttribute::Kind::Generic
* @ref GL::DynamicAttribute::DataType::Half;
* @ref Vk::VertexFormat::Vector3h;
* @m_class{m-doc-external} [DXGI_FORMAT_R16G16B16_FLOAT](https://docs.microsoft.com/en-us/windows/win32/api/dxgiformat/ne-dxgiformat-dxgi_format)
* or @m_class{m-doc-external} [MTLVertexFormatHalf3](https://developer.apple.com/documentation/metal/mtlvertexformat/mtlvertexformathalf3?language=objc).
* @m_keywords{DXGI_FORMAT_R16G16B16_FLOAT MTLVertexFormatHalf3}
*/
Vector3h,
/**
* @ref Vector3d.
*
* Corresponds to three-component @ref GL::DynamicAttribute::Kind::Generic
* or @ref GL::DynamicAttribute::Kind::Long
* @ref GL::DynamicAttribute::DataType::Double;
* @ref Vk::VertexFormat::Vector3d. No D3D or Metal equivalent.
*/
Vector3d,
/**
* @ref Vector3ub. Can be used instead of @ref VertexFormat::Vector3 for
* packed 3D positions, in which case the range @f$ [0, 255] @f$ is
* interpreted as @f$ [0.0, 255.0] @f$.
*
* Corresponds to three-component @ref GL::DynamicAttribute::Kind::Generic
* or @ref GL::DynamicAttribute::Kind::Integral
* @ref GL::DynamicAttribute::DataType::UnsignedByte;
* @ref Vk::VertexFormat::Vector3ub;
* @m_class{m-doc-external} [DXGI_FORMAT_R8G8B8_UINT](https://docs.microsoft.com/en-us/windows/win32/api/dxgiformat/ne-dxgiformat-dxgi_format)
* or @m_class{m-doc-external} [MTLVertexFormatUChar3](https://developer.apple.com/documentation/metal/mtlvertexformat/mtlvertexformatuchar3?language=objc).
* @m_keywords{DXGI_FORMAT_R8G8B8_UINT MTLVertexFormatUChar3}
*/
Vector3ub,
/**
* @ref Vector3ub or @ref Color3ub, with range @f$ [0, 255] @f$ interpreted
* as @f$ [0.0, 1.0] @f$. Can be used instead of @ref VertexFormat::Vector3
* for packed 3D positions and three-component colors.
*
* Corresponds to three-component
* @ref GL::DynamicAttribute::Kind::GenericNormalized
* @ref GL::DynamicAttribute::DataType::UnsignedByte;
* @ref Vk::VertexFormat::Vector3ubNormalized;
* @m_class{m-doc-external} [DXGI_FORMAT_R8G8B8_UNORM](https://docs.microsoft.com/en-us/windows/win32/api/dxgiformat/ne-dxgiformat-dxgi_format)
* or @m_class{m-doc-external} [MTLVertexFormatUChar3Normalized](https://developer.apple.com/documentation/metal/mtlvertexformat/mtlvertexformatuchar3normalized?language=objc).
* @m_keywords{DXGI_FORMAT_R8G8B8_UNORM MTLVertexFormatUChar3Normalized}
*/
Vector3ubNormalized,
/**
* @ref Vector3b. Can be used instead of @ref VertexFormat::Vector3 for
* packed 3D positions, in which case the range @f$ [-128, 127] @f$ is
* interpreted as @f$ [-128.0, 127.0] @f$.
*
* Corresponds to three-component @ref GL::DynamicAttribute::Kind::Generic
* or @ref GL::DynamicAttribute::Kind::Integral
* @ref GL::DynamicAttribute::DataType::Byte;
* @ref Vk::VertexFormat::Vector3b;
* @m_class{m-doc-external} [DXGI_FORMAT_R8G8B8_SINT](https://docs.microsoft.com/en-us/windows/win32/api/dxgiformat/ne-dxgiformat-dxgi_format)
* or @m_class{m-doc-external} [MTLVertexFormatChar3](https://developer.apple.com/documentation/metal/mtlvertexformat/mtlvertexformatchar3?language=objc).
* @m_keywords{DXGI_FORMAT_R8G8B8_SINT MTLVertexFormatChar3}
*/
Vector3b,
/**
* @ref Vector3b, with range @f$ [-127, 127] @f$ interpreted as
* @f$ [-1.0, 1.0] @f$. Can be used instead of
* @ref VertexFormat::Vector3 for packed 3D positions and normals.
*
* Corresponds to three-component
* @ref GL::DynamicAttribute::Kind::GenericNormalized
* @ref GL::DynamicAttribute::DataType::Byte;
* @ref Vk::VertexFormat::Vector3bNormalized;
* @m_class{m-doc-external} [DXGI_FORMAT_R8G8B8_SNORM](https://docs.microsoft.com/en-us/windows/win32/api/dxgiformat/ne-dxgiformat-dxgi_format)
* or @m_class{m-doc-external} [MTLVertexFormatChar3Normalized](https://developer.apple.com/documentation/metal/mtlvertexformat/mtlvertexformatchar3normalized?language=objc).
* @m_keywords{DXGI_FORMAT_R8G8B8_SNORM MTLVertexFormatChar3Normalized}
*/
Vector3bNormalized,
/**
* @ref Vector3us. Can be used instead of @ref VertexFormat::Vector3 for
* packed 2D positions, in which case the range @f$ [0, 65535] @f$ is
* interpreted as @f$ [0.0, 65535.0] @f$.
*
* Corresponds to three-component @ref GL::DynamicAttribute::Kind::Generic
* or @ref GL::DynamicAttribute::Kind::Integral
* @ref GL::DynamicAttribute::DataType::UnsignedShort;
* @ref Vk::VertexFormat::Vector3us;
* @m_class{m-doc-external} [DXGI_FORMAT_R16G16B16_UINT](https://docs.microsoft.com/en-us/windows/win32/api/dxgiformat/ne-dxgiformat-dxgi_format)
* or @m_class{m-doc-external} [MTLVertexFormatUShort3](https://developer.apple.com/documentation/metal/mtlvertexformat/mtlvertexformatushort3?language=objc).
* @m_keywords{DXGI_FORMAT_R16G16B16_UINT MTLVertexFormatUShort3}
*/
Vector3us,
/**
* @ref Vector3us or @ref Color3us, with range @f$ [0, 65535] @f$
* interpreted as @f$ [0.0, 1.0] @f$. Can be used instead of
* @ref VertexFormat::Vector2 for packed 3D positions and three-component
* colors.
*
* Corresponds to three-component
* @ref GL::DynamicAttribute::Kind::GenericNormalized
* @ref GL::DynamicAttribute::DataType::UnsignedByte;
* @ref Vk::VertexFormat::Vector3usNormalized;
* @m_class{m-doc-external} [DXGI_FORMAT_R16G16B16_UNORM](https://docs.microsoft.com/en-us/windows/win32/api/dxgiformat/ne-dxgiformat-dxgi_format)
* or @m_class{m-doc-external} [MTLVertexFormatUShort3Normalized](https://developer.apple.com/documentation/metal/mtlvertexformat/mtlvertexformatushort3normalized?language=objc).
* @m_keywords{DXGI_FORMAT_R16G16B16_UNORM MTLVertexFormatUShort3Normalized}
*/
Vector3usNormalized,
/**
* @ref Vector3s. Can be used instead of @ref VertexFormat::Vector3 for
* packed 3D positions, in which case the range @f$ [-32768, 32767] @f$ is
* interpreted as @f$ [-32768.0, 32767.0] @f$.
*
* Corresponds to three-component @ref GL::DynamicAttribute::Kind::Generic
* or @ref GL::DynamicAttribute::Kind::Integral
* @ref GL::DynamicAttribute::DataType::Short;
* @ref Vk::VertexFormat::Vector3s;
* @m_class{m-doc-external} [DXGI_FORMAT_R16G16B16_SINT](https://docs.microsoft.com/en-us/windows/win32/api/dxgiformat/ne-dxgiformat-dxgi_format)
* or @m_class{m-doc-external} [MTLVertexFormatShort3](https://developer.apple.com/documentation/metal/mtlvertexformat/mtlvertexformatshort3?language=objc).
* @m_keywords{DXGI_FORMAT_R16G16B16_SINT MTLVertexFormatShort3}
*/
Vector3s,
/**
* @ref Vector3s, with range @f$ [-32767, 32767] @f$ interpreted as
* @f$ [-1.0, 1.0] @f$. Can be used instead of @ref VertexFormat::Vector3
* for packed 3D positions and normals.
*
* Corresponds to three-component
* @ref GL::DynamicAttribute::Kind::GenericNormalized
* @ref GL::DynamicAttribute::DataType::Short;
* @ref Vk::VertexFormat::Vector3sNormalized;
* @m_class{m-doc-external} [DXGI_FORMAT_R16G16B16_SNORM](https://docs.microsoft.com/en-us/windows/win32/api/dxgiformat/ne-dxgiformat-dxgi_format)
* or @m_class{m-doc-external} [MTLVertexFormatShort3Normalized](https://developer.apple.com/documentation/metal/mtlvertexformat/mtlvertexformatshort3normalized?language=objc).
* @m_keywords{DXGI_FORMAT_R16G16B16_SNORM MTLVertexFormatShort3Normalized}
*/
Vector3sNormalized,
/**
* @ref Vector3ui.
*
* Corresponds to three-component @ref GL::DynamicAttribute::Kind::Generic
* or @ref GL::DynamicAttribute::Kind::Integral
* @ref GL::DynamicAttribute::DataType::UnsignedInt;
* @ref Vk::VertexFormat::Vector3ui;
* @m_class{m-doc-external} [DXGI_FORMAT_R32G32B32_UINT](https://docs.microsoft.com/en-us/windows/win32/api/dxgiformat/ne-dxgiformat-dxgi_format)
* or @m_class{m-doc-external} [MTLVertexFormatUInt3](https://developer.apple.com/documentation/metal/mtlvertexformat/mtlvertexformatuint3?language=objc).
* @m_keywords{DXGI_FORMAT_R32G32B32_UINT MTLVertexFormatUInt3}
*/
Vector3ui,
/**
* @ref Vector3i.
*
* Corresponds to three-component @ref GL::DynamicAttribute::Kind::Generic
* or @ref GL::DynamicAttribute::Kind::Integral
* @ref GL::DynamicAttribute::DataType::Int;
* @ref Vk::VertexFormat::Vector3i;
* @m_class{m-doc-external} [DXGI_FORMAT_R32G32B32_SINT](https://docs.microsoft.com/en-us/windows/win32/api/dxgiformat/ne-dxgiformat-dxgi_format)
* or @m_class{m-doc-external} [MTLVertexFormatInt3](https://developer.apple.com/documentation/metal/mtlvertexformat/mtlvertexformatint3?language=objc).
* @m_keywords{DXGI_FORMAT_R32G32B32_SINT MTLVertexFormatInt3}
*/
Vector3i,
/**
* @ref Vector4 or @ref Color4. Usually used for four-component colors.
*
* Corresponds to four-component @ref GL::DynamicAttribute::Kind::Generic
* @ref GL::DynamicAttribute::DataType::Float;
* @ref Vk::VertexFormat::Vector4;
* @m_class{m-doc-external} [DXGI_FORMAT_R32G32B32A32_FLOAT](https://docs.microsoft.com/en-us/windows/win32/api/dxgiformat/ne-dxgiformat-dxgi_format)
* or @m_class{m-doc-external} [MTLVertexFormatFloat4](https://developer.apple.com/documentation/metal/mtlvertexformat/mtlvertexformatfloat4?language=objc).
* @m_keywords{DXGI_FORMAT_R32G32B32A32_FLOAT MTLVertexFormatFloat4}
*/
Vector4,
/**
* @ref Vector4h or @ref Color4h. Can be used instead of
* @ref VertexFormat::Vector4 for four-component colors.
*
* Corresponds to four-component @ref GL::DynamicAttribute::Kind::Generic
* @ref GL::DynamicAttribute::DataType::Half;
* @ref Vk::VertexFormat::Vector4h;
* @m_class{m-doc-external} [DXGI_FORMAT_R16G16B16A16_FLOAT](https://docs.microsoft.com/en-us/windows/win32/api/dxgiformat/ne-dxgiformat-dxgi_format)
* or @m_class{m-doc-external} [MTLVertexFormatHalf4](https://developer.apple.com/documentation/metal/mtlvertexformat/mtlvertexformathalf4?language=objc).
* @m_keywords{DXGI_FORMAT_R16G16B16A16_FLOAT MTLVertexFormatHalf4}
*/
Vector4h,
/**
* @ref Vector4d.
*
* Corresponds to four-component @ref GL::DynamicAttribute::Kind::Generic
* or @ref GL::DynamicAttribute::Kind::Long
* @ref GL::DynamicAttribute::DataType::Double;
* @ref Vk::VertexFormat::Vector4d. No D3D or Metal equivalent.
*/
Vector4d,
/**
* @ref Vector4ub.
*
* Corresponds to four-component @ref GL::DynamicAttribute::Kind::Generic
* or @ref GL::DynamicAttribute::Kind::Integral
* @ref GL::DynamicAttribute::DataType::UnsignedByte;
* @ref Vk::VertexFormat::Vector4ub;
* @m_class{m-doc-external} [DXGI_FORMAT_R8G8B8A8_UINT](https://docs.microsoft.com/en-us/windows/win32/api/dxgiformat/ne-dxgiformat-dxgi_format)
* or @m_class{m-doc-external} [MTLVertexFormatUChar4](https://developer.apple.com/documentation/metal/mtlvertexformat/mtlvertexformatuchar4?language=objc).
* @m_keywords{DXGI_FORMAT_R8G8B8A8_UINT MTLVertexFormatUChar4}
*/
Vector4ub,
/**
* @ref Vector4ub or @ref Color4ub, with range @f$ [0, 255] @f$ interpreted
* as @f$ [0.0, 1.0] @f$. Can be used instead of @ref VertexFormat::Vector4
* for packed linear four-component colors.
*
* Corresponds to four-component
* @ref GL::DynamicAttribute::Kind::GenericNormalized
* @ref GL::DynamicAttribute::DataType::UnsignedByte;
* @ref Vk::VertexFormat::Vector4ubNormalized;
* @m_class{m-doc-external} [DXGI_FORMAT_R8G8B8A8_UNORM](https://docs.microsoft.com/en-us/windows/win32/api/dxgiformat/ne-dxgiformat-dxgi_format)
* or @m_class{m-doc-external} [MTLVertexFormatUChar4Normalized](https://developer.apple.com/documentation/metal/mtlvertexformat/mtlvertexformatuchar4normalized?language=objc).
* @m_keywords{DXGI_FORMAT_R8G8B8A8_UNORM MTLVertexFormatUChar4Normalized}
*/
Vector4ubNormalized,
/**
* @ref Vector4b.
*
* Corresponds to four-component @ref GL::DynamicAttribute::Kind::Generic
* or @ref GL::DynamicAttribute::Kind::Integral
* @ref GL::DynamicAttribute::DataType::Byte;
* @ref Vk::VertexFormat::Vector4b;
* @m_class{m-doc-external} [DXGI_FORMAT_R8G8B8A8_SINT](https://docs.microsoft.com/en-us/windows/win32/api/dxgiformat/ne-dxgiformat-dxgi_format)
* or @m_class{m-doc-external} [MTLVertexFormatChar4](https://developer.apple.com/documentation/metal/mtlvertexformat/mtlvertexformatchar4?language=objc).
* @m_keywords{DXGI_FORMAT_R8G8B8A8_SINT MTLVertexFormatChar4}
*/
Vector4b,
/**
* @ref Vector4b, with range @f$ [-127, 127] @f$ interpreted as
* @f$ [-1.0, 1.0] @f$.
*
* Corresponds to four-component
* @ref GL::DynamicAttribute::Kind::GenericNormalized
* @ref GL::DynamicAttribute::DataType::Byte;
* @ref Vk::VertexFormat::Vector4bNormalized;
* @m_class{m-doc-external} [DXGI_FORMAT_R8G8B8A8_SNORM](https://docs.microsoft.com/en-us/windows/win32/api/dxgiformat/ne-dxgiformat-dxgi_format)
* or @m_class{m-doc-external} [MTLVertexFormatChar4Normalized](https://developer.apple.com/documentation/metal/mtlvertexformat/mtlvertexformatchar4normalized?language=objc).
* @m_keywords{DXGI_FORMAT_R8G8B8A8_SNORM MTLVertexFormatChar4Normalized}
*/
Vector4bNormalized,
/**
* @ref Vector4us.
*
* Corresponds to four-component @ref GL::DynamicAttribute::Kind::Generic
* or @ref GL::DynamicAttribute::Kind::Integral
* @ref GL::DynamicAttribute::DataType::UnsignedShort;
* @ref Vk::VertexFormat::Vector4us;
* @m_class{m-doc-external} [DXGI_FORMAT_R16G16B16A16_UINT](https://docs.microsoft.com/en-us/windows/win32/api/dxgiformat/ne-dxgiformat-dxgi_format)
* or @m_class{m-doc-external} [MTLVertexFormatUShort4](https://developer.apple.com/documentation/metal/mtlvertexformat/mtlvertexformatushort4?language=objc).
* @m_keywords{DXGI_FORMAT_R16G16B16A16_UINT MTLVertexFormatUShort4}
*/
Vector4us,
/**
* @ref Vector4us or @ref Color4us, with range @f$ [0, 65535] @f$
* interpreted as @f$ [0.0, 1.0] @f$. Can be used instead of
* @ref VertexFormat::Vector4 for packed linear four-component colors.
*
* Corresponds to four-component
* @ref GL::DynamicAttribute::Kind::GenericNormalized
* @ref GL::DynamicAttribute::DataType::UnsignedByte;
* @ref Vk::VertexFormat::Vector4usNormalized;
* @m_class{m-doc-external} [DXGI_FORMAT_R16G16B16A16_UNORM](https://docs.microsoft.com/en-us/windows/win32/api/dxgiformat/ne-dxgiformat-dxgi_format)
* or @m_class{m-doc-external} [MTLVertexFormatUShort4Normalized](https://developer.apple.com/documentation/metal/mtlvertexformat/mtlvertexformatushort4normalized?language=objc).
* @m_keywords{DXGI_FORMAT_R16G16B16A16_UNORM MTLVertexFormatUShort4Normalized}
*/
Vector4usNormalized,
/**
* @ref Vector4s.
*
* Corresponds to four-component @ref GL::DynamicAttribute::Kind::Generic
* or @ref GL::DynamicAttribute::Kind::Integral
* @ref GL::DynamicAttribute::DataType::Short;
* @ref Vk::VertexFormat::Vector4s;
* @m_class{m-doc-external} [DXGI_FORMAT_R16G16B16A16_SINT](https://docs.microsoft.com/en-us/windows/win32/api/dxgiformat/ne-dxgiformat-dxgi_format)
* or @m_class{m-doc-external} [MTLVertexFormatShort4](https://developer.apple.com/documentation/metal/mtlvertexformat/mtlvertexformatshort4?language=objc).
* @m_keywords{DXGI_FORMAT_R16G16B16A16_SINT MTLVertexFormatShort4}
*/
Vector4s,
/**
* @ref Vector4s, with range @f$ [-32767, 32767] @f$ interpreted as
* @f$ [-1.0, 1.0] @f$.
*
* Corresponds to four-component
* @ref GL::DynamicAttribute::Kind::GenericNormalized
* @ref GL::DynamicAttribute::DataType::Short;
* @ref Vk::VertexFormat::Vector4sNormalized;
* @m_class{m-doc-external} [DXGI_FORMAT_R16G16B16A16_SNORM](https://docs.microsoft.com/en-us/windows/win32/api/dxgiformat/ne-dxgiformat-dxgi_format)
* or @m_class{m-doc-external} [MTLVertexFormatShort4Normalized](https://developer.apple.com/documentation/metal/mtlvertexformat/mtlvertexformatshort4normalized?language=objc).
* @m_keywords{DXGI_FORMAT_R16G16B16A16_SNORM MTLVertexFormatShort4Normalized}
*/
Vector4sNormalized,
/**
* @ref Vector4ui.
*
* Corresponds to four-component @ref GL::DynamicAttribute::Kind::Generic
* or @ref GL::DynamicAttribute::Kind::Integral
* @ref GL::DynamicAttribute::DataType::UnsignedInt;
* @ref Vk::VertexFormat::Vector4ui;
* @m_class{m-doc-external} [DXGI_FORMAT_R32G32B32A32_UINT](https://docs.microsoft.com/en-us/windows/win32/api/dxgiformat/ne-dxgiformat-dxgi_format)
* or @m_class{m-doc-external} [MTLVertexFormatUInt4](https://developer.apple.com/documentation/metal/mtlvertexformat/mtlvertexformatuint4?language=objc).
* @m_keywords{DXGI_FORMAT_R32G32B32A32_UINT MTLVertexFormatUInt4}
*/
Vector4ui,
/**
* @ref Vector4i.
*
* Corresponds to four-component @ref GL::DynamicAttribute::Kind::Generic
* or @ref GL::DynamicAttribute::Kind::Integral
* @ref GL::DynamicAttribute::DataType::Int;
* @ref Vk::VertexFormat::Vector4i;
* @m_class{m-doc-external} [DXGI_FORMAT_R32G32B32A32_SINT](https://docs.microsoft.com/en-us/windows/win32/api/dxgiformat/ne-dxgiformat-dxgi_format)
* or @m_class{m-doc-external} [MTLVertexFormatInt4](https://developer.apple.com/documentation/metal/mtlvertexformat/mtlvertexformatint4?language=objc).
* @m_keywords{DXGI_FORMAT_R32G32B32A32_SINT MTLVertexFormatInt4}
*/
Vector4i,
/**
* @ref Matrix2x2.
*
* Same as two @ref VertexFormat::Vector2 tightly following each other and
* bound to consecutive locations.
*/
Matrix2x2,
/**
* @ref Matrix2x2h.
*
* Same as two @ref VertexFormat::Vector2h tightly following each other and
* bound to consecutive locations.
*/
Matrix2x2h,
/**
* @ref Matrix2x2d.
*
* Same as two @ref VertexFormat::Vector2d tightly following each other and
* bound to consecutive locations.
*/
Matrix2x2d,
/**
* @ref Matrix2x2b, with range @f$ [-127, 127] @f$ interpreted as
* @f$ [-1.0, 1.0] @f$.
*
* Same as two @ref VertexFormat::Vector2bNormalized tightly following each
* other and bound to consecutive locations. Note that this type doesn't
* have the columns four-byte aligned, which may negatively affect
* performance --- prefer to use
* @ref VertexFormat::Matrix2x2bNormalizedAligned instead.
*/
Matrix2x2bNormalized,
/**
* @ref Matrix2x2s, with range @f$ [-32767, 32767] @f$ interpreted as
* @f$ [-1.0, 1.0] @f$.
*
* Same as two @ref VertexFormat::Vector2sNormalized tightly following each
* other and bound to consecutive locations.
*/
Matrix2x2sNormalized,
/**
* @ref Matrix2x3.
*
* Same as two @ref VertexFormat::Vector3 tightly following each other and
* bound to consecutive locations.
*/
Matrix2x3,
/**
* @ref Matrix2x3h.
*
* Same as two @ref VertexFormat::Vector3h tightly following each other and
* bound to consecutive locations. Note that this type doesn't have the
* columns four-byte aligned, which may negatively affect performance on
* some APIs --- prefer to use @ref VertexFormat::Matrix2x3hAligned
* instead.
*/
Matrix2x3h,
/**
* @ref Matrix2x3d.
*
* Same as two @ref VertexFormat::Vector3d tightly following each other and
* bound to consecutive locations.
*/
Matrix2x3d,
/**
* @ref Matrix2x3b, with range @f$ [-127, 127] @f$ interpreted as
* @f$ [-1.0, 1.0] @f$.
*
* Same as two @ref VertexFormat::Vector3bNormalized tightly following each
* other and bound to consecutive locations. Note that this type doesn't
* have the columns four-byte aligned, which may negatively affect
* performance --- prefer to use
* @ref VertexFormat::Matrix2x3bNormalizedAligned instead.
*/
Matrix2x3bNormalized,
/**
* @ref Matrix2x3s, with range @f$ [-32767, 32767] @f$ interpreted as
* @f$ [-1.0, 1.0] @f$.
*
* Same as two @ref VertexFormat::Vector3sNormalized tightly following each
* other and bound to consecutive locations. Note that this type doesn't
* have the columns four-byte aligned, which may negatively affect
* performance --- prefer to use
* @ref VertexFormat::Matrix2x3sNormalizedAligned instead.
*/
Matrix2x3sNormalized,
/**
* @ref Matrix2x4.
*
* Same as two @ref VertexFormat::Vector4 tightly following each other and
* bound to consecutive locations.
*/
Matrix2x4,
/**
* @ref Matrix2x4h.
*
* Same as two @ref VertexFormat::Vector4h tightly following each other and
* bound to consecutive locations.
*/
Matrix2x4h,
/**
* @ref Matrix2x4d.
*
* Same as two @ref VertexFormat::Vector4d tightly following each other and
* bound to consecutive locations.
*/
Matrix2x4d,
/**
* @ref Matrix2x4b, with range @f$ [-127, 127] @f$ interpreted as
* @f$ [-1.0, 1.0] @f$.
*
* Same as two @ref VertexFormat::Vector4bNormalized tightly following each
* other and bound to consecutive locations.
*/
Matrix2x4bNormalized,
/**
* @ref Matrix2x4s, with range @f$ [-32767, 32767] @f$ interpreted as
* @f$ [-1.0, 1.0] @f$.
*
* Same as two @ref VertexFormat::Vector4sNormalized tightly following each
* other and bound to consecutive locations.
*/
Matrix2x4sNormalized,
/**
* @ref Matrix2x4b, with range @f$ [-127, 127] @f$ interpreted as
* @f$ [-1.0, 1.0] @f$ and bottom two rows ignored. A variant of
* @ref VertexFormat::Matrix2x2bNormalized that has columns four-byte
* aligned.
*
* Same as two @ref VertexFormat::Vector2bNormalized following each other
* with a 2-byte gap in between, bound to consecutive locations.
*/
Matrix2x2bNormalizedAligned,
/**
* @ref Matrix2x4h, with bottom row ignored. A variant of
* @ref VertexFormat::Matrix2x3h that has columns four-byte aligned.
*
* Same as two @ref VertexFormat::Vector3s following each other with a
* 2-byte gap in between, bound to consecutive locations.
*/
Matrix2x3hAligned,
/**
* @ref Matrix2x4b, with range @f$ [-127, 127] @f$ interpreted as
* @f$ [-1.0, 1.0] @f$ and bottom row ignored. A variant of
* @ref VertexFormat::Matrix2x3bNormalized that has columns four-byte
* aligned.
*
* Same as two @ref VertexFormat::Vector3bNormalized following each other
* with a 1-byte gap in between, bound to consecutive locations.
*/
Matrix2x3bNormalizedAligned,
/**
* @ref Matrix2x4s, with range @f$ [-32767, 32767] @f$ interpreted as
* @f$ [-1.0, 1.0] @f$ and bottom row ignored. A variant of
* @ref VertexFormat::Matrix2x3sNormalized that has columns four-byte
* aligned.
*
* Same as two @ref VertexFormat::Vector3sNormalized following each other
* with a 2-byte gap in between, bound to consecutive locations.
*/
Matrix2x3sNormalizedAligned,
/**
* @ref Matrix3x2.
*
* Same as three @ref VertexFormat::Vector2 tightly following each other
* and bound to consecutive locations.
*/
Matrix3x2,
/**
* @ref Matrix3x2h.
*
* Same as three @ref VertexFormat::Vector2h tightly following each other
* and bound to consecutive locations.
*/
Matrix3x2h,
/**
* @ref Matrix3x2d.
*
* Same as three @ref VertexFormat::Vector2d tightly following each other
* and bound to consecutive locations.
*/
Matrix3x2d,
/**
* @ref Matrix3x2b, with range @f$ [-127, 127] @f$ interpreted as
* @f$ [-1.0, 1.0] @f$.
*
* Same as three @ref VertexFormat::Vector2bNormalized tightly following
* each other and bound to consecutive locations. Note that this type
* doesn't have the columns four-byte aligned, which may negatively affect
* performance --- prefer to use
* @ref VertexFormat::Matrix3x2bNormalizedAligned instead.
*/
Matrix3x2bNormalized,
/**
* @ref Matrix3x2s, with range @f$ [-32767, 32767] @f$ interpreted as
* @f$ [-1.0, 1.0] @f$.
*
* Same as three @ref VertexFormat::Vector2sNormalized tightly following
* each other and bound to consecutive locations.
*/
Matrix3x2sNormalized,
/**
* @ref Matrix3x3 or @ref Matrix3.
*
* Same as three @ref VertexFormat::Vector3 tightly following each other
* and bound to consecutive locations.
*/
Matrix3x3,
/**
* @ref Matrix3x3h.
*
* Same as three @ref VertexFormat::Vector3h tightly following each other
* and bound to consecutive locations. Note that this type doesn't have the
* columns four-byte aligned, which may negatively affect performance on
* some APIs --- prefer to use @ref VertexFormat::Matrix3x3hAligned
* instead.
*/
Matrix3x3h,
/**
* @ref Matrix3x3d or @ref Matrix3d.
*
* Same as three @ref VertexFormat::Vector3d tightly following each other
* and bound to consecutive locations.
*/
Matrix3x3d,
/**
* @ref Matrix3x3b, with range @f$ [-127, 127] @f$ interpreted as
* @f$ [-1.0, 1.0] @f$.
*
* Same as three @ref VertexFormat::Vector3bNormalized tightly following
* each other and bound to consecutive locations. Note that this type
* doesn't have the columns four-byte aligned, which may negatively affect
* performance --- prefer to use
* @ref VertexFormat::Matrix3x3bNormalizedAligned instead.
*/
Matrix3x3bNormalized,
/**
* @ref Matrix3x3s, with range @f$ [-32767, 32767] @f$ interpreted as
* @f$ [-1.0, 1.0] @f$.
*
* Same as three @ref VertexFormat::Vector3sNormalized tightly following
* each other and bound to consecutive locations. Note that this type
* doesn't have the columns four-byte aligned, which may negatively affect
* performance --- prefer to use
* @ref VertexFormat::Matrix3x3sNormalizedAligned instead.
*/
Matrix3x3sNormalized,
/**
* @ref Matrix3x4.
*
* Same as three @ref VertexFormat::Vector4 tightly following each other
* and bound to consecutive locations.
*/
Matrix3x4,
/**
* @ref Matrix3x4h.
*
* Same as three @ref VertexFormat::Vector4h tightly following each other
* and bound to consecutive locations.
*/
Matrix3x4h,
/**
* @ref Matrix3x4d.
*
* Same as three @ref VertexFormat::Vector4d tightly following each other
* and bound to consecutive locations.
*/
Matrix3x4d,
/**
* @ref Matrix3x4b, with range @f$ [-127, 127] @f$ interpreted as
* @f$ [-1.0, 1.0] @f$.
*
* Same as three @ref VertexFormat::Vector4bNormalized tightly following
* each other and bound to consecutive locations.
*/
Matrix3x4bNormalized,
/**
* @ref Matrix3x4s, with range @f$ [-32767, 32767] @f$ interpreted as
* @f$ [-1.0, 1.0] @f$.
*
* Same as three @ref VertexFormat::Vector4sNormalized tightly following
* each other and bound to consecutive locations.
*/
Matrix3x4sNormalized,
/**
* @ref Matrix3x4b, with range @f$ [-127, 127] @f$ interpreted as
* @f$ [-1.0, 1.0] @f$ and bottom two rows ignored. A variant of
* @ref VertexFormat::Matrix3x2bNormalized that has columns four-byte
* aligned.
*
* Same as three @ref VertexFormat::Vector2bNormalized following each other
* with a 2-byte gap in between, bound to consecutive locations.
*/
Matrix3x2bNormalizedAligned,
/**
* @ref Matrix3x4h, with bottom row ignored. A variant of
* @ref VertexFormat::Matrix3x3h that has columns four-byte aligned.
*
* Same as three @ref VertexFormat::Vector3s following each other with a
* 2-byte gap in between, bound to consecutive locations.
*/
Matrix3x3hAligned,
/**
* @ref Matrix3x4b, with range @f$ [-127, 127] @f$ interpreted as
* @f$ [-1.0, 1.0] @f$ and bottom row ignored. A variant of
* @ref VertexFormat::Matrix3x3bNormalized that has columns four-byte
* aligned.
*
* Same as three @ref VertexFormat::Vector3bNormalized following each other
* with a 1-byte gap in between, bound to consecutive locations.
*/
Matrix3x3bNormalizedAligned,
/**
* @ref Matrix3x4s, with range @f$ [-32767, 32767] @f$ interpreted as
* @f$ [-1.0, 1.0] @f$ and bottom row ignored. A variant of
* @ref VertexFormat::Matrix3x3sNormalized that has columns four-byte
* aligned.
*
* Same as three @ref VertexFormat::Vector3sNormalized following each other
* with a 2-byte gap in between, bound to consecutive locations.
*/
Matrix3x3sNormalizedAligned,
/**
* @ref Matrix4x2.
*
* Same as four @ref VertexFormat::Vector2 tightly following each other and
* bound to consecutive locations.
*/
Matrix4x2,
/**
* @ref Matrix4x2h.
*
* Same as four @ref VertexFormat::Vector2h tightly following each other
* and bound to consecutive locations.
*/
Matrix4x2h,
/**
* @ref Matrix4x2d.
*
* Same as four @ref VertexFormat::Vector2d tightly following each other
* and bound to consecutive locations.
*/
Matrix4x2d,
/**
* @ref Matrix4x2b, with range @f$ [-127, 127] @f$ interpreted as
* @f$ [-1.0, 1.0] @f$.
*
* Same as four @ref VertexFormat::Vector2bNormalized tightly following
* each other and bound to consecutive locations. Note that this type
* doesn't have the columns four-byte aligned, which may negatively affect
* performance --- prefer to use
* @ref VertexFormat::Matrix4x2bNormalizedAligned instead.
*/
Matrix4x2bNormalized,
/**
* @ref Matrix4x2s, with range @f$ [-32767, 32767] @f$ interpreted as
* @f$ [-1.0, 1.0] @f$.
*
* Same as four @ref VertexFormat::Vector2sNormalized tightly following
* each other and bound to consecutive locations.
*/
Matrix4x2sNormalized,
/**
* @ref Matrix4x3.
*
* Same as four @ref VertexFormat::Vector3 tightly following each other and
* bound to consecutive locations.
*/
Matrix4x3,
/**
* @ref Matrix4x3h.
*
* Same as four @ref VertexFormat::Vector3h tightly following each other
* and bound to consecutive locations. Note that this type doesn't have the
* columns four-byte aligned, which may negatively affect performance on
* some APIs --- prefer to use @ref VertexFormat::Matrix4x3hAligned
* instead.
*/
Matrix4x3h,
/**
* @ref Matrix4x3d.
*
* Same as four @ref VertexFormat::Vector3d tightly following each other
* and bound to consecutive locations.
*/
Matrix4x3d,
/**
* @ref Matrix4x3b, with range @f$ [-127, 127] @f$ interpreted as
* @f$ [-1.0, 1.0] @f$.
*
* Same as four @ref VertexFormat::Vector3bNormalized tightly following
* each other and bound to consecutive locations. Note that this type
* doesn't have the columns four-byte aligned, which may negatively affect
* performance --- prefer to use
* @ref VertexFormat::Matrix4x3bNormalizedAligned instead.
*/
Matrix4x3bNormalized,
/**
* @ref Matrix4x3s, with range @f$ [-32767, 32767] @f$ interpreted as
* @f$ [-1.0, 1.0] @f$.
*
* Same as four @ref VertexFormat::Vector3sNormalized tightly following
* each other and bound to consecutive locations. Note that this type
* doesn't have the columns four-byte aligned, which may negatively affect
* performance --- prefer to use
* @ref VertexFormat::Matrix4x3sNormalizedAligned instead.
*/
Matrix4x3sNormalized,
/**
* @ref Matrix4x4 or @ref Matrix4.
*
* Same as four @ref VertexFormat::Vector4 tightly following each other
* and bound to consecutive locations.
*/
Matrix4x4,
/**
* @ref Matrix4x4h.
*
* Same as four @ref VertexFormat::Vector4h tightly following each other
* and bound to consecutive locations.
*/
Matrix4x4h,
/**
* @ref Matrix4x4d.
*
* Same as four @ref VertexFormat::Vector4d tightly following each other
* and bound to consecutive locations.
*/
Matrix4x4d,
/**
* @ref Matrix4x4b, with range @f$ [-127, 127] @f$ interpreted as
* @f$ [-1.0, 1.0] @f$.
*
* Same as four @ref VertexFormat::Vector4bNormalized tightly following
* each other and bound to consecutive locations.
*/
Matrix4x4bNormalized,
/**
* @ref Matrix4x4s, with range @f$ [-32767, 32767] @f$ interpreted as
* @f$ [-1.0, 1.0] @f$.
*
* Same as four @ref VertexFormat::Vector4sNormalized tightly following
* each other and bound to consecutive locations.
*/
Matrix4x4sNormalized,
/**
* @ref Matrix4x4b, with range @f$ [-127, 127] @f$ interpreted as
* @f$ [-1.0, 1.0] @f$ and bottom two rows ignored. A variant of
* @ref VertexFormat::Matrix4x2bNormalized that has columns four-byte
* aligned.
*
* Same as four @ref VertexFormat::Vector2bNormalized following each other
* with a 2-byte gap in between, bound to consecutive locations.
*/
Matrix4x2bNormalizedAligned,
/**
* @ref Matrix4x4h, with bottom row ignored. A variant of
* @ref VertexFormat::Matrix3x3h that has columns four-byte aligned.
*
* Same as four @ref VertexFormat::Vector3s following each other with a
* 2-byte gap in between, bound to consecutive locations.
*/
Matrix4x3hAligned,
/**
* @ref Matrix4x4b, with range @f$ [-127, 127] @f$ interpreted as
* @f$ [-1.0, 1.0] @f$ and bottom row ignored. A variant of
* @ref VertexFormat::Matrix4x3bNormalized that has columns four-byte
* aligned.
*
* Same as four @ref VertexFormat::Vector3bNormalized following each other
* with a 1-byte gap in between, bound to consecutive locations.
*/
Matrix4x3bNormalizedAligned,
/**
* @ref Matrix4x4s, with range @f$ [-32767, 32767] @f$ interpreted as
* @f$ [-1.0, 1.0] @f$ and bottom row ignored. A variant of
* @ref VertexFormat::Matrix4x3sNormalized that has columns four-byte
* aligned.
*
* Same as four @ref VertexFormat::Vector3sNormalized following each other
* with a 2-byte gap in between, bound to consecutive locations.
*/
Matrix4x3sNormalizedAligned
};
/**
@debugoperatorenum{VertexFormat}
@m_since{2020,06}
*/
MAGNUM_EXPORT Debug& operator<<(Debug& debug, VertexFormat value);
/**
@brief Whether a @ref VertexFormat value wraps an implementation-specific identifier
@m_since{2020,06}
Returns @cpp true @ce if value of @p format has its highest bit set,
@cpp false @ce otherwise. Use @ref vertexFormatWrap() and @ref vertexFormatUnwrap()
to wrap/unwrap an implementation-specific indentifier to/from
@ref VertexFormat.
*/
constexpr bool isVertexFormatImplementationSpecific(VertexFormat format) {
return UnsignedInt(format) & (1u << 31);
}
/**
@brief Wrap an implementation-specific vertex format identifier in @ref VertexFormat
@m_since{2020,06}
Sets the highest bit on @p type to mark it as implementation-specific. Expects
that @p type fits into the remaining bits. Use @ref vertexFormatUnwrap()
for the inverse operation.
@see @ref isVertexFormatImplementationSpecific()
*/
template<class T> constexpr VertexFormat vertexFormatWrap(T implementationSpecific) {
static_assert(sizeof(T) <= 4, "types larger than 32bits are not supported");
return CORRADE_CONSTEXPR_ASSERT(!(UnsignedInt(implementationSpecific) & (1u << 31)),
"vertexFormatWrap(): implementation-specific value" << reinterpret_cast<void*>(implementationSpecific) << "already wrapped or too large"),
VertexFormat((1u << 31)|UnsignedInt(implementationSpecific));
}
/**
@brief Unwrap an implementation-specific vertex format identifier from @ref VertexFormat
@m_since{2020,06}
Unsets the highest bit from @p type to extract the implementation-specific
value. Expects that @p type has it set. Use @ref vertexFormatWrap() for
the inverse operation.
@see @ref isVertexFormatImplementationSpecific()
*/
template<class T = UnsignedInt> constexpr T vertexFormatUnwrap(VertexFormat format) {
return CORRADE_CONSTEXPR_ASSERT(UnsignedInt(format) & (1u << 31),
"vertexFormatUnwrap():" << format << "isn't a wrapped implementation-specific value"),
T(UnsignedInt(format) & ~(1u << 31));
}
/**
@brief Size of given vertex format
@m_since{2020,06}
To get size of a single component, call this function on a result of
@ref vertexFormatComponentFormat().
*/
MAGNUM_EXPORT UnsignedInt vertexFormatSize(VertexFormat format);
/**
@brief Component format of given vertex format
@m_since{2020,06}
The function also removes the normalization aspect from the type --- use
@ref isVertexFormatNormalized() to query that. Returns for example
@ref VertexFormat::Short for @ref VertexFormat::ShortNormalized or
@ref VertexFormat::UnsignedByte for @ref VertexFormat::Vector3ub.
Calling @ref vertexFormatComponentCount() on the return value will always
give @cpp 1 @ce; calling @ref isVertexFormatNormalized() on the return
value will always give @cpp false @ce.
@see @ref vertexFormat(VertexFormat, UnsignedInt, bool)
*/
MAGNUM_EXPORT VertexFormat vertexFormatComponentFormat(VertexFormat format);
/**
@brief Component count of given vertex format
@m_since{2020,06}
Returns @cpp 1 @ce for scalar types and e.g. @cpp 3 @ce for
@ref VertexFormat::Vector3ub.
@see @ref vertexFormat(VertexFormat, UnsignedInt, bool)
*/
MAGNUM_EXPORT UnsignedInt vertexFormatComponentCount(VertexFormat format);
/**
@brief Vector count of given vertex format
@m_since{2020,06}
Returns @cpp 1 @ce for scalar and vector types and e.g. @cpp 3 @ce for
@ref VertexFormat::Matrix3x2d.
*/
MAGNUM_EXPORT UnsignedInt vertexFormatVectorCount(VertexFormat format);
/**
@brief Vector stride of given vertex format
@m_since{2020,06}
Returns type size for scalar and vector types and e.g. @cpp 8 @ce for
@ref VertexFormat::Matrix2x3hAligned (but @cpp 6 @ce for
@ref VertexFormat::Matrix2x3h).
*/
MAGNUM_EXPORT UnsignedInt vertexFormatVectorStride(VertexFormat format);
/**
@brief Component count of given vertex format
@m_since{2020,06}
Returns @cpp true @ce for `*Normalized` types, @cpp false @ce otherwise. In
particular, floating-point types are *not* treated as normalized, even though
for example colors might commonly have values only in the @f$ [0.0, 1.0] @f$
range (or normals in the @f$ [-1.0, 1.0] @f$ range).
@see @ref vertexFormat(VertexFormat, UnsignedInt, bool)
*/
MAGNUM_EXPORT bool isVertexFormatNormalized(VertexFormat format);
/**
@brief Assemble a vertex format from parts
@m_since{2020,06}
Converts @p format to a new format of desired component count and
normalization. Expects that @p componentCount is not larger than @cpp 4 @ce and
@p normalized is @cpp true @ce only for 8- and 16-byte integer types.
@see @ref vertexFormatComponentFormat(),
@ref vertexFormatComponentCount(),
@ref isVertexFormatNormalized()
*/
MAGNUM_EXPORT VertexFormat vertexFormat(VertexFormat format, UnsignedInt componentCount, bool normalized);
/**
@brief Assemble a matrix vertex format from parts
@m_since{2020,06}
Converts @p format to a new format of desired component and vertex count and
normalization. Expects that both @p vectorCount and @p componentCount is either
@cpp 2 @ce, @cpp 3 @ce or @cpp 4 @ce, and @p format is floating-point or
8-/16-bit signed integer.
@see @ref vertexFormatComponentFormat(),
@ref vertexFormatComponentCount(),
@ref vertexFormatVectorCount(),
@ref vertexFormatVectorStride(),
@ref isVertexFormatNormalized()
*/
MAGNUM_EXPORT VertexFormat vertexFormat(VertexFormat format, UnsignedInt vectorCount, UnsignedInt componentCount, bool aligned);
}
namespace Corrade { namespace Utility {
/**
@configurationvalue{Magnum::VertexFormat}
@m_since{2020,06}
*/
template<> struct MAGNUM_EXPORT ConfigurationValue<Magnum::VertexFormat> {
ConfigurationValue() = delete;
/**
* @brief Write enum value as string
*
* If the value is invalid, returns empty string.
*/
static std::string toString(Magnum::VertexFormat value, ConfigurationValueFlags);
/**
* @brief Read enum value as string
*
* If the value is invalid, returns a zero (invalid) type.
*/
static Magnum::VertexFormat fromString(const std::string& stringValue, ConfigurationValueFlags);
};
}}
#endif