VertexBuffer.hpp

//
// SFML - Simple and Fast Multimedia Library
// Copyright (C) 2007-2018 Laurent Gomila (laurent@sfml-dev.org)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
//    you must not claim that you wrote the original software.
//    If you use this software in a product, an acknowledgment
//    in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
//    and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//
 
#ifndef SFML_VERTEXBUFFER_HPP
#define SFML_VERTEXBUFFER_HPP
 
// Headers
#include <SFML/Graphics/Export.hpp>
#include <SFML/Graphics/PrimitiveType.hpp>
#include <SFML/Graphics/Drawable.hpp>
#include <SFML/Window/GlResource.hpp>
 
 
namespace sf
{
class RenderTarget;
class Vertex;
 
class SFML_GRAPHICS_API VertexBuffer : public Drawable, private GlResource
{
public:
 
    enum Usage
    {
        Stream,  
        Dynamic, 
        Static   
    };
 
    VertexBuffer();
 
    explicit VertexBuffer(PrimitiveType type);
 
    explicit VertexBuffer(Usage usage);
 
    VertexBuffer(PrimitiveType type, Usage usage);
 
    VertexBuffer(const VertexBuffer& copy);
 
    ~VertexBuffer();
 
    bool create(std::size_t vertexCount);
 
    std::size_t getVertexCount() const;
 
    bool update(const Vertex* vertices);
 
    bool update(const Vertex* vertices, std::size_t vertexCount, unsigned int offset);
 
    bool update(const VertexBuffer& vertexBuffer);
 
    VertexBuffer& operator =(const VertexBuffer& right);
 
    void swap(VertexBuffer& right);
 
    unsigned int getNativeHandle() const;
 
    void setPrimitiveType(PrimitiveType type);
 
    PrimitiveType getPrimitiveType() const;
 
    void setUsage(Usage usage);
 
    Usage getUsage() const;
 
    static void bind(const VertexBuffer* vertexBuffer);
 
    static bool isAvailable();
 
private:
 
    virtual void draw(RenderTarget& target, RenderStates states) const;
 
private:
 
    // Member data
    unsigned int  m_buffer;        
    std::size_t   m_size;          
    PrimitiveType m_primitiveType; 
    Usage         m_usage;         
};
 
} // namespace sf
 
 
#endif // SFML_VERTEXBUFFER_HPP