2012-03-22 16:32:56 +00:00
|
|
|
/*
|
|
|
|
* Cogl
|
|
|
|
*
|
|
|
|
* An object oriented GL/GLES Abstraction/Utility Layer
|
|
|
|
*
|
|
|
|
* Copyright (C) 2012 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/>.
|
|
|
|
*
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef __COGL_DRIVER_H
|
|
|
|
#define __COGL_DRIVER_H
|
|
|
|
|
|
|
|
#include "cogl-context.h"
|
2012-08-31 23:04:00 +00:00
|
|
|
#include "cogl-offscreen.h"
|
|
|
|
#include "cogl-framebuffer-private.h"
|
2012-09-19 19:04:24 +00:00
|
|
|
#include "cogl-attribute-private.h"
|
2012-03-22 16:32:56 +00:00
|
|
|
|
|
|
|
typedef struct _CoglDriverVtable CoglDriverVtable;
|
|
|
|
|
|
|
|
struct _CoglDriverVtable
|
|
|
|
{
|
2012-09-10 20:45:33 +00:00
|
|
|
/* TODO: factor this out since this is OpenGL specific and
|
|
|
|
* so can be ignored by non-OpenGL drivers. */
|
Switch use of primitive glib types to c99 equivalents
The coding style has for a long time said to avoid using redundant glib
data types such as gint or gchar etc because we feel that they make the
code look unnecessarily foreign to developers coming from outside of the
Gnome developer community.
Note: When we tried to find the historical rationale for the types we
just found that they were apparently only added for consistent syntax
highlighting which didn't seem that compelling.
Up until now we have been continuing to use some of the platform
specific type such as gint{8,16,32,64} and gsize but this patch switches
us over to using the standard c99 equivalents instead so we can further
ensure that our code looks familiar to the widest range of C developers
who might potentially contribute to Cogl.
So instead of using the gint{8,16,32,64} and guint{8,16,32,64} types this
switches all Cogl code to instead use the int{8,16,32,64}_t and
uint{8,16,32,64}_t c99 types instead.
Instead of gsize we now use size_t
For now we are not going to use the c99 _Bool type and instead we have
introduced a new CoglBool type to use instead of gboolean.
Reviewed-by: Neil Roberts <neil@linux.intel.com>
(cherry picked from commit 5967dad2400d32ca6319cef6cb572e81bf2c15f0)
2012-04-16 20:56:40 +00:00
|
|
|
CoglBool
|
2012-03-22 16:32:56 +00:00
|
|
|
(* pixel_format_from_gl_internal) (CoglContext *context,
|
|
|
|
GLenum gl_int_format,
|
|
|
|
CoglPixelFormat *out_format);
|
|
|
|
|
2012-09-10 20:45:33 +00:00
|
|
|
/* TODO: factor this out since this is OpenGL specific and
|
|
|
|
* so can be ignored by non-OpenGL drivers. */
|
2012-03-22 16:32:56 +00:00
|
|
|
CoglPixelFormat
|
|
|
|
(* pixel_format_to_gl) (CoglContext *context,
|
|
|
|
CoglPixelFormat format,
|
|
|
|
GLenum *out_glintformat,
|
|
|
|
GLenum *out_glformat,
|
|
|
|
GLenum *out_gltype);
|
|
|
|
|
Switch use of primitive glib types to c99 equivalents
The coding style has for a long time said to avoid using redundant glib
data types such as gint or gchar etc because we feel that they make the
code look unnecessarily foreign to developers coming from outside of the
Gnome developer community.
Note: When we tried to find the historical rationale for the types we
just found that they were apparently only added for consistent syntax
highlighting which didn't seem that compelling.
Up until now we have been continuing to use some of the platform
specific type such as gint{8,16,32,64} and gsize but this patch switches
us over to using the standard c99 equivalents instead so we can further
ensure that our code looks familiar to the widest range of C developers
who might potentially contribute to Cogl.
So instead of using the gint{8,16,32,64} and guint{8,16,32,64} types this
switches all Cogl code to instead use the int{8,16,32,64}_t and
uint{8,16,32,64}_t c99 types instead.
Instead of gsize we now use size_t
For now we are not going to use the c99 _Bool type and instead we have
introduced a new CoglBool type to use instead of gboolean.
Reviewed-by: Neil Roberts <neil@linux.intel.com>
(cherry picked from commit 5967dad2400d32ca6319cef6cb572e81bf2c15f0)
2012-04-16 20:56:40 +00:00
|
|
|
CoglBool
|
2012-03-22 16:32:56 +00:00
|
|
|
(* update_features) (CoglContext *context,
|
2012-08-31 18:28:27 +00:00
|
|
|
CoglError **error);
|
2012-08-31 23:04:00 +00:00
|
|
|
|
|
|
|
CoglBool
|
|
|
|
(* offscreen_allocate) (CoglOffscreen *offscreen,
|
2012-08-31 18:28:27 +00:00
|
|
|
CoglError **error);
|
2012-08-31 23:04:00 +00:00
|
|
|
|
|
|
|
void
|
|
|
|
(* offscreen_free) (CoglOffscreen *offscreen);
|
|
|
|
|
|
|
|
void
|
|
|
|
(* framebuffer_flush_state) (CoglFramebuffer *draw_buffer,
|
|
|
|
CoglFramebuffer *read_buffer,
|
|
|
|
CoglFramebufferState state);
|
|
|
|
|
|
|
|
void
|
|
|
|
(* framebuffer_clear) (CoglFramebuffer *framebuffer,
|
|
|
|
unsigned long buffers,
|
|
|
|
float red,
|
|
|
|
float green,
|
|
|
|
float blue,
|
|
|
|
float alpha);
|
|
|
|
|
|
|
|
void
|
|
|
|
(* framebuffer_query_bits) (CoglFramebuffer *framebuffer,
|
|
|
|
int *red,
|
|
|
|
int *green,
|
|
|
|
int *blue,
|
|
|
|
int *alpha);
|
|
|
|
|
|
|
|
void
|
|
|
|
(* framebuffer_finish) (CoglFramebuffer *framebuffer);
|
|
|
|
|
|
|
|
void
|
|
|
|
(* framebuffer_discard_buffers) (CoglFramebuffer *framebuffer,
|
|
|
|
unsigned long buffers);
|
|
|
|
|
|
|
|
void
|
|
|
|
(* framebuffer_draw_attributes) (CoglFramebuffer *framebuffer,
|
|
|
|
CoglPipeline *pipeline,
|
|
|
|
CoglVerticesMode mode,
|
|
|
|
int first_vertex,
|
|
|
|
int n_vertices,
|
|
|
|
CoglAttribute **attributes,
|
|
|
|
int n_attributes,
|
|
|
|
CoglDrawFlags flags);
|
|
|
|
|
|
|
|
void
|
|
|
|
(* framebuffer_draw_indexed_attributes) (CoglFramebuffer *framebuffer,
|
|
|
|
CoglPipeline *pipeline,
|
|
|
|
CoglVerticesMode mode,
|
|
|
|
int first_vertex,
|
|
|
|
int n_vertices,
|
|
|
|
CoglIndices *indices,
|
|
|
|
CoglAttribute **attributes,
|
|
|
|
int n_attributes,
|
|
|
|
CoglDrawFlags flags);
|
2012-09-10 20:45:33 +00:00
|
|
|
|
|
|
|
/* Destroys any driver specific resources associated with the given
|
|
|
|
* 2D texture. */
|
|
|
|
void
|
|
|
|
(* texture_2d_free) (CoglTexture2D *tex_2d);
|
|
|
|
|
|
|
|
/* Returns TRUE if the driver can support creating a 2D texture with
|
|
|
|
* the given geometry and specified internal format.
|
|
|
|
*/
|
|
|
|
CoglBool
|
|
|
|
(* texture_2d_can_create) (CoglContext *ctx,
|
|
|
|
int width,
|
|
|
|
int height,
|
|
|
|
CoglPixelFormat internal_format);
|
|
|
|
|
|
|
|
/* Initializes driver private state before allocating any specific
|
|
|
|
* storage for a 2D texture, where base texture and texture 2D
|
|
|
|
* members will already be initialized before passing control to
|
|
|
|
* the driver.
|
|
|
|
*/
|
|
|
|
void
|
|
|
|
(* texture_2d_init) (CoglTexture2D *tex_2d);
|
|
|
|
|
|
|
|
/* Instantiates a new CoglTexture2D object with un-initialized
|
|
|
|
* storage for a given size and internal format */
|
|
|
|
CoglTexture2D *
|
|
|
|
(* texture_2d_new_with_size) (CoglContext *ctx,
|
|
|
|
int width,
|
|
|
|
int height,
|
|
|
|
CoglPixelFormat internal_format,
|
|
|
|
CoglError **error);
|
|
|
|
|
|
|
|
/* Instantiates a new CoglTexture2D object with storage initialized
|
|
|
|
* with the contents of the given bitmap, using the specified
|
|
|
|
* internal format.
|
|
|
|
*/
|
|
|
|
CoglTexture2D *
|
|
|
|
(* texture_2d_new_from_bitmap) (CoglBitmap *bmp,
|
|
|
|
CoglPixelFormat internal_format,
|
|
|
|
CoglError **error);
|
|
|
|
|
|
|
|
#if defined (COGL_HAS_EGL_SUPPORT) && defined (EGL_KHR_image_base)
|
|
|
|
/* Instantiates a new CoglTexture2D object with storage initialized
|
|
|
|
* with the contents of the given EGL image.
|
|
|
|
*
|
|
|
|
* This is optional for drivers to support
|
|
|
|
*/
|
|
|
|
CoglTexture2D *
|
|
|
|
(* egl_texture_2d_new_from_image) (CoglContext *ctx,
|
|
|
|
int width,
|
|
|
|
int height,
|
|
|
|
CoglPixelFormat format,
|
|
|
|
EGLImageKHR image,
|
|
|
|
CoglError **error);
|
|
|
|
#endif
|
|
|
|
|
|
|
|
/* Initialize the specified region of storage of the given texture
|
|
|
|
* with the contents of the specified framebuffer region
|
|
|
|
*/
|
|
|
|
void
|
|
|
|
(* texture_2d_copy_from_framebuffer) (CoglTexture2D *tex_2d,
|
|
|
|
CoglFramebuffer *src_fb,
|
|
|
|
int dst_x,
|
|
|
|
int dst_y,
|
|
|
|
int src_x,
|
|
|
|
int src_y,
|
|
|
|
int width,
|
|
|
|
int height);
|
|
|
|
|
|
|
|
/* If the given texture has a corresponding OpenGL texture handle
|
|
|
|
* then return that.
|
|
|
|
*
|
|
|
|
* This is optional
|
|
|
|
*/
|
|
|
|
unsigned int
|
|
|
|
(* texture_2d_get_gl_handle) (CoglTexture2D *tex_2d);
|
|
|
|
|
|
|
|
/* Update all mipmap levels > 0 */
|
|
|
|
void
|
|
|
|
(* texture_2d_generate_mipmap) (CoglTexture2D *tex_2d);
|
|
|
|
|
|
|
|
/* Initialize the specified region of storage of the given texture
|
|
|
|
* with the contents of the specified bitmap region
|
|
|
|
*/
|
|
|
|
void
|
|
|
|
(* texture_2d_copy_from_bitmap) (CoglTexture2D *tex_2d,
|
|
|
|
CoglBitmap *bitmap,
|
|
|
|
int dst_x,
|
|
|
|
int dst_y,
|
|
|
|
int src_x,
|
|
|
|
int src_y,
|
|
|
|
int width,
|
|
|
|
int height);
|
|
|
|
|
|
|
|
/* Reads back the full contents of the given texture and write it to
|
|
|
|
* @data in the given @format and with the given @rowstride.
|
|
|
|
*
|
|
|
|
* This is optional
|
|
|
|
*/
|
|
|
|
void
|
|
|
|
(* texture_2d_get_data) (CoglTexture2D *tex_2d,
|
|
|
|
CoglPixelFormat format,
|
2012-09-26 16:05:01 +00:00
|
|
|
int rowstride,
|
2012-09-10 20:45:33 +00:00
|
|
|
uint8_t *data);
|
2012-09-19 19:04:24 +00:00
|
|
|
|
|
|
|
/* Prepares for drawing by flushing the journal, framebuffer state,
|
|
|
|
* pipeline state and attribute state.
|
|
|
|
*/
|
|
|
|
void
|
|
|
|
(* flush_attributes_state) (CoglFramebuffer *framebuffer,
|
|
|
|
CoglPipeline *pipeline,
|
|
|
|
CoglFlushLayerState *layer_state,
|
|
|
|
CoglDrawFlags flags,
|
|
|
|
CoglAttribute **attributes,
|
|
|
|
int n_attributes);
|
2012-09-19 19:37:32 +00:00
|
|
|
|
|
|
|
/* Flushes the clip stack to the GPU using a combination of the
|
|
|
|
* stencil buffer, scissor and clip plane state.
|
|
|
|
*/
|
|
|
|
void
|
|
|
|
(* clip_stack_flush) (CoglClipStack *stack, CoglFramebuffer *framebuffer);
|
|
|
|
|
2012-09-19 21:32:25 +00:00
|
|
|
/* Enables the driver to create some meta data to represent a buffer
|
|
|
|
* but with no corresponding storage allocated yet.
|
|
|
|
*/
|
|
|
|
void
|
|
|
|
(* buffer_create) (CoglBuffer *buffer);
|
|
|
|
|
|
|
|
void
|
|
|
|
(* buffer_destroy) (CoglBuffer *buffer);
|
|
|
|
|
|
|
|
/* Maps a buffer into the CPU */
|
|
|
|
void *
|
2012-10-17 20:28:45 +00:00
|
|
|
(* buffer_map_range) (CoglBuffer *buffer,
|
|
|
|
size_t offset,
|
|
|
|
size_t size,
|
|
|
|
CoglBufferAccess access,
|
|
|
|
CoglBufferMapHint hints);
|
2012-09-19 21:32:25 +00:00
|
|
|
|
|
|
|
/* Unmaps a buffer */
|
|
|
|
void
|
|
|
|
(* buffer_unmap) (CoglBuffer *buffer);
|
|
|
|
|
|
|
|
/* Uploads data to the buffer without needing to map it necessarily
|
|
|
|
*/
|
|
|
|
CoglBool
|
|
|
|
(* buffer_set_data) (CoglBuffer *buffer,
|
|
|
|
unsigned int offset,
|
|
|
|
const void *data,
|
|
|
|
unsigned int size);
|
2012-03-22 16:32:56 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
#endif /* __COGL_DRIVER_H */
|
|
|
|
|