f80cb197a9
This applies an API naming change that's been deliberated over for a
while now which is to rename CoglMaterial to CoglPipeline.
For now the new pipeline API is marked as experimental and public
headers continue to talk about materials not pipelines. The CoglMaterial
API is now maintained in terms of the cogl_pipeline API internally.
Currently this API is targeting Cogl 2.0 so we will have time to
integrate it properly with other upcoming Cogl 2.0 work.
The basic reasons for the rename are:
- That the term "material" implies to many people that they are
constrained to fragment processing; perhaps as some kind of high-level
texture abstraction.
- In Clutter they get exposed by ClutterTexture actors which may be
re-inforcing this misconception.
- When comparing how other frameworks use the term material, a material
sometimes describes a multi-pass fragment processing technique which
isn't the case in Cogl.
- In code, "CoglPipeline" will hopefully be a much more self documenting
summary of what these objects represent; a full GPU pipeline
configuration including, for example, vertex processing, fragment
processing and blending.
- When considering the API documentation story, at some point we need a
document introducing developers to how the "GPU pipeline" works so it
should become intuitive that CoglPipeline maps back to that
description of the GPU pipeline.
- This is consistent in terminology and concept to OpenGL 4's new
pipeline object which is a container for program objects.
Note: The cogl-material.[ch] files have been renamed to
cogl-material-compat.[ch] because otherwise git doesn't seem to treat
the change as a moving the old cogl-material.c->cogl-pipeline.c and so
we loose all our git-blame history.
150 lines
4.3 KiB
C
150 lines
4.3 KiB
C
/*
|
|
* Cogl
|
|
*
|
|
* An object oriented GL/GLES Abstraction/Utility Layer
|
|
*
|
|
* Copyright (C) 2010 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, see <http://www.gnu.org/licenses/>.
|
|
*
|
|
*
|
|
*
|
|
* Authors:
|
|
* Damien Lespiau <damien.lespiau@intel.com>
|
|
* Robert Bragg <robert@linux.intel.com>
|
|
*/
|
|
|
|
#ifndef __COGL_BUFFER_PRIVATE_H__
|
|
#define __COGL_BUFFER_PRIVATE_H__
|
|
|
|
#include <glib.h>
|
|
|
|
#include "cogl.h"
|
|
#include "cogl-object-private.h"
|
|
#include "cogl-buffer.h"
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
#define COGL_BUFFER(buffer) ((CoglBuffer *)(buffer))
|
|
|
|
typedef struct _CoglBufferVtable CoglBufferVtable;
|
|
|
|
struct _CoglBufferVtable
|
|
{
|
|
guint8 * (* map) (CoglBuffer *buffer,
|
|
CoglBufferAccess access,
|
|
CoglBufferMapHint hints);
|
|
|
|
void (* unmap) (CoglBuffer *buffer);
|
|
|
|
gboolean (* set_data) (CoglBuffer *buffer,
|
|
unsigned int offset,
|
|
const guint8 *data,
|
|
unsigned int size);
|
|
};
|
|
|
|
typedef enum _CoglBufferFlags
|
|
{
|
|
COGL_BUFFER_FLAG_NONE = 0,
|
|
COGL_BUFFER_FLAG_BUFFER_OBJECT = 1UL << 0, /* real openGL buffer object */
|
|
COGL_BUFFER_FLAG_MAPPED = 1UL << 1
|
|
} CoglBufferFlags;
|
|
|
|
typedef enum {
|
|
COGL_BUFFER_USAGE_HINT_TEXTURE,
|
|
COGL_BUFFER_USAGE_HINT_VERTEX_ARRAY,
|
|
COGL_BUFFER_USAGE_HINT_INDEX_ARRAY
|
|
} CoglBufferUsageHint;
|
|
|
|
typedef enum {
|
|
COGL_BUFFER_BIND_TARGET_PIXEL_PACK,
|
|
COGL_BUFFER_BIND_TARGET_PIXEL_UNPACK,
|
|
COGL_BUFFER_BIND_TARGET_VERTEX_ARRAY,
|
|
COGL_BUFFER_BIND_TARGET_INDEX_ARRAY,
|
|
|
|
COGL_BUFFER_BIND_TARGET_COUNT
|
|
} CoglBufferBindTarget;
|
|
|
|
struct _CoglBuffer
|
|
{
|
|
CoglObject _parent;
|
|
CoglBufferVtable vtable;
|
|
|
|
CoglBufferBindTarget last_target;
|
|
|
|
CoglBufferFlags flags;
|
|
|
|
GLuint gl_handle; /* OpenGL handle */
|
|
unsigned int size; /* size of the buffer, in bytes */
|
|
CoglBufferUsageHint usage_hint;
|
|
CoglBufferUpdateHint update_hint;
|
|
|
|
guint8 *data; /* points to the mapped memory when
|
|
* the CoglBuffer is a VBO, PBO, ... or
|
|
* points to allocated memory in the
|
|
* fallback paths */
|
|
|
|
int immutable_ref;
|
|
|
|
guint store_created:1;
|
|
};
|
|
|
|
/* This is used to register a type to the list of handle types that
|
|
will be considered a texture in cogl_is_texture() */
|
|
void
|
|
_cogl_buffer_register_buffer_type (GQuark type);
|
|
|
|
#define COGL_BUFFER_DEFINE(TypeName, type_name) \
|
|
COGL_OBJECT_DEFINE_WITH_CODE \
|
|
(TypeName, type_name, \
|
|
_cogl_buffer_register_buffer_type (_cogl_object_ \
|
|
## type_name ## _get_type ()))
|
|
|
|
void
|
|
_cogl_buffer_initialize (CoglBuffer *buffer,
|
|
unsigned int size,
|
|
gboolean use_malloc,
|
|
CoglBufferBindTarget default_target,
|
|
CoglBufferUsageHint usage_hint,
|
|
CoglBufferUpdateHint update_hint);
|
|
|
|
void
|
|
_cogl_buffer_fini (CoglBuffer *buffer);
|
|
|
|
void *
|
|
_cogl_buffer_bind (CoglBuffer *buffer,
|
|
CoglBufferBindTarget target);
|
|
|
|
void
|
|
_cogl_buffer_unbind (CoglBuffer *buffer);
|
|
|
|
CoglBufferUsageHint
|
|
_cogl_buffer_get_usage_hint (CoglBuffer *buffer);
|
|
|
|
GLenum
|
|
_cogl_buffer_access_to_gl_enum (CoglBufferAccess access);
|
|
|
|
GLenum
|
|
_cogl_buffer_hints_to_gl_enum (CoglBufferUsageHint usage_hint,
|
|
CoglBufferUpdateHint update_hint);
|
|
|
|
CoglBuffer *
|
|
_cogl_buffer_immutable_ref (CoglBuffer *buffer);
|
|
|
|
void
|
|
_cogl_buffer_immutable_unref (CoglBuffer *buffer);
|
|
|
|
G_END_DECLS
|
|
|
|
#endif /* __COGL_BUFFER_PRIVATE_H__ */
|