• Creates a procedural cylinder-shaped mesh.

    The size, shape and tesselation properties of the cylinder can be controlled via function parameters. By default, the function will create a cylinder standing vertically centered on the XZ-plane with a radius of 0.5, a height of 1.0, 1 height segment and 20 cap segments.

    Note that the cylinder is created with UVs in the range of 0 to 1. Additionally, tangent information is generated into the vertex buffer of the cylinder's mesh.


    • device: GraphicsDevice

      The graphics device used to manage the mesh.

    • Optional opts: {
          calculateTangents: boolean;
          capSegments: number;
          height: number;
          heightSegments: number;
          radius: number;
      } = {}

      An object that specifies optional inputs for the function as follows:

      • calculateTangents: boolean

        Generate tangent information (defaults to false).

      • capSegments: number

        The number of divisions around the tubular body of the cylinder (defaults to 20).

      • height: number

        The length of the body of the cylinder (defaults to 1.0).

      • heightSegments: number

        The number of divisions along the length of the cylinder (defaults to 5).

      • radius: number

        The radius of the tube forming the body of the cylinder (defaults to 0.5).

    Returns Mesh

    A new cylinder-shaped mesh.