Browse Source

Primitives: hint on MeshTools for converting into indexed meshes.

pull/430/head
Vladimír Vondruš 6 years ago
parent
commit
dedf36941c
  1. 12
      src/Magnum/Primitives/Circle.h
  2. 2
      src/Magnum/Primitives/Cube.h
  3. 4
      src/Magnum/Primitives/Gradient.h
  4. 6
      src/Magnum/Primitives/Plane.h
  5. 6
      src/Magnum/Primitives/Square.h

12
src/Magnum/Primitives/Circle.h

@ -57,7 +57,8 @@ positions and optional @ref VertexFormat::Vector2 texture coordinates.
@image html primitives-circle2dsolid.png width=256px @image html primitives-circle2dsolid.png width=256px
@see @ref circle2DWireframe(), @ref circle3DSolid() @see @ref circle2DWireframe(), @ref circle3DSolid(),
@ref MeshTools::generateTriangleFanIndices()
*/ */
MAGNUM_PRIMITIVES_EXPORT Trade::MeshData circle2DSolid(UnsignedInt segments, CircleTextureCoords textureCoords = CircleTextureCoords::DontGenerate); MAGNUM_PRIMITIVES_EXPORT Trade::MeshData circle2DSolid(UnsignedInt segments, CircleTextureCoords textureCoords = CircleTextureCoords::DontGenerate);
@ -71,7 +72,8 @@ Circle with radius @cpp 1.0f @ce. Non-indexed @ref MeshPrimitive::LineLoop with
@image html primitives-circle2dwireframe.png width=256px @image html primitives-circle2dwireframe.png width=256px
@see @ref circle2DSolid(), @ref circle3DWireframe() @see @ref circle2DSolid(), @ref circle3DWireframe(),
@ref MeshTools::generateLineLoopIndices()
*/ */
MAGNUM_PRIMITIVES_EXPORT Trade::MeshData circle2DWireframe(UnsignedInt segments); MAGNUM_PRIMITIVES_EXPORT Trade::MeshData circle2DWireframe(UnsignedInt segments);
@ -88,7 +90,8 @@ optional @ref VertexFormat::Vector2 texture coordinates.
@image html primitives-circle3dsolid.png width=256px @image html primitives-circle3dsolid.png width=256px
@see @ref circle3DWireframe(), @ref circle2DSolid() @see @ref circle3DWireframe(), @ref circle2DSolid(),
@ref MeshTools::generateTriangleFanIndices()
*/ */
MAGNUM_PRIMITIVES_EXPORT Trade::MeshData circle3DSolid(UnsignedInt segments, CircleTextureCoords textureCoords = CircleTextureCoords::DontGenerate); MAGNUM_PRIMITIVES_EXPORT Trade::MeshData circle3DSolid(UnsignedInt segments, CircleTextureCoords textureCoords = CircleTextureCoords::DontGenerate);
@ -100,7 +103,8 @@ Circle on the XY plane with radius @cpp 1.0f @ce. Non-indexed @ref MeshPrimitive
@image html primitives-circle3dwireframe.png width=256px @image html primitives-circle3dwireframe.png width=256px
@see @ref circle2DSolid(), @ref circle3DWireframe() @see @ref circle2DSolid(), @ref circle3DWireframe(),
@ref MeshTools::generateLineLoopIndices()
*/ */
MAGNUM_PRIMITIVES_EXPORT Trade::MeshData circle3DWireframe(UnsignedInt segments); MAGNUM_PRIMITIVES_EXPORT Trade::MeshData circle3DWireframe(UnsignedInt segments);

2
src/Magnum/Primitives/Cube.h

@ -57,7 +57,7 @@ normals or anything else --- use @ref cubeSolid() instead if you need these.
@image html primitives-cubesolid.png width=256px @image html primitives-cubesolid.png width=256px
@see @ref cubeWireframe() @see @ref cubeWireframe(), @ref MeshTools::generateTriangleStripIndices()
*/ */
MAGNUM_PRIMITIVES_EXPORT Trade::MeshData cubeSolidStrip(); MAGNUM_PRIMITIVES_EXPORT Trade::MeshData cubeSolidStrip();

4
src/Magnum/Primitives/Gradient.h

@ -47,7 +47,7 @@ defined by the endpoints @p a and @p b, linearly interpolated from @p colorA to
@image html primitives-gradient2d.png width=256px @image html primitives-gradient2d.png width=256px
@see @ref gradient2DHorizontal(), @ref gradient2DVertical(), @ref gradient3D(), @see @ref gradient2DHorizontal(), @ref gradient2DVertical(), @ref gradient3D(),
@ref squareSolid() @ref squareSolid(), @ref MeshTools::generateTriangleStripIndices()
*/ */
MAGNUM_PRIMITIVES_EXPORT Trade::MeshData gradient2D(const Vector2& a, const Color4& colorA, const Vector2& b, const Color4& colorB); MAGNUM_PRIMITIVES_EXPORT Trade::MeshData gradient2D(const Vector2& a, const Color4& colorA, const Vector2& b, const Color4& colorB);
@ -90,7 +90,7 @@ defined by the endpoints @p a and @p b, linearly interpolated from @p colorA to
@image html primitives-gradient3d.png width=256px @image html primitives-gradient3d.png width=256px
@see @ref gradient3DHorizontal(), @ref gradient3DVertical(), @ref gradient2D(), @see @ref gradient3DHorizontal(), @ref gradient3DVertical(), @ref gradient2D(),
@ref planeSolid() @ref planeSolid(), @ref MeshTools::generateTriangleStripIndices()
*/ */
MAGNUM_PRIMITIVES_EXPORT Trade::MeshData gradient3D(const Vector3& a, const Color4& colorA, const Vector3& b, const Color4& colorB); MAGNUM_PRIMITIVES_EXPORT Trade::MeshData gradient3D(const Vector3& a, const Color4& colorA, const Vector3& b, const Color4& colorB);

6
src/Magnum/Primitives/Plane.h

@ -56,7 +56,8 @@ memory.
@image html primitives-planesolid.png width=256px @image html primitives-planesolid.png width=256px
@see @ref planeWireframe(), @ref squareSolid(), @ref gradient3D() @see @ref planeWireframe(), @ref squareSolid(), @ref gradient3D(),
@ref MeshTools::generateTriangleStripIndices()
*/ */
MAGNUM_PRIMITIVES_EXPORT Trade::MeshData planeSolid(PlaneTextureCoords textureCoords = PlaneTextureCoords::DontGenerate); MAGNUM_PRIMITIVES_EXPORT Trade::MeshData planeSolid(PlaneTextureCoords textureCoords = PlaneTextureCoords::DontGenerate);
@ -69,7 +70,8 @@ stored in constant memory.
@image html primitives-planewireframe.png width=256px @image html primitives-planewireframe.png width=256px
@see @ref planeSolid(), @ref squareWireframe() @see @ref planeSolid(), @ref squareWireframe(),
@ref MeshTools::generateLineLoopIndices()
*/ */
MAGNUM_PRIMITIVES_EXPORT Trade::MeshData planeWireframe(); MAGNUM_PRIMITIVES_EXPORT Trade::MeshData planeWireframe();

6
src/Magnum/Primitives/Square.h

@ -56,7 +56,8 @@ memory.
@image html primitives-squaresolid.png width=256px @image html primitives-squaresolid.png width=256px
@see @ref squareWireframe(), @ref planeSolid(), @ref gradient2D() @see @ref squareWireframe(), @ref planeSolid(), @ref gradient2D(),
@ref MeshTools::generateTriangleStripIndices()
*/ */
MAGNUM_PRIMITIVES_EXPORT Trade::MeshData squareSolid(SquareTextureCoords textureCoords = SquareTextureCoords::DontGenerate); MAGNUM_PRIMITIVES_EXPORT Trade::MeshData squareSolid(SquareTextureCoords textureCoords = SquareTextureCoords::DontGenerate);
@ -69,7 +70,8 @@ stored in constant memory.
@image html primitives-squarewireframe.png width=256px @image html primitives-squarewireframe.png width=256px
@see @ref squareSolid(), @ref planeWireframe() @see @ref squareSolid(), @ref planeWireframe(),
@ref MeshTools::generateLineLoopIndices()
*/ */
MAGNUM_PRIMITIVES_EXPORT Trade::MeshData squareWireframe(); MAGNUM_PRIMITIVES_EXPORT Trade::MeshData squareWireframe();

Loading…
Cancel
Save