Magnum::Primitives namespace

enum class Magnum::Primitives::CapsuleFlag: UnsignedByte new in 2020.06

#include <Magnum/Primitives/Capsule.h>

Capsule flag.

enum class Magnum::Primitives::CapsuleTextureCoords: UnsignedByte

#include <Magnum/Primitives/Capsule.h>

Whether to generate capsule texture coordinates.

enum class Magnum::Primitives::Circle2DFlag: UnsignedByte new in 2020.06

#include <Magnum/Primitives/Circle.h>

2D circle flag

enum class Magnum::Primitives::CircleTextureCoords: UnsignedByte

#include <Magnum/Primitives/Circle.h>

Whether to generate circle texture coordinates.

enum class Magnum::Primitives::Circle3DFlag: UnsignedByte new in 2020.06

#include <Magnum/Primitives/Circle.h>

3D circle flag

enum class Magnum::Primitives::ConeFlag: UnsignedByte

#include <Magnum/Primitives/Cone.h>

Cone flag.

enum class Magnum::Primitives::CylinderFlag: UnsignedByte

#include <Magnum/Primitives/Cylinder.h>

Cylinder flag.

enum class Magnum::Primitives::GridFlag: UnsignedByte

#include <Magnum/Primitives/Grid.h>

Grid flag.

enum class Magnum::Primitives::PlaneFlag: UnsignedByte new in 2020.06

#include <Magnum/Primitives/Plane.h>

Plane flag.

enum class Magnum::Primitives::PlaneTextureCoords: UnsignedByte

#include <Magnum/Primitives/Plane.h>

Whether to generate plane texture coordinates.

enum class Magnum::Primitives::SquareFlag: UnsignedByte new in 2020.06

#include <Magnum/Primitives/Square.h>

Square flag.

enum class Magnum::Primitives::SquareTextureCoords: UnsignedByte

#include <Magnum/Primitives/Square.h>

Whether to generate square texture coordinates.

enum class Magnum::Primitives::UVSphereFlag: UnsignedByte new in 2020.06

#include <Magnum/Primitives/UVSphere.h>

UV sphere flag.

enum class Magnum::Primitives::UVSphereTextureCoords: UnsignedByte

#include <Magnum/Primitives/UVSphere.h>

Whether to generate UV sphere texture coordinates.

typedef Containers::EnumSet<CapsuleFlag> Magnum::Primitives::CapsuleFlags new in 2020.06

#include <Magnum/Primitives/Capsule.h>

Capsule flags.

typedef Containers::EnumSet<Circle2DFlag> Magnum::Primitives::Circle2DFlags new in 2020.06

#include <Magnum/Primitives/Circle.h>

2D circle flags

typedef Containers::EnumSet<Circle3DFlag> Magnum::Primitives::Circle3DFlags new in 2020.06

#include <Magnum/Primitives/Circle.h>

3D circle flags

typedef Containers::EnumSet<ConeFlag> Magnum::Primitives::ConeFlags

#include <Magnum/Primitives/Cone.h>

Cone flags.

typedef Containers::EnumSet<CylinderFlag> Magnum::Primitives::CylinderFlags

#include <Magnum/Primitives/Cylinder.h>

Cylinder flags.

typedef Containers::EnumSet<GridFlag> Magnum::Primitives::GridFlags

#include <Magnum/Primitives/Grid.h>

Grid flags.

typedef Containers::EnumSet<PlaneFlag> Magnum::Primitives::PlaneFlags new in 2020.06

#include <Magnum/Primitives/Plane.h>

Plane flags.

typedef Containers::EnumSet<SquareFlag> Magnum::Primitives::SquareFlags new in 2020.06

#include <Magnum/Primitives/Square.h>

Square flags.

typedef Containers::EnumSet<UVSphereFlag> Magnum::Primitives::UVSphereFlags new in 2020.06

#include <Magnum/Primitives/UVSphere.h>

UV sphere flags.

Trade::MeshData Magnum::Primitives::axis2D()

#include <Magnum/Primitives/Axis.h>

2D axis

Two color-coded arrows for visualizing orientation (XY is RG), going from 0.0f to 1.0f on the X and Y axis. MeshPrimitive::Lines with MeshIndexType::UnsignedShort indices, interleaved VertexFormat::Vector2 positions and VertexFormat::Vector3 colors. The returned instance references Trade::DataFlag::Global data — pass the mesh through MeshTools::copy() to get a mutable copy, if needed.

Trade::MeshData Magnum::Primitives::axis3D()

#include <Magnum/Primitives/Axis.h>

3D axis

Three color-coded arrows for visualizing orientation (XYZ is RGB), going from 0.0f to 1.0f on the X, Y and Z axis. MeshPrimitive::Lines with MeshIndexType::UnsignedShort indices, interleaved VertexFormat::Vector3 positions and VertexFormat::Vector3 colors. The returned instance references Trade::DataFlag::Global data — pass the mesh through MeshTools::copy() to get a mutable copy, if needed.

Trade::MeshData Magnum::Primitives::capsule2DWireframe(UnsignedInt hemisphereRings, UnsignedInt cylinderRings, Float halfLength)

#include <Magnum/Primitives/Capsule.h>

Wireframe 2D capsule.

Cylinder of radius 1.0f along the Y axis, centered at origin, with hemispheres instead of caps. MeshPrimitive::Lines with MeshIndexType::UnsignedInt indices and VertexFormat::Vector2 positions.

Trade::MeshData Magnum::Primitives::capsule3DSolid(UnsignedInt hemisphereRings, UnsignedInt cylinderRings, UnsignedInt segments, Float halfLength, CapsuleFlags flags = {}) new in 2020.06

#include <Magnum/Primitives/Capsule.h>

Solid 3D capsule.

Cylinder of radius 1.0f along the Y axis, centered at origin, with hemispheres instead of caps. MeshPrimitive::Triangles with MeshIndexType::UnsignedInt indices, interleaved VertexFormat::Vector3 positions, VertexFormat::Vector3 normals, optional VertexFormat::Vector4 tangents and optional VertexFormat::Vector2 texture coordinates. If texture coordinates are generated, vertices of one segment are duplicated for texture wrapping.

The capsule is by default created with radius set to . In order to get radius , length and preserve correct normals, set halfLength to and then scale all positions by , for example using MeshTools::transform3D().

Trade::MeshData Magnum::Primitives::capsule3DSolid(UnsignedInt hemisphereRings, UnsignedInt cylinderRings, UnsignedInt segments, Float halfLength, CapsuleTextureCoords textureCoords)

#include <Magnum/Primitives/Capsule.h>

Solid 3D capsule.

Trade::MeshData Magnum::Primitives::capsule3DWireframe(UnsignedInt hemisphereRings, UnsignedInt cylinderRings, UnsignedInt segments, Float halfLength)

#include <Magnum/Primitives/Capsule.h>

Wireframe 3D capsule.

Cylinder of radius 1.0f along the Y axis, centered at origin, with hemispheres instead of caps. MeshPrimitive::Lines with MeshIndexType::UnsignedInt indices and VertexFormat::Vector3 positions.

Trade::MeshData Magnum::Primitives::circle2DSolid(UnsignedInt segments, Circle2DFlags flags = {}) new in 2020.06

#include <Magnum/Primitives/Circle.h>

Solid 2D circle.

Circle with radius 1.0f, centered at origin. MeshPrimitive::TriangleFan with MeshIndexType::UnsignedInt indices, interleaved VertexFormat::Vector2 positions and optional VertexFormat::Vector2 texture coordinates.

Trade::MeshData Magnum::Primitives::circle2DSolid(UnsignedInt segments, CircleTextureCoords textureCoords)

#include <Magnum/Primitives/Circle.h>

Solid 2D circle.

Trade::MeshData Magnum::Primitives::circle2DWireframe(UnsignedInt segments)

#include <Magnum/Primitives/Circle.h>

Wireframe 2D circle.

Circle with radius 1.0f, centered at origin. Non-indexed MeshPrimitive::LineLoop with VertexFormat::Vector2 positions.

Trade::MeshData Magnum::Primitives::circle3DSolid(UnsignedInt segments, Circle3DFlags flags = {}) new in 2020.06

#include <Magnum/Primitives/Circle.h>

Solid 3D circle.

Circle on the XY plane with radius 1.0f, centered at origin. Non-indexed MeshPrimitive::TriangleFan with interleaved VertexFormat::Vector3 positions, VertexFormat::Vector3 normals in positive Z direction, optional VertexFormat::Vector4 tangents and optional VertexFormat::Vector2 texture coordinates.

Trade::MeshData Magnum::Primitives::circle3DSolid(UnsignedInt segments, CircleTextureCoords textureCoords)

#include <Magnum/Primitives/Circle.h>

Solid 3D circle.

Trade::MeshData Magnum::Primitives::circle3DWireframe(UnsignedInt segments)

#include <Magnum/Primitives/Circle.h>

Wireframe 3D circle.

Circle on the XY plane with radius 1.0f, centered at origin. Non-indexed MeshPrimitive::LineLoop with VertexFormat::Vector2 positions.

Trade::MeshData Magnum::Primitives::coneSolid(UnsignedInt rings, UnsignedInt segments, Float halfLength, ConeFlags flags = {})

#include <Magnum/Primitives/Cone.h>

Solid 3D cone.

Cone of radius 1.0f along the Y axis, centered at origin. MeshPrimitive::Triangles with MeshIndexType::UnsignedInt indices, interleaved VertexFormat::Vector3 positions, VertexFormat::Vector3 normals, optional VertexFormat::Vector4 tangents and optional VertexFormat::Vector2 texture coordinates. Note that in order to have properly smooth normals over the whole area, the tip consists of segments*2 vertices instead of just one.

The cone is by default created with radius set to . In order to get radius , length and preserve correct normals, set halfLength to and then scale all positions by , for example using MeshTools::transform3D().

Trade::MeshData Magnum::Primitives::coneWireframe(UnsignedInt segments, Float halfLength)

#include <Magnum/Primitives/Cone.h>

Wireframe 3D cone.

Cone of radius 1.0f along the Y axis, centered at origin. MeshPrimitive::Lines with MeshIndexType::UnsignedInt indices and VertexFormat::Vector3 positions.

Trade::MeshData Magnum::Primitives::crosshair2D()

#include <Magnum/Primitives/Crosshair.h>

2D crosshair

2x2 crosshair (two crossed lines), centered at origin. Non-indexed MeshPrimitive::Lines with VertexFormat::Vector2 positions. The returned instance references Trade::DataFlag::Global data — pass the mesh through MeshTools::copy() to get a mutable copy, if needed.

Trade::MeshData Magnum::Primitives::crosshair3D()

#include <Magnum/Primitives/Crosshair.h>

3D crosshair

2x2x2 crosshair (three crossed lines), centered at origin. Non-indexed MeshPrimitive::Lines with VertexFormat::Vector3 positions. The returned instance references Trade::DataFlag::Global data — pass the mesh through MeshTools::copy() to get a mutable copy, if needed.

Trade::MeshData Magnum::Primitives::cubeSolid()

#include <Magnum/Primitives/Cube.h>

Solid 3D cube.

2x2x2 cube, centered at origin. MeshPrimitive::Triangles with MeshIndexType::UnsignedShort indices, interleaved VertexFormat::Vector3 positions and flat VertexFormat::Vector3 normals. The returned instance references Trade::DataFlag::Global data — pass the mesh through MeshTools::copy() to get a mutable copy, if needed.

Trade::MeshData Magnum::Primitives::cubeSolidStrip()

#include <Magnum/Primitives/Cube.h>

Solid 3D cube as a single strip.

2x2x2 cube, centered at origin. Non-indexed MeshPrimitive::TriangleStrip with VertexFormat::Vector3 positions. No normals or anything else, use cubeSolid() instead if you need these. The returned instance references Trade::DataFlag::Global data — pass the mesh through MeshTools::copy() to get a mutable copy, if needed.

Vertex positions of this mesh can be also generated directly in the vertex shader using gl_VertexID (source, adapted to exactly match the output of this function):

int b = 1 << gl_VertexID;
vec3 corner = vec3(mix(-1.0, 1.0, bool(0xd785 & b)),
                   mix(-1.0, 1.0, bool(0x31e3 & b)),
                   mix(-1.0, 1.0, bool(0x02af & b)));

Trade::MeshData Magnum::Primitives::cubeWireframe()

#include <Magnum/Primitives/Cube.h>

Wireframe 3D cube.

2x2x2 cube, centered at origin. MeshPrimitive::Lines with MeshIndexType::UnsignedShort indices and VertexFormat::Vector3 positions. The returned instance references Trade::DataFlag::Global data — pass the mesh through MeshTools::copy() to get a mutable copy, if needed.

Trade::MeshData Magnum::Primitives::cylinderSolid(UnsignedInt rings, UnsignedInt segments, Float halfLength, CylinderFlags flags = {})

#include <Magnum/Primitives/Cylinder.h>

Solid 3D cylinder.

Cylinder of radius 1.0f along the Y axis, centered at origin. MeshPrimitive::Triangles with MeshIndexType::UnsignedInt indices, interleaved VertexFormat::Vector3 positions, VertexFormat::Vector3 normals, optional VertexFormat::Vector4 tangents, optional VertexFormat::Vector2 texture coordinates and optional capped ends. If texture coordinates are generated, vertices of one segment are duplicated for texture wrapping.

The cylinder is by default created with radius set to . In order to get radius , length and preserve correct normals, set halfLength to and then scale all positions by , for example using MeshTools::transform3D().

Trade::MeshData Magnum::Primitives::cylinderWireframe(UnsignedInt rings, UnsignedInt segments, Float halfLength)

#include <Magnum/Primitives/Cylinder.h>

Wireframe 3D cylinder.

Cylinder of radius 1.0f along the Y axis, centerd at origin. MeshPrimitive::Lines with MeshIndexType::UnsignedInt indices and VertexFormat::Vector3 positions.

Trade::MeshData Magnum::Primitives::gradient2D(const Vector2& a, const Color4& colorA, const Vector2& b, const Color4& colorB)

#include <Magnum/Primitives/Gradient.h>

2D square with a gradient

2x2 square with vertex colors, centered at origin. Non-indexed MeshPrimitive::TriangleStrip with interleaved VertexFormat::Vector2 positions and VertexFormat::Vector4 colors. Vertex colors correspond to the gradient defined by the endpoints a and b, linearly interpolated from colorA to colorB.

Trade::MeshData Magnum::Primitives::gradient2DHorizontal(const Color4& colorLeft, const Color4& colorRight)

#include <Magnum/Primitives/Gradient.h>

2D square with a horizontal gradient

Equivalent to calling gradient2D() like this:

Primitives::gradient2D({-1.0f, 0.0f}, colorLeft, {1.0f, 0.0f}, colorRight);

Trade::MeshData Magnum::Primitives::gradient2DVertical(const Color4& colorBottom, const Color4& colorTop)

#include <Magnum/Primitives/Gradient.h>

2D square with a vertical gradient

Equivalent to calling gradient2D() like this:

Primitives::gradient2D({0.0f, -1.0f}, colorBottom, {0.0f, 1.0f}, colorTop);

Trade::MeshData Magnum::Primitives::gradient3D(const Vector3& a, const Color4& colorA, const Vector3& b, const Color4& colorB)

#include <Magnum/Primitives/Gradient.h>

3D plane with a gradient

2x2 square on the XY plane with vertex colors, centered at origin. Non-indexed MeshPrimitive::TriangleStrip with interleaved VertexFormat::Vector3 positions, VertexFormat::Vector3 normals in positive Z direction and VertexFormat::Vector4 colors. Vertex colors correspond to the gradient defined by the endpoints a and b, linearly interpolated from colorA to colorB.

Trade::MeshData Magnum::Primitives::gradient3DHorizontal(const Color4& colorLeft, const Color4& colorRight)

#include <Magnum/Primitives/Gradient.h>

3D plane with a horizontal gradient

Equivalent to calling gradient3D() like this:

Primitives::gradient3D({-1.0f, 0.0f, 0.0f}, colorLeft,
                       { 1.0f, 0.0f, 0.0f}, colorRight);

Trade::MeshData Magnum::Primitives::gradient3DVertical(const Color4& colorBottom, const Color4& colorTop)

#include <Magnum/Primitives/Gradient.h>

3D plane with a vertical gradient

Equivalent to calling gradient3D() like this:

Primitives::gradient3D({0.0f, -1.0f, 0.0f}, colorBottom,
                       {0.0f,  1.0f, 0.0f}, colorTop);

Trade::MeshData Magnum::Primitives::grid3DSolid(const Vector2i& subdivisions, GridFlags flags = GridFlag::Normals)

#include <Magnum/Primitives/Grid.h>

Solid 3D grid.

2x2 grid on the XY plane with normals in positive Z direction, centered at origin. MeshPrimitive::Triangles with MeshIndexType::UnsignedInt indices, interleaved VertexFormat::Vector3 positions, optional VertexFormat::Vector3 normals, optional VertexFormat::Vector4 tangents and optional VertexFormat::Vector2 texture coordinates.

The subdivisions parameter describes how many times the plane gets cut in each direction. Specifying {0, 0} will make the result an (indexed) equivalent to planeSolid(); {5, 3} will make the grid have 6 cells horizontally and 4 vertically. In particular, this is different from the subdivisions parameter in icosphereSolid().

Trade::MeshData Magnum::Primitives::grid3DWireframe(const Vector2i& subdivisions)

#include <Magnum/Primitives/Grid.h>

Wireframe 3D grid.

2x2 grid on the XY plane, centered at origin. MeshPrimitive::Lines with MeshIndexType::UnsignedInt indices and VertexFormat::Vector3 positions.

The subdivisions parameter describes how many times the plane gets cut in each direction. Specifying {0, 0} will make the result an (indexed) equivalent to planeWireframe(); {5, 3} will make the grid have 6 cells horizontally and 4 vertically. In particular, this is different from the subdivisions parameter in icosphereSolid(). Also please note the grid has vertices in each intersection to be suitable for deformation along the Z axis — not just long lines crossing each other.

Trade::MeshData Magnum::Primitives::icosphereSolid(UnsignedInt subdivisions)

#include <Magnum/Primitives/Icosphere.h>

Solid 3D icosphere.

Sphere of radius 1.0f, centered at origin. MeshPrimitive::Triangles with MeshIndexType::UnsignedInt indices, interleaved VertexFormat::Vector3 positions and VertexFormat::Vector3 normals.

The subdivisions parameter describes how many times is each icosphere triangle subdivided, recursively. Specifying 0 will result in an icosphere with 12 vertices and 20 faces, saying 1 will result in an icosphere with 80 faces (each triangle subdivided into four smaller), saying 2 will result in 320 faces and so on. In particular, this is different from the subdivisions parameter in grid3DSolid() or grid3DWireframe().

Trade::MeshData Magnum::Primitives::icosphereWireframe() new in 2020.06

#include <Magnum/Primitives/Icosphere.h>

Wireframe 3D icosphere.

Sphere of radius 1.0f with 12 vertices and 30 edges, centered at origin. MeshPrimitive::Lines with MeshIndexType::UnsignedShort indices and VertexFormat::Vector3 positions. The returned instance references data stored in constant memory.

Trade::MeshData Magnum::Primitives::line2D(const Vector2& a, const Vector2& b)

#include <Magnum/Primitives/Line.h>

2D line

Non-indexed MeshPrimitive::Lines with VertexFormat::Vector2 positions going from a to b.

Trade::MeshData Magnum::Primitives::line2D()

#include <Magnum/Primitives/Line.h>

2D line in an identity transformation

Equivalent to calling line2D(const Vector2&, const Vector2&) as

Primitives::line2D({0.0f, 0.0f}, {1.0f, 0.0f});

Trade::MeshData Magnum::Primitives::line3D(const Vector3& a, const Vector3& b)

#include <Magnum/Primitives/Line.h>

3D line

Non-indexed MeshPrimitive::Lines with VertexFormat::Vector3 positions going from a to b.

Trade::MeshData Magnum::Primitives::line3D()

#include <Magnum/Primitives/Line.h>

3D line in an identity transformation

Unit-size line in direction of positive X axis. Equivalent to calling line3D(const Vector3&, const Vector3&) as

Primitives::line3D({0.0f, 0.0f, 0.0f}, {1.0f, 0.0f, 0.0f});

Trade::MeshData Magnum::Primitives::planeSolid(PlaneFlags flags) new in 2020.06

#include <Magnum/Primitives/Plane.h>

Solid 3D plane.

2x2 square on the XY plane, centered at origin. Non-indexed MeshPrimitive::TriangleStrip with VertexFormat::Vector3 positions, VertexFormat::Vector3 normals in positive Z direction, optional VertexFormat::Vector4 tangents and optional VertexFormat::Vector2 texture coordinates. The returned instance may reference Trade::DataFlag::Global data — pass the mesh through MeshTools::copy() to get a mutable copy, if needed.

Trade::MeshData Magnum::Primitives::planeSolid()

#include <Magnum/Primitives/Plane.h>

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Trade::MeshData Magnum::Primitives::planeSolid(PlaneTextureCoords textureCoords)

#include <Magnum/Primitives/Plane.h>

Solid 3D plane.

Trade::MeshData Magnum::Primitives::planeWireframe()

#include <Magnum/Primitives/Plane.h>

Wireframe 3D plane.

2x2 square on the XY plane, centered at origin. Non-indexed MeshPrimitive::LineLoop on the XY plane with VertexFormat::Vector3 positions. The returned instance references Trade::DataFlag::Global data — pass the mesh through MeshTools::copy() to get a mutable copy, if needed.

Trade::MeshData Magnum::Primitives::squareSolid(SquareFlags flags = {}) new in 2020.06

#include <Magnum/Primitives/Square.h>

Solid 2D square.

2x2 square, centered at origin. Non-indexed MeshPrimitive::TriangleStrip with interleaved VertexFormat::Vector2 positions and optional VertexFormat::Vector2 texture coordinates. The returned instance references Trade::DataFlag::Global data — pass the mesh through MeshTools::copy() to get a mutable copy, if needed.

Trade::MeshData Magnum::Primitives::squareSolid(SquareTextureCoords textureCoords)

#include <Magnum/Primitives/Square.h>

Solid 3D plane.

Trade::MeshData Magnum::Primitives::squareWireframe()

#include <Magnum/Primitives/Square.h>

Wireframe 2D square.

2x2 square, centered at origin. Non-indexed MeshPrimitive::LineLoop with VertexFormat::Vector2 positions. The returned instance references Trade::DataFlag::Global data — pass the mesh through MeshTools::copy() to get a mutable copy, if needed.

Trade::MeshData Magnum::Primitives::uvSphereSolid(UnsignedInt rings, UnsignedInt segments, UVSphereFlags flags = {}) new in 2020.06

#include <Magnum/Primitives/UVSphere.h>

Solid 3D UV sphere.

Sphere of radius 1.0f, centered at origin. MeshPrimitive::Triangles with MeshIndexType::UnsignedInt indices, interleaved VertexFormat::Vector3 positions, VertexFormat::Vector3 normals, optional VertexFormat::Vector4 tangents and VertexFormat::Vector2 texture coordinates. If texture coordinates are generated, vertices of one segment are duplicated for texture wrapping.

Trade::MeshData Magnum::Primitives::uvSphereSolid(UnsignedInt rings, UnsignedInt segments, UVSphereTextureCoords textureCoords)

#include <Magnum/Primitives/UVSphere.h>

Solid 3D UV sphere.

Trade::MeshData Magnum::Primitives::uvSphereWireframe(UnsignedInt rings, UnsignedInt segments)

#include <Magnum/Primitives/UVSphere.h>

Wireframe 3D UV sphere.

Sphere of radius 1.0f, centered at origin. MeshPrimitive::Lines with MeshIndexType::UnsignedInt indices and VertexFormat::Vector3 positions.