mutter/cogl/cogl-indices.h

147 lines
4.8 KiB
C
Raw Normal View History

/*
* 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:
* Robert Bragg <robert@linux.intel.com>
*/
#if !defined(__COGL_H_INSIDE__) && !defined(CLUTTER_COMPILATION)
#error "Only <cogl/cogl.h> can be included directly."
#endif
#ifndef __COGL_INDICES_H__
#define __COGL_INDICES_H__
/* We forward declare the CoglIndices type here to avoid some circular
* dependency issues with the following headers.
*/
typedef struct _CoglIndices CoglIndices;
#include <cogl/cogl-index-buffer.h>
G_BEGIN_DECLS
/**
* SECTION:cogl-index-range
* @short_description: Fuctions for declaring a range of vertex indices
* stored in a #CoglIndexBuffer.
*
* Indices allow you to avoid duplicating vertices in your vertex data
* by virtualizing your data and instead providing a sequence of index
* values that tell the GPU which data should be used for each vertex.
*
* If the GPU is given a squence of indices it doesn't simply walk
* through each vertex of your data in order it will instead walk
* through the indices which can provide random access to the
* underlying data.
*
* Since it's very common to have duplicate vertices when describing a
* shape as a list of triangles it can often be a significant space
* saving to describe geometry using indices. Reducing the size of
* your models can make it cheaper to map them into the GPU by
* reducing the demand on memory bandwidth and may help to make better
* use of your GPUs internal vertex caching.
*
* For example, to describe a quadrilateral as 2 triangles for the GPU
* you could either provide data with 6 vertices or instead with
* indices you can provide vertex data for just 4 vertices and an
* index buffer that specfies the 6 vertices by indexing the shared
* vertices multiple times.
*
* |[
* CoglVertex2f quad_vertices[] = {
* {x0, y0}, //0 = top left
* {x1, y1}, //1 = bottom left
* {x2, y2}, //2 = bottom right
* {x3, y3}, //3 = top right
* };
* //tell the gpu how to interpret the quad as 2 triangles...
* unsigned char indices[] = {0, 1, 2, 0, 2, 3};
* ]|
*
* Even in the above illustration we see a saving of 10bytes for one
* quad compared to having data for 6 vertices and no indices but if
* you need to draw 100s or 1000s of quads then its really quite
* significant.
*
* Something else to consider is that often indices can be defined
* once and remain static while the vertex data may change for
* animations perhaps. That means you may be able to ignore the
* negligable cost of mapping your indices into the GPU if they don't
* ever change.
*
* The above illustration is actually a good example of static indices
* because it's really common that developers have quad mesh data that
* they need to display and we know exactly what that indices array
* needs to look like depending on the number of quads that need to be
* drawn. It doesn't matter how the quads might be animated and
* changed the indices will remain the same. Cogl even has a utility
* (cogl_get_rectangle_indices()) to get access to re-useable indices
* for drawing quads as above.
*/
CoglIndices *
cogl_indices_new (CoglContext *context,
CoglIndicesType type,
const void *indices_data,
int n_indices);
CoglIndices *
cogl_indices_new_for_buffer (CoglIndicesType type,
CoglIndexBuffer *buffer,
gsize offset);
CoglIndexBuffer *
cogl_indices_get_buffer (CoglIndices *indices);
CoglIndicesType
cogl_indices_get_type (CoglIndices *indices);
gsize
cogl_indices_get_offset (CoglIndices *indices);
void
cogl_indices_set_offset (CoglIndices *indices,
gsize offset);
CoglIndices *
cogl_get_rectangle_indices (CoglContext *context, int n_rectangles);
Add -Wmissing-declarations to maintainer flags and fix problems This option to GCC makes it give a warning whenever a global function is defined without a declaration. This should catch cases were we've defined a function but forgot to put it in a header. In that case it is either only used within one file so we should make it static or we should declare it in a header. The following changes where made to fix problems: • Some functions were made static • cogl-path.h (the one containing the 1.0 API) was split into two files, one defining the functions and one defining the enums so that cogl-path.c can include the enum and function declarations from the 2.0 API as well as the function declarations from the 1.0 API. • cogl2-clip-state has been removed. This only had one experimental function called cogl_clip_push_from_path but as this is unstable we might as well remove it favour of the equivalent cogl_framebuffer_* API. • The GLX, SDL and WGL winsys's now have a private header to define their get_vtable function instead of directly declaring in the C file where it is called. • All places that were calling COGL_OBJECT_DEFINE need to have the cogl_is_whatever function declared so these have been added either as a public function or in a private header. • Some files that were not including the header containing their function declarations have been fixed to do so. • Any unused error quark functions have been removed. If we later want them we should add them back one by one and add a declaration for them in a header. • _cogl_is_framebuffer has been renamed to cogl_is_framebuffer and made a public function with a declaration in cogl-framebuffer.h • Similarly for CoglOnscreen. • cogl_vdraw_indexed_attributes is called cogl_framebuffer_vdraw_indexed_attributes in the header. The definition has been changed to match the header. • cogl_index_buffer_allocate has been removed. This had no declaration and I'm not sure what it's supposed to do. • CoglJournal has been changed to use the internal CoglObject macro so that it won't define an exported cogl_is_journal symbol. • The _cogl_blah_pointer_from_handle functions have been removed. CoglHandle isn't used much anymore anyway and in the few places where it is used I think it's safe to just use the implicit cast from void* to the right type. • The test-utils.h header for the conformance tests explicitly disables the -Wmissing-declaration option using a pragma because all of the tests declare their main function without a header. Any mistakes relating to missing declarations aren't really important for the tests. • cogl_quaternion_init_from_quaternion and init_from_matrix have been given declarations in cogl-quaternion.h Reviewed-by: Robert Bragg <robert@linux.intel.com>
2012-03-06 13:21:28 -05:00
/**
* cogl_is_indices:
* @object: A #CoglObject pointer
*
* Gets whether the given object references a #CoglIndices.
*
* Return value: %TRUE if the object references a #CoglIndices
* and %FALSE otherwise.
* Since: 1.10
* Stability: unstable
*/
gboolean
cogl_is_indices (void *object);
G_END_DECLS
#endif /* __COGL_INDICES_H__ */