#ifndef Magnum_Magnum_h #define Magnum_Magnum_h /* This file is part of Magnum. Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019 Vladimír Vondruš 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 Forward declarations and basic types for the @ref Magnum namespace */ #include #include "Magnum/Types.h" #include "Magnum/Math/Math.h" namespace Magnum { /* Bring whole Corrade namespace */ using namespace Corrade; /* Bring debugging facility from Corrade::Utility namespace */ using Corrade::Utility::Debug; using Corrade::Utility::Warning; using Corrade::Utility::Error; using Corrade::Utility::Fatal; #ifdef DOXYGEN_GENERATING_OUTPUT /** @brief Build with deprecated API included Defined if the library contains deprecated API (which will be removed in the future). To preserve backward compatibility, Magnum is by default built with deprecated API included. @see @ref building, @ref cmake */ #define MAGNUM_BUILD_DEPRECATED /* (enabled by default) */ /** @brief Static library build Defined if built as static libraries. Default are shared libraries. @see @ref building, @ref cmake */ #define MAGNUM_BUILD_STATIC #undef MAGNUM_BUILD_STATIC #ifdef MAGNUM_BUILD_DEPRECATED /** @brief Multi-threaded build * @deprecated Use @ref CORRADE_BUILD_MULTITHREADED instead. */ #define MAGNUM_BUILD_MULTITHREADED #undef MAGNUM_BUILD_MULTITHREADED #endif /** @brief OpenGL interoperability Defined if the engine is built with OpenGL interoperability enabled --- extra APIs in various libraries interacting with the @ref Magnum::GL "GL" library. Enabled by default in case the @ref Magnum::GL "GL" library is built. @see @ref MAGNUM_TARGET_GLES2, @ref MAGNUM_TARGET_GLES3, @ref MAGNUM_TARGET_DESKTOP_GLES, @ref building, @ref cmake */ #define MAGNUM_TARGET_GL /* (enabled by default) */ /** @brief OpenGL ES target Defined if the engine is built for OpenGL ES 3.0 or OpenGL ES 2.0. @see @ref MAGNUM_TARGET_GLES2, @ref MAGNUM_TARGET_GLES3, @ref MAGNUM_TARGET_DESKTOP_GLES, @ref building, @ref cmake */ #define MAGNUM_TARGET_GLES #undef MAGNUM_TARGET_GLES /** @brief OpenGL ES 2.0 target Defined if the engine is built for OpenGL ES 2.0. Implies also @ref MAGNUM_TARGET_GLES. @see @ref MAGNUM_TARGET_GLES3, @ref MAGNUM_TARGET_DESKTOP_GLES, @ref building, @ref cmake */ #define MAGNUM_TARGET_GLES2 #undef MAGNUM_TARGET_GLES2 /** @brief OpenGL ES 3.0 target Defined if the engine is built for OpenGL ES 3.0. Implies also @ref MAGNUM_TARGET_GLES. @see @ref MAGNUM_TARGET_GLES2, @ref MAGNUM_TARGET_DESKTOP_GLES, @ref building, @ref cmake */ #define MAGNUM_TARGET_GLES3 #undef MAGNUM_TARGET_GLES3 /** @brief Desktop emulation of OpenGL ES target Defined if the engine is built for OpenGL ES 3.0 or OpenGL ES 2.0 emulated within standard desktop OpenGL. Implies also @ref MAGNUM_TARGET_GLES. @see @ref MAGNUM_TARGET_GLES2, @ref MAGNUM_TARGET_GLES3, @ref building, @ref cmake */ #define MAGNUM_TARGET_DESKTOP_GLES #undef MAGNUM_TARGET_DESKTOP_GLES /** @brief WebGL target Defined if the engine is built for WebGL (using Emscripten). WebGL is nearly equivalent to OpenGL ES 2.0, thus in most cases you don't need to treat it differently, but there are some [specific restrictions and features](http://www.khronos.org/registry/webgl/specs/latest/1.0/#6) which you might want to be aware of. Implies also @ref MAGNUM_TARGET_GLES and @ref MAGNUM_TARGET_GLES2. @see @ref CORRADE_TARGET_EMSCRIPTEN, @ref building, @ref cmake */ #define MAGNUM_TARGET_WEBGL #undef MAGNUM_TARGET_WEBGL /** @brief Headless target Defined if the engine is built for use on a headless machine (without any graphical desktop environment). Basically it means that EGL with no display attachment is being used everywhere instead of platform-specific toolkits like CGL, GLX or WGL. Note that this might not be supported on all platforms, see @ref Magnum::Platform::WindowlessEglApplication "Platform::WindowlessEglApplication" for more information. */ #define MAGNUM_TARGET_HEADLESS #undef MAGNUM_TARGET_HEADLESS /** @brief Vulkan interoperability Defined if the engine is built with Vulkan interoperability enabled --- extra APIs in various libraries interacting with the @ref Magnum::Vk "Vk" library. Enabled by default in case the @ref Magnum::Vk "Vk" library is built. @see @ref building, @ref cmake */ #define MAGNUM_TARGET_VK #undef MAGNUM_TARGET_VK #endif /** @{ @name Basic type definitions See @ref types for more information. */ /** @brief Unsigned byte (8bit) */ typedef std::uint8_t UnsignedByte; /** @brief Signed byte (8bit) */ typedef std::int8_t Byte; /** @brief Unsigned short (16bit) */ typedef std::uint16_t UnsignedShort; /** @brief Signed short (16bit) */ typedef std::int16_t Short; /** @brief Unsigned int (32bit) Equivalent to GLSL @glsl uint @ce. @m_keyword{uint,GLSL uint,} */ typedef std::uint32_t UnsignedInt; /** @brief Signed int (32bit) Equivalent to GLSL @glsl int @ce. @m_keyword{int,GLSL int,} */ typedef std::int32_t Int; #ifndef CORRADE_TARGET_EMSCRIPTEN /** @brief Unsigned long (64bit) @partialsupport 64-bit integers are not available under @ref CORRADE_TARGET_EMSCRIPTEN "Emscripten". */ typedef std::uint64_t UnsignedLong; /** @brief Signed long (64bit) @partialsupport 64-bit integers are not available in @ref CORRADE_TARGET_EMSCRIPTEN "Emscripten". */ typedef std::int64_t Long; #endif /** @brief Float (32bit) Equivalent to GLSL @glsl float @ce. @m_keyword{float,GLSL float,} */ typedef float Float; /** @brief Half (16bit) */ typedef Math::Half Half; /** @brief Two-component bool vector Equivalent to GLSL @glsl bvec2 @ce. @m_keyword{bvec2,GLSL bvec2,} */ typedef Math::BoolVector<2> BoolVector2; /** @brief Three-component bool vector Equivalent to GLSL @glsl bvec3 @ce. @m_keyword{bvec3,GLSL bvec3,} */ typedef Math::BoolVector<3> BoolVector3; /** @brief Four-component bool vector Equivalent to GLSL @glsl bvec4 @ce. @m_keyword{bvec4,GLSL bvec4,} */ typedef Math::BoolVector<4> BoolVector4; /** @brief Two-component float vector Equivalent to GLSL @glsl vec2 @ce. @m_keyword{vec2,GLSL vec2,} */ typedef Math::Vector2 Vector2; /** @brief Three-component float vector Equivalent to GLSL @glsl vec3 @ce. @m_keyword{vec3,GLSL vec3,} */ typedef Math::Vector3 Vector3; /** @brief Four-component float vector Equivalent to GLSL @glsl vec4 @ce. @m_keyword{vec4,GLSL vec4,} */ typedef Math::Vector4 Vector4; /** @brief Two-component unsigned integer vector Equivalent to GLSL @glsl uvec2 @ce. @m_keyword{uvec2,GLSL uvec2,} */ typedef Math::Vector2 Vector2ui; /** @brief Three-component unsigned integer vector Equivalent to GLSL @glsl uvec3 @ce. @m_keyword{uvec3,GLSL uvec3,} */ typedef Math::Vector3 Vector3ui; /** @brief Four-component unsigned integer vector Equivalent to GLSL @glsl uvec4 @ce. @m_keyword{uvec4,GLSL uvec4,} */ typedef Math::Vector4 Vector4ui; /** @brief Two-component signed integer vector Equivalent to GLSL @glsl ivec2 @ce. @m_keyword{ivec2,GLSL ivec2,} */ typedef Math::Vector2 Vector2i; /** @brief Three-component signed integer vector Equivalent to GLSL @glsl ivec3 @ce. @m_keyword{ivec3,GLSL ivec3,} */ typedef Math::Vector3 Vector3i; /** @brief Four-component signed integer vector Equivalent to GLSL @glsl ivec4 @ce. @m_keyword{ivec4,GLSL ivec4,} */ typedef Math::Vector4 Vector4i; /** @brief Three-component (RGB) float color */ typedef Math::Color3 Color3; /** @brief Four-component (RGBA) float color */ typedef Math::Color4 Color4; /** @brief HSV float color */ typedef Math::ColorHsv ColorHsv; /** @brief Three-component (RGB) unsigned byte color @attention 8bit-per-channel colors are commonly treated as being in sRGB color space, which is not directly usable in calculations and has to be converted to linear RGB first. Use @ref Color3::fromSrgb() and @ref Color3::toSrgb() for proper sRGB handling. */ typedef Math::Color3 Color3ub; /** @brief Four-component (RGBA) unsigned byte color @attention 8bit-per-channel colors are commonly treated as being in sRGB color space, which is not directly usable in calculations and has to be converted to linear RGB first. Use @ref Color4::fromSrgbAlpha() and @ref Color4::toSrgbAlpha() for proper sRGB handling. */ typedef Math::Color4 Color4ub; /** @brief 3x3 float transformation matrix Equivalent to GLSL @glsl mat3 @ce. @see @ref Matrix3x3 @m_keyword{mat3,GLSL mat3,} */ typedef Math::Matrix3 Matrix3; /** @brief 4x4 float transformation matrix Equivalent to GLSL @glsl mat4 @ce. @see @ref Matrix4x4 @m_keyword{mat4,GLSL mat4,} */ typedef Math::Matrix4 Matrix4; /** @brief 2x2 float matrix Equivalent to GLSL @glsl mat2x2 @ce. @m_keyword{mat2x2,GLSL mat2x2,} */ typedef Math::Matrix2x2 Matrix2x2; /** @brief 3x3 float matrix Equivalent to GLSL @glsl mat3x3 @ce. Note that this is different from @ref Matrix3, which contains additional functions for transformations in 2D. @m_keyword{mat3x3,GLSL mat3x3,} */ typedef Math::Matrix3x3 Matrix3x3; /** @brief 4x4 float matrix Equivalent to GLSL @glsl mat4x4 @ce. Note that this is different from @ref Matrix4, which contains additional functions for transformations in 3D. @m_keyword{mat4x4,GLSL mat4x4,} */ typedef Math::Matrix4x4 Matrix4x4; /** @brief Float matrix with 2 columns and 3 rows Equivalent to GLSL @glsl mat2x3 @ce. @m_keyword{mat2x3,GLSL mat2x3,} */ typedef Math::Matrix2x3 Matrix2x3; /** @brief Float matrix with 3 columns and 2 rows Equivalent to GLSL @glsl mat3x2 @ce. @m_keyword{mat3x2,GLSL mat3x2,} */ typedef Math::Matrix3x2 Matrix3x2; /** @brief Float matrix with 2 columns and 4 rows Equivalent to GLSL @glsl mat2x4 @ce. @m_keyword{mat2x4,GLSL mat2x4,} */ typedef Math::Matrix2x4 Matrix2x4; /** @brief Float matrix with 4 columns and 2 rows Equivalent to GLSL @glsl mat2x4 @ce. @m_keyword{mat2x4,GLSL mat2x4,} */ typedef Math::Matrix4x2 Matrix4x2; /** @brief Float matrix with 3 columns and 4 rows Equivalent to GLSL @glsl mat3x4 @ce. @m_keyword{mat3x4,GLSL mat3x4,} */ typedef Math::Matrix3x4 Matrix3x4; /** @brief Float matrix with 4 columns and 3 rows Equivalent to GLSL @glsl mat4x3 @ce. @m_keyword{mat4x3,GLSL mat4x3,} */ typedef Math::Matrix4x3 Matrix4x3; /** @brief Float two-dimensional quadratic Bézier curve */ typedef Math::QuadraticBezier2D QuadraticBezier2D; /** @brief Float three-dimensional quadratic Bézier curve */ typedef Math::QuadraticBezier3D QuadraticBezier3D; /** @brief Float two-dimensional cubic Bézier curve */ typedef Math::CubicBezier2D CubicBezier2D; /** @brief Float three-dimensional cubic Bézier curve */ typedef Math::CubicBezier3D CubicBezier3D; /** @brief Float scalar cubic Hermite spline point */ typedef Math::CubicHermite1D CubicHermite1D; /** @brief Float two-dimensional cubic Hermite spline point */ typedef Math::CubicHermite2D CubicHermite2D; /** @brief Float three-dimensional cubic Hermite spline point */ typedef Math::CubicHermite3D CubicHermite3D; /** @brief Float cubic Hermite spline complex number */ typedef Math::CubicHermiteComplex CubicHermiteComplex; /** @brief Float cubic Hermite spline quaternion */ typedef Math::CubicHermiteQuaternion CubicHermiteQuaternion; /** @brief Float complex number */ typedef Math::Complex Complex; /** @brief Float dual complex number */ typedef Math::DualComplex DualComplex; /** @brief Float quaternion */ typedef Math::Quaternion Quaternion; /** @brief Float dual quaternion */ typedef Math::DualQuaternion DualQuaternion; /** @brief Float constants */ typedef Math::Constants Constants; /** @brief Angle in float degrees */ typedef Math::Deg Deg; /** @brief Angle in float radians */ typedef Math::Rad Rad; /** @brief One-dimensional float range */ typedef Math::Range1D Range1D; /** @brief Two-dimensional float range */ typedef Math::Range2D Range2D; /** @brief Three-dimensional float range */ typedef Math::Range3D Range3D; /** @brief One-dimensional signed integer range */ typedef Math::Range1D Range1Di; /** @brief Two-dimensional signed integer range */ typedef Math::Range2D Range2Di; /** @brief Three-dimensional signed integer range */ typedef Math::Range3D Range3Di; /** @brief Float frustum */ typedef Math::Frustum Frustum; /*@}*/ /** @{ @name Double-precision types See @ref types for more information. */ /** @brief Double (64bit) Equivalent to GLSL @glsl double @ce. @m_keyword{double,GLSL double,} */ typedef double Double; /** @brief Two-component double vector Equivalent to GLSL @glsl dvec2 @ce. @m_keyword{dvec2,GLSL dvec2,} */ typedef Math::Vector2 Vector2d; /** @brief Three-component double vector Equivalent to GLSL @glsl dvec3 @ce. @m_keyword{dvec3,GLSL dvec3,} */ typedef Math::Vector3 Vector3d; /** @brief Four-component double vector Equivalent to GLSL @glsl dvec4 @ce. @m_keyword{dvec4,GLSL dvec4,} */ typedef Math::Vector4 Vector4d; /** @brief 3x3 double transformation matrix Equivalent to GLSL @glsl dmat3 @ce. @see @ref Matrix3x3d @m_keyword{dmat3,GLSL dmat3,} */ typedef Math::Matrix3 Matrix3d; /** @brief 4x4 double transformation matrix Equivalent to GLSL @glsl dmat4 @ce. @see @ref Matrix4x4d @m_keyword{dmat4,GLSL dmat4,} */ typedef Math::Matrix4 Matrix4d; /** @brief 2x2 double matrix Equivalent to GLSL @glsl dmat2x2 @ce. @m_keyword{dmat2x2,GLSL dmat2x2,} */ typedef Math::Matrix2x2 Matrix2x2d; /** @brief 3x3 double matrix Equivalent to GLSL @glsl dmat3x3 @ce. Note that this is different from @ref Matrix3d, which contains additional functions for transformations in 2D. @m_keyword{dmat3x3,GLSL dmat3x3,} */ typedef Math::Matrix3x3 Matrix3x3d; /** @brief 4x4 double matrix Equivalent to GLSL @glsl dmat4x4 @ce. Note that this is different from @ref Matrix4d, which contains additional functions for transformations in 3D. @m_keyword{dmat4x4,GLSL dmat4x4,} */ typedef Math::Matrix4x4 Matrix4x4d; /** @brief Double matrix with 2 columns and 3 rows Equivalent to GLSL @glsl dmat2x3 @ce. @m_keyword{dmat2x3,GLSL dmat2x3,} */ typedef Math::Matrix2x3 Matrix2x3d; /** @brief Double matrix with 3 columns and 2 rows Equivalent to GLSL @glsl dmat3x2 @ce. @m_keyword{dmat3x2,GLSL dmat3x2,} */ typedef Math::Matrix3x2 Matrix3x2d; /** @brief Double matrix with 2 columns and 4 rows Equivalent to GLSL @glsl dmat2x4 @ce. @m_keyword{dmat2x4,GLSL dmat2x4,} */ typedef Math::Matrix2x4 Matrix2x4d; /** @brief Double matrix with 4 columns and 2 rows Equivalent to GLSL @glsl dmat4x2 @ce. @m_keyword{dmat4x2,GLSL dmat4x2,} */ typedef Math::Matrix4x2 Matrix4x2d; /** @brief Double matrix with 3 columns and 4 rows Equivalent to GLSL @glsl dmat3x4 @ce. @m_keyword{dmat3x4,GLSL dmat3x4,} */ typedef Math::Matrix3x4 Matrix3x4d; /** @brief Double matrix with 4 columns and 3 rows Equivalent to GLSL @glsl dmat4x3 @ce. @m_keyword{dmat4x3,GLSL dmat4x3,} */ typedef Math::Matrix4x3 Matrix4x3d; /** @brief Double two-dimensional quadratic Bézier curve */ typedef Math::QuadraticBezier2D QuadraticBezier2Dd; /** @brief Double three-dimensional quadratic Bézier curve */ typedef Math::QuadraticBezier3D QuadraticBezier3Dd; /** @brief Double two-dimensional cubic Bézier curve */ typedef Math::CubicBezier2D CubicBezier2Dd; /** @brief Double three-dimensional cubic Bézier curve */ typedef Math::CubicBezier3D CubicBezier3Dd; /** @brief Double scalar cubic Hermite spline point */ typedef Math::CubicHermite1D CubicHermite1Dd; /** @brief Double two-dimensional cubic Hermite spline point */ typedef Math::CubicHermite2D CubicHermite2Dd; /** @brief Double three-dimensional cubic Hermite spline point */ typedef Math::CubicHermite3D CubicHermite3Dd; /** @brief Double cubic Hermite spline complex number */ typedef Math::CubicHermiteComplex CubicHermiteComplexd; /** @brief Double cubic Hermite spline quaternion */ typedef Math::CubicHermiteQuaternion CubicHermiteQuaterniond; /** @brief Double complex number */ typedef Math::Complex Complexd; /** @brief Double dual complex number */ typedef Math::DualComplex DualComplexd; /** @brief Double quaternion */ typedef Math::Quaternion Quaterniond; /** @brief Double dual quaternion */ typedef Math::DualQuaternion DualQuaterniond; /** @brief Double constants */ typedef Math::Constants Constantsd; /** @brief Angle in double degrees */ typedef Math::Deg Degd; /** @brief Angle in double radians */ typedef Math::Rad Radd; /** @brief One-dimensional double range */ typedef Math::Range1D Range1Dd; /** @brief Two-dimensional double range */ typedef Math::Range2D Range2Dd; /** @brief Three-dimensional double range */ typedef Math::Range3D Range3Dd; /** @brief Double frustum */ typedef Math::Frustum Frustumd; /*@}*/ #ifndef DOXYGEN_GENERATING_OUTPUT template class Array; template class Array1D; template class Array2D; template class Array3D; enum class InputFileCallbackPolicy: UnsignedByte; template class Image; typedef Image<1> Image1D; typedef Image<2> Image2D; typedef Image<3> Image3D; template class CompressedImage; typedef CompressedImage<1> CompressedImage1D; typedef CompressedImage<2> CompressedImage2D; typedef CompressedImage<3> CompressedImage3D; template class ImageView; template using BasicImageView = ImageView; typedef BasicImageView<1> ImageView1D; typedef BasicImageView<2> ImageView2D; typedef BasicImageView<3> ImageView3D; template using BasicMutableImageView = ImageView; typedef BasicMutableImageView<1> MutableImageView1D; typedef BasicMutableImageView<2> MutableImageView2D; typedef BasicMutableImageView<3> MutableImageView3D; template class CompressedImageView; template using BasicCompressedImageView = CompressedImageView; typedef BasicCompressedImageView<1> CompressedImageView1D; typedef BasicCompressedImageView<2> CompressedImageView2D; typedef BasicCompressedImageView<3> CompressedImageView3D; template using BasicMutableCompressedImageView = CompressedImageView; typedef BasicMutableCompressedImageView<1> MutableCompressedImageView1D; typedef BasicMutableCompressedImageView<2> MutableCompressedImageView2D; typedef BasicMutableCompressedImageView<3> MutableCompressedImageView3D; enum class MeshPrimitive: UnsignedInt; enum class MeshIndexType: UnsignedInt; enum class PixelFormat: UnsignedInt; enum class CompressedPixelFormat: UnsignedInt; class PixelStorage; class CompressedPixelStorage; enum class ResourceState: UnsignedByte; enum class ResourceDataState: UnsignedByte; enum class ResourcePolicy: UnsignedByte; template class Resource; class ResourceKey; template class ResourceManager; enum class SamplerFilter: UnsignedInt; enum class SamplerMipmap: UnsignedInt; enum class SamplerWrapping: UnsignedInt; class Timeline; #endif } #endif