PrimitiveType.cs

Go to the documentation of this file.

// Copyright (c) 2014 Silicon Studio Corp. (http://siliconstudio.co.jp)
// This file is distributed under GPL v3. See LICENSE.md for details.
using System;
using SiliconStudio.Core;

namespace SiliconStudio.Paradox.Graphics
{
    /// <summary>
    /// Defines how vertex data is ordered.
    /// </summary>
    [DataContract]
    public enum PrimitiveType
    {
        /// <summary>   
        /// No documentation.   
        /// </summary>  
        Undefined = unchecked((int)0),

        /// <summary>   
        /// No documentation.   
        /// </summary>  
        PointList = unchecked((int)1),

        /// <summary>   
        /// The data is ordered as a sequence of line segments; each line segment is described by two new vertices. The count may be any positive integer.
        /// </summary>  
        LineList = unchecked((int)2),

        /// <summary>   
        /// The data is ordered as a sequence of line segments; each line segment is described by one new vertex and the last vertex from the previous line seqment. The count may be any positive integer.
        /// </summary>  
        LineStrip = unchecked((int)3),

        /// <summary>   
        /// The data is ordered as a sequence of triangles; each triangle is described by three new vertices. Back-face culling is affected by the current winding-order render state.
        /// </summary>  
        TriangleList = unchecked((int)4),

        /// <summary>   
        /// The data is ordered as a sequence of triangles; each triangle is described by two new vertices and one vertex from the previous triangle. The back-face culling flag is flipped automatically on even-numbered
        /// </summary>  
        TriangleStrip = unchecked((int)5),

        /// <summary>   
        /// No documentation.   
        /// </summary>  
        LineListWithAdjacency = unchecked((int)10),

        /// <summary>   
        /// No documentation.   
        /// </summary>  
        LineStripWithAdjacency = unchecked((int)11),

        /// <summary>   
        /// No documentation.   
        /// </summary>  
        TriangleListWithAdjacency = unchecked((int)12),

        /// <summary>   
        /// No documentation.   
        /// </summary>  
        TriangleStripWithAdjacency = unchecked((int)13),

        PatchList = unchecked((int)33),
    }

    public static class PrimitiveTypeExtensions
    {
        /// <summary>   
        /// Interpret the vertex data as a patch list.
        /// </summary>  
        /// <param name="controlPoints">Number of control points. Value must be in the range 1 to 32.</param>
        public static PrimitiveType ControlPointCount(this PrimitiveType primitiveType, int controlPoints)
        {
            if (primitiveType != PrimitiveType.PatchList)
                throw new ArgumentException("Control points apply only to PrimitiveType.PatchList", "primitiveType");

            if (controlPoints < 1 || controlPoints > 32)
                throw new ArgumentException("Value must be in between 1 and 32", "controlPoints");

            return PrimitiveType.PatchList + controlPoints - 1;
        }
    }
}