HardwareVertexBuffer.cs :  » Game » RealmForge » Axiom » Graphics » C# / CSharp Open Source

#region LGPL License
/*
Axiom Game Engine Library
Copyright (C) 2003  Axiom Project Team

The overall design, and a majority of the core engine and rendering code 
contained within this library is a derivative of the open source Object Oriented 
Graphics Engine OGRE, which can be found at http://ogre.sourceforge.net.  
Many thanks to the OGRE team for maintaining such a high quality project.

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
#endregion

using System;
using Axiom.MathLib;

namespace Axiom.Graphics{
    /// <summary>
    ///    Describes the graphics API independent functionality required by a hardware
    ///    vertex buffer.  
    /// </summary>
    /// <remarks>
    ///    
    /// </remarks>
    public abstract class HardwareVertexBuffer : HardwareBuffer {
        #region Member variables

        protected int numVertices;
        protected int vertexSize;

        #endregion

        #region Constructors
    
        public HardwareVertexBuffer(int vertexSize, int numVertices, BufferUsage usage, bool useSystemMemory, bool useShadowBuffer) 
            : base(usage, useSystemMemory, useShadowBuffer) {  
            this.vertexSize = vertexSize;
            this.numVertices = numVertices;

            // calculate the size in bytes of this buffer
            sizeInBytes = vertexSize * numVertices;

            // create a shadow buffer if required
            if(useShadowBuffer) {
                shadowBuffer = new SoftwareVertexBuffer(vertexSize, numVertices, BufferUsage.Dynamic);
            }
        }
    
        #endregion

        #region Properties

        /// <summary>
        /// 
        /// </summary>
        /// DOC
        public int VertexSize {
            get { return vertexSize; }
        }

        public int VertexCount {
            get { return numVertices; }
        }

        #endregion
    }
}