mutter/cogl/cogl-driver.h
Robert Bragg a0441778ad This re-licenses Cogl 1.18 under the MIT license
Since the Cogl 1.18 branch is actively maintained in parallel with the
master branch; this is a counter part to commit 1b83ef938fc16b which
re-licensed the master branch to use the MIT license.

This re-licensing is a follow up to the proposal that was sent to the
Cogl mailing list:
http://lists.freedesktop.org/archives/cogl/2013-December/001465.html

Note: there was a copyright assignment policy in place for Clutter (and
therefore Cogl which was part of Clutter at the time) until the 11th of
June 2010 and so we only checked the details after that point (commit
0bbf50f905)

For each file, authors were identified via this Git command:
$ git blame -p -C -C -C20 -M -M10  0bbf50f905..HEAD

We received blanket approvals for re-licensing all Red Hat and Collabora
contributions which reduced how many people needed to be contacted
individually:
- http://lists.freedesktop.org/archives/cogl/2013-December/001470.html
- http://lists.freedesktop.org/archives/cogl/2014-January/001536.html

Individual approval requests were sent to all the other identified authors
who all confirmed the re-license on the Cogl mailinglist:
http://lists.freedesktop.org/archives/cogl/2014-January

As well as updating the copyright header in all sources files, the
COPYING file has been updated to reflect the license change and also
document the other licenses used in Cogl such as the SGI Free Software
License B, version 2.0 and the 3-clause BSD license.

This patch was not simply cherry-picked from master; but the same
methodology was used to check the source files.
2014-02-22 02:02:53 +00:00

269 lines
9.4 KiB
C

/*
* Cogl
*
* A Low Level GPU Graphics and Utilities API
*
* Copyright (C) 2012 Intel Corporation.
*
* Permission is hereby granted, free of charge, to any person
* obtaining a copy of this software and associated documentation
* files (the "Software"), to deal in the Software without
* restriction, including without limitation the rights to use, copy,
* modify, merge, publish, distribute, sublicense, and/or sell copies
* of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
* BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
*
*/
#ifndef __COGL_DRIVER_H
#define __COGL_DRIVER_H
#include "cogl-context.h"
#include "cogl-offscreen.h"
#include "cogl-framebuffer-private.h"
#include "cogl-attribute-private.h"
typedef struct _CoglDriverVtable CoglDriverVtable;
struct _CoglDriverVtable
{
/* TODO: factor this out since this is OpenGL specific and
* so can be ignored by non-OpenGL drivers. */
CoglBool
(* pixel_format_from_gl_internal) (CoglContext *context,
GLenum gl_int_format,
CoglPixelFormat *out_format);
/* TODO: factor this out since this is OpenGL specific and
* so can be ignored by non-OpenGL drivers. */
CoglPixelFormat
(* pixel_format_to_gl) (CoglContext *context,
CoglPixelFormat format,
GLenum *out_glintformat,
GLenum *out_glformat,
GLenum *out_gltype);
CoglBool
(* update_features) (CoglContext *context,
CoglError **error);
CoglBool
(* offscreen_allocate) (CoglOffscreen *offscreen,
CoglError **error);
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,
CoglFramebufferBits *bits);
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);
CoglBool
(* framebuffer_read_pixels_into_bitmap) (CoglFramebuffer *framebuffer,
int x,
int y,
CoglReadPixelsFlags source,
CoglBitmap *bitmap,
CoglError **error);
/* 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);
/* Allocates (uninitialized) storage for the given texture according
* to the configured size and format of the texture */
CoglBool
(* texture_2d_allocate) (CoglTexture *tex,
CoglError **error);
/* 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,
int src_x,
int src_y,
int width,
int height,
CoglFramebuffer *src_fb,
int dst_x,
int dst_y,
int level);
/* 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
*
* Since this may need to create the underlying storage first
* it may throw a NO_MEMORY error.
*/
CoglBool
(* texture_2d_copy_from_bitmap) (CoglTexture2D *tex_2d,
int src_x,
int src_y,
int width,
int height,
CoglBitmap *bitmap,
int dst_x,
int dst_y,
int level,
CoglError **error);
/* 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,
int rowstride,
uint8_t *data);
/* 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);
/* 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);
/* 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 *
(* buffer_map_range) (CoglBuffer *buffer,
size_t offset,
size_t size,
CoglBufferAccess access,
CoglBufferMapHint hints,
CoglError **error);
/* 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,
CoglError **error);
};
#define COGL_DRIVER_ERROR (_cogl_driver_error_quark ())
typedef enum { /*< prefix=COGL_DRIVER_ERROR >*/
COGL_DRIVER_ERROR_UNKNOWN_VERSION,
COGL_DRIVER_ERROR_INVALID_VERSION,
COGL_DRIVER_ERROR_NO_SUITABLE_DRIVER_FOUND,
COGL_DRIVER_ERROR_FAILED_TO_LOAD_LIBRARY
} CoglDriverError;
uint32_t
_cogl_driver_error_quark (void);
#endif /* __COGL_DRIVER_H */