vertex_format.hpp

Go to the documentation of this file.

/*
    RenderStack  Support library for OpenGL 3+
    Copyright (C) 2010  Timo Suoranta

    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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
*/

#ifndef VERTEX_FORMAT_HPP
#define VERTEX_FORMAT_HPP

#include "renderstack/rs.h"

#include <exception>
#include <vector>

namespace renderstack {

enum vertex_attribute_usage
{
    vertex_attribute_usage_none,
    vertex_attribute_usage_position,
    vertex_attribute_usage_normal,
    vertex_attribute_usage_tangent,
    vertex_attribute_usage_bitangent,
    vertex_attribute_usage_color,
    vertex_attribute_usage_weights,
    vertex_attribute_usage_matrix_indices,
    vertex_attribute_usage_texcoord,
    vertex_attribute_usage_id
};

class vertex_attribute_not_found_exception 
:   public std::exception
{
public:
    vertex_attribute_not_found_exception(
        vertex_attribute_usage  usage, 
        int                     index
    )
    :   m_usage(usage)
    ,   m_index(index)
    {
    }

    vertex_attribute_usage  usage(){ return m_usage; }
    int                     index(){ return m_index; }

private:
    vertex_attribute_usage  m_usage;
    int                     m_index;
};

class vertex_attribute
{
public:
    vertex_attribute(vertex_attribute_usage usage, int gl_type_code, int index, int dimension);

    vertex_attribute_usage  usage       () const;
    int                     gl_type_code() const;
    int                     index       () const;
    int                     dimension   () const;
    int                     offset      () const;

    void                    set_offset(int offset);

private:
    vertex_attribute_usage  m_usage;
    int                     m_gl_type_code;   /*  GL_FLOAT  */ 
    int                     m_index;          /*  texcoord0, texcoord1  */ 
    int                     m_dimension;      /*  normal is 3, texcoord typically 2  */ 
    int                     m_offset;
};


class vertex_format
{
public:
    vertex_format();
    ~vertex_format();

    void append(vertex_attribute &attribute);

    bool has_attribute(vertex_attribute_usage usage, int index = 0) const;
    vertex_attribute const &attribute(vertex_attribute_usage usage, int index = 0) const;

    int stride() const;

private:
    std::vector<vertex_attribute>   m_attributes;
    int                             m_stride;
};

int gl_size_of_type(int type_code);

}

#endif