mutter/common/cogl-mesh-private.h

/*
 * Clutter COGL
 *
 * A basic GL/GLES Abstraction/Utility Layer
 *
 * Authored By Robert Bragg  <bob@o-hand.com>
 *
 * Copyright (C) 2008 Intel
 *
 * 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 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.
 */

#ifndef __COGL_MESH_H
#define __COGL_MESH_H

/* Note we put quite a bit into the flags here to help keep
 * the down size of the CoglMeshAttribute struct below. */
typedef enum _CoglMeshAttributeFlags
{
  /* Types */
  /* NB: update the _TYPE_MASK below if these are changed */
  COGL_MESH_ATTRIBUTE_FLAG_COLOR_ARRAY	  = 1<<0,
  COGL_MESH_ATTRIBUTE_FLAG_NORMAL_ARRAY	  = 1<<1,
  COGL_MESH_ATTRIBUTE_FLAG_TEXTURE_COORD_ARRAY = 1<<2,
  COGL_MESH_ATTRIBUTE_FLAG_VERTEX_ARRAY	  = 1<<3,
  COGL_MESH_ATTRIBUTE_FLAG_CUSTOM_ARRAY	  = 1<<4,
  COGL_MESH_ATTRIBUTE_FLAG_INVALID	  = 1<<5,

  COGL_MESH_ATTRIBUTE_FLAG_NORMALIZED	  = 1<<6,
  COGL_MESH_ATTRIBUTE_FLAG_ENABLED	  = 1<<7,
  
  /* Usage hints */
  /* FIXME - flatten into one flag, since its used as a boolean */
  COGL_MESH_ATTRIBUTE_FLAG_INFREQUENT_RESUBMIT	= 1<<8,
  COGL_MESH_ATTRIBUTE_FLAG_FREQUENT_RESUBMIT	= 1<<9,

  /* GL Data types */
  /* NB: Update the _GL_TYPE_MASK below if these are changed */
  COGL_MESH_ATTRIBUTE_FLAG_GL_TYPE_BYTE		  = 1<<10,
  COGL_MESH_ATTRIBUTE_FLAG_GL_TYPE_UNSIGNED_BYTE  = 1<<11,
  COGL_MESH_ATTRIBUTE_FLAG_GL_TYPE_SHORT	  = 1<<12,
  COGL_MESH_ATTRIBUTE_FLAG_GL_TYPE_UNSIGNED_SHORT = 1<<13,
  COGL_MESH_ATTRIBUTE_FLAG_GL_TYPE_INT		  = 1<<14,
  COGL_MESH_ATTRIBUTE_FLAG_GL_TYPE_UNSIGNED_INT	  = 1<<15,
  COGL_MESH_ATTRIBUTE_FLAG_GL_TYPE_FLOAT	  = 1<<16,
  COGL_MESH_ATTRIBUTE_FLAG_GL_TYPE_DOUBLE	  = 1<<17,

  COGL_MESH_ATTRIBUTE_FLAG_SUBMITTED		  = 1<<18,
  COGL_MESH_ATTRIBUTE_FLAG_UNUSED		  = 1<<19

  /* XXX NB: If we need > 24 bits then look at changing the layout
   * of struct _CoglMeshAttribute below */
} CoglMeshAttributeFlags;

#define COGL_MESH_ATTRIBUTE_FLAG_TYPE_MASK \
  (COGL_MESH_ATTRIBUTE_FLAG_COLOR_ARRAY \
   | COGL_MESH_ATTRIBUTE_FLAG_NORMAL_ARRAY \
   | COGL_MESH_ATTRIBUTE_FLAG_TEXTURE_COORD_ARRAY \
   | COGL_MESH_ATTRIBUTE_FLAG_VERTEX_ARRAY \
   | COGL_MESH_ATTRIBUTE_FLAG_CUSTOM_ARRAY \
   | COGL_MESH_ATTRIBUTE_FLAG_INVALID)

#define COGL_MESH_ATTRIBUTE_FLAG_GL_TYPE_MASK \
  (COGL_MESH_ATTRIBUTE_FLAG_GL_TYPE_BYTE \
   | COGL_MESH_ATTRIBUTE_FLAG_GL_TYPE_UNSIGNED_BYTE \
   | COGL_MESH_ATTRIBUTE_FLAG_GL_TYPE_SHORT \
   | COGL_MESH_ATTRIBUTE_FLAG_GL_TYPE_UNSIGNED_SHORT \
   | COGL_MESH_ATTRIBUTE_FLAG_GL_TYPE_INT \
   | COGL_MESH_ATTRIBUTE_FLAG_GL_TYPE_UNSIGNED_INT \
   | COGL_MESH_ATTRIBUTE_FLAG_GL_TYPE_FLOAT \
   | COGL_MESH_ATTRIBUTE_FLAG_GL_TYPE_DOUBLE)


typedef struct _CoglMeshAttribute
{
  /* TODO: look at breaking up the flags into seperate
   * bitfields and seperate enums */
  CoglMeshAttributeFlags   flags:24;
  guint8		   id;
  GQuark		   name;
  union _u
  {
    const void		  *pointer;
    gsize		   vbo_offset;
  } u;
  gsize			   span_bytes;
  guint16		   stride;
  guint8		   n_components;
  guint8		   texture_unit;
  
} CoglMeshAttribute;

typedef enum _CoglMeshVBOFlags
{
  COGL_MESH_VBO_FLAG_UNSTRIDED	= 1<<0,
  COGL_MESH_VBO_FLAG_STRIDED	= 1<<1,
  COGL_MESH_VBO_FLAG_MULTIPACK	= 1<<2,
  
  /* FIXME - flatten into one flag, since its used as a boolean */
  COGL_MESH_VBO_FLAG_INFREQUENT_RESUBMIT  = 1<<3,
  COGL_MESH_VBO_FLAG_FREQUENT_RESUBMIT	  = 1<<4,

  COGL_MESH_VBO_FLAG_SUBMITTED	= 1<<5
} CoglMeshVBOFlags;

/*
 * A CoglMeshVBO represents one or more attributes in a single buffer object
 */
typedef struct _CoglMeshVBO
{
  CoglMeshVBOFlags flags;
  GLuint vbo_name; /*!< The name of the corresponding buffer object */
  gsize	 vbo_bytes; /*!< The lengh of the allocated buffer object in bytes */
  GList *attributes;
} CoglMeshVBO;


typedef struct _CoglMesh
{
  guint  ref_count;
  guint  n_vertices; /*!< The number of vertices in the mesh */
  GList *submitted_vbos; /* The VBOs currently submitted to the GPU */

  /* Note: new_attributes is normally NULL and only valid while
   * modifying a mesh object. */
  GList *new_attributes; /*!< attributes pending submission */
} CoglMesh;

#endif /* __COGL_MESH_H */