mirror of
https://github.com/brl/mutter.git
synced 2024-09-20 06:25:51 -04:00
0f5f4e8645
We've had complaints that our Cogl code/headers are a bit "special" so
this is a first pass at tidying things up by giving them some
consistency. These changes are all consistent with how new code in Cogl
is being written, but the style isn't consistently applied across all
code yet.
There are two parts to this patch; but since each one required a large
amount of effort to maintain tidy indenting it made sense to combine the
changes to reduce the time spent re indenting the same lines.
The first change is to use a consistent style for declaring function
prototypes in headers. Cogl headers now consistently use this style for
prototypes:
return_type
cogl_function_name (CoglType arg0,
CoglType arg1);
Not everyone likes this style, but it seems that most of the currently
active Cogl developers agree on it.
The second change is to constrain the use of redundant glib data types
in Cogl. Uses of gint, guint, gfloat, glong, gulong and gchar have all
been replaced with int, unsigned int, float, long, unsigned long and char
respectively. When talking about pixel data; use of guchar has been
replaced with guint8, otherwise unsigned char can be used.
The glib types that we continue to use for portability are gboolean,
gint{8,16,32,64}, guint{8,16,32,64} and gsize.
The general intention is that Cogl should look palatable to the widest
range of C programmers including those outside the Gnome community so
- especially for the public API - we want to minimize the number of
foreign looking typedefs.
170 lines
5.8 KiB
C
170 lines
5.8 KiB
C
/*
|
|
* Cogl
|
|
*
|
|
* An object oriented GL/GLES Abstraction/Utility Layer
|
|
*
|
|
* Copyright (C) 2008,2009 Intel Corporation.
|
|
*
|
|
* 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.
|
|
*
|
|
* Authors:
|
|
* Robert Bragg <robert@linux.intel.com>
|
|
*/
|
|
|
|
#ifndef __COGL_VERTEX_BUFFER_H
|
|
#define __COGL_VERTEX_BUFFER_H
|
|
|
|
#include "cogl-handle.h"
|
|
|
|
#include <glib.h>
|
|
|
|
/* Note we put quite a bit into the flags here to help keep
|
|
* the down size of the CoglVertexBufferAttrib struct below. */
|
|
typedef enum _CoglVertexBufferAttribFlags
|
|
{
|
|
/* Types */
|
|
/* NB: update the _TYPE_MASK below if these are changed */
|
|
COGL_VERTEX_BUFFER_ATTRIB_FLAG_COLOR_ARRAY = 1<<0,
|
|
COGL_VERTEX_BUFFER_ATTRIB_FLAG_NORMAL_ARRAY = 1<<1,
|
|
COGL_VERTEX_BUFFER_ATTRIB_FLAG_TEXTURE_COORD_ARRAY = 1<<2,
|
|
COGL_VERTEX_BUFFER_ATTRIB_FLAG_VERTEX_ARRAY = 1<<3,
|
|
COGL_VERTEX_BUFFER_ATTRIB_FLAG_CUSTOM_ARRAY = 1<<4,
|
|
COGL_VERTEX_BUFFER_ATTRIB_FLAG_INVALID = 1<<5,
|
|
|
|
COGL_VERTEX_BUFFER_ATTRIB_FLAG_NORMALIZED = 1<<6,
|
|
COGL_VERTEX_BUFFER_ATTRIB_FLAG_ENABLED = 1<<7,
|
|
|
|
/* Usage hints */
|
|
/* FIXME - flatten into one flag, since its used as a boolean */
|
|
COGL_VERTEX_BUFFER_ATTRIB_FLAG_INFREQUENT_RESUBMIT = 1<<8,
|
|
COGL_VERTEX_BUFFER_ATTRIB_FLAG_FREQUENT_RESUBMIT = 1<<9,
|
|
|
|
/* GL Data types */
|
|
/* NB: Update the _GL_TYPE_MASK below if these are changed */
|
|
COGL_VERTEX_BUFFER_ATTRIB_FLAG_GL_TYPE_BYTE = 1<<10,
|
|
COGL_VERTEX_BUFFER_ATTRIB_FLAG_GL_TYPE_UNSIGNED_BYTE = 1<<11,
|
|
COGL_VERTEX_BUFFER_ATTRIB_FLAG_GL_TYPE_SHORT = 1<<12,
|
|
COGL_VERTEX_BUFFER_ATTRIB_FLAG_GL_TYPE_UNSIGNED_SHORT = 1<<13,
|
|
COGL_VERTEX_BUFFER_ATTRIB_FLAG_GL_TYPE_INT = 1<<14,
|
|
COGL_VERTEX_BUFFER_ATTRIB_FLAG_GL_TYPE_UNSIGNED_INT = 1<<15,
|
|
COGL_VERTEX_BUFFER_ATTRIB_FLAG_GL_TYPE_FLOAT = 1<<16,
|
|
COGL_VERTEX_BUFFER_ATTRIB_FLAG_GL_TYPE_DOUBLE = 1<<17,
|
|
|
|
COGL_VERTEX_BUFFER_ATTRIB_FLAG_SUBMITTED = 1<<18,
|
|
COGL_VERTEX_BUFFER_ATTRIB_FLAG_UNUSED = 1<<19
|
|
|
|
/* XXX NB: If we need > 24 bits then look at changing the layout
|
|
* of struct _CoglVertexBufferAttrib below */
|
|
} CoglVertexBufferAttribFlags;
|
|
|
|
#define COGL_VERTEX_BUFFER_ATTRIB_FLAG_TYPE_MASK \
|
|
(COGL_VERTEX_BUFFER_ATTRIB_FLAG_COLOR_ARRAY \
|
|
| COGL_VERTEX_BUFFER_ATTRIB_FLAG_NORMAL_ARRAY \
|
|
| COGL_VERTEX_BUFFER_ATTRIB_FLAG_TEXTURE_COORD_ARRAY \
|
|
| COGL_VERTEX_BUFFER_ATTRIB_FLAG_VERTEX_ARRAY \
|
|
| COGL_VERTEX_BUFFER_ATTRIB_FLAG_CUSTOM_ARRAY \
|
|
| COGL_VERTEX_BUFFER_ATTRIB_FLAG_INVALID)
|
|
|
|
#define COGL_VERTEX_BUFFER_ATTRIB_FLAG_GL_TYPE_MASK \
|
|
(COGL_VERTEX_BUFFER_ATTRIB_FLAG_GL_TYPE_BYTE \
|
|
| COGL_VERTEX_BUFFER_ATTRIB_FLAG_GL_TYPE_UNSIGNED_BYTE \
|
|
| COGL_VERTEX_BUFFER_ATTRIB_FLAG_GL_TYPE_SHORT \
|
|
| COGL_VERTEX_BUFFER_ATTRIB_FLAG_GL_TYPE_UNSIGNED_SHORT \
|
|
| COGL_VERTEX_BUFFER_ATTRIB_FLAG_GL_TYPE_INT \
|
|
| COGL_VERTEX_BUFFER_ATTRIB_FLAG_GL_TYPE_UNSIGNED_INT \
|
|
| COGL_VERTEX_BUFFER_ATTRIB_FLAG_GL_TYPE_FLOAT \
|
|
| COGL_VERTEX_BUFFER_ATTRIB_FLAG_GL_TYPE_DOUBLE)
|
|
|
|
|
|
typedef struct _CoglVertexBufferAttrib
|
|
{
|
|
/* TODO: look at breaking up the flags into seperate
|
|
* bitfields and seperate enums */
|
|
CoglVertexBufferAttribFlags flags:24;
|
|
guint8 id;
|
|
GQuark name;
|
|
union _u
|
|
{
|
|
const void *pointer;
|
|
size_t vbo_offset;
|
|
} u;
|
|
size_t span_bytes;
|
|
guint16 stride;
|
|
guint8 n_components;
|
|
guint8 texture_unit;
|
|
|
|
} CoglVertexBufferAttrib;
|
|
|
|
typedef enum _CoglVertexBufferVBOFlags
|
|
{
|
|
COGL_VERTEX_BUFFER_VBO_FLAG_UNSTRIDED = 1<<0,
|
|
COGL_VERTEX_BUFFER_VBO_FLAG_STRIDED = 1<<1,
|
|
COGL_VERTEX_BUFFER_VBO_FLAG_MULTIPACK = 1<<2,
|
|
|
|
/* FIXME - flatten into one flag, since its used as a boolean */
|
|
COGL_VERTEX_BUFFER_VBO_FLAG_INFREQUENT_RESUBMIT = 1<<3,
|
|
COGL_VERTEX_BUFFER_VBO_FLAG_FREQUENT_RESUBMIT = 1<<4,
|
|
|
|
COGL_VERTEX_BUFFER_VBO_FLAG_SUBMITTED = 1<<5
|
|
} CoglVertexBufferVBOFlags;
|
|
|
|
/*
|
|
* A CoglVertexBufferVBO represents one or more attributes in a single
|
|
* buffer object
|
|
*/
|
|
typedef struct _CoglVertexBufferVBO
|
|
{
|
|
CoglVertexBufferVBOFlags flags;
|
|
|
|
/* Note: this is a pointer to handle fallbacks. It normally holds
|
|
* a GLuint VBO name, but when the driver doesn't support VBOs then
|
|
* this simply points to an malloc'd buffer. */
|
|
void *vbo_name; /*!< The name of the corresponding buffer object */
|
|
gsize vbo_bytes; /*!< The lengh of the allocated buffer object in bytes */
|
|
GList *attributes;
|
|
} CoglVertexBufferVBO;
|
|
|
|
typedef struct _CoglVertexBufferIndices
|
|
{
|
|
CoglHandleObject _parent;
|
|
|
|
/* Note: this is a pointer to handle fallbacks. It normally holds
|
|
* a GLuint VBO name, but when the driver doesn't support VBOs then
|
|
* this simply points to an malloc'd buffer. */
|
|
void *vbo_name;
|
|
GLenum type;
|
|
} CoglVertexBufferIndices;
|
|
|
|
typedef struct _CoglVertexBuffer
|
|
{
|
|
CoglHandleObject _parent;
|
|
|
|
int n_vertices; /*!< The number of vertices in the buffer */
|
|
GList *submitted_vbos; /* The VBOs currently submitted to the GPU */
|
|
|
|
/* Note: new_attributes is normally NULL and only valid while
|
|
* modifying a buffer. */
|
|
GList *new_attributes; /*!< attributes pending submission */
|
|
|
|
} CoglVertexBuffer;
|
|
|
|
CoglVertexBuffer *_cogl_vertex_buffer_pointer_from_handle (CoglHandle handle);
|
|
CoglVertexBufferIndices *
|
|
_cogl_vertex_buffer_indices_pointer_from_handle (CoglHandle handle);
|
|
|
|
#endif /* __COGL_VERTEX_BUFFER_H */
|
|
|