cogl: Adds experimental cogl_context_new() API

This adds a new experimental function (you need to define
COGL_ENABLE_EXPERIMENTAL_API to access it) which takes us towards being
able to have a standalone Cogl API. This is really a minor aesthetic
change for now since all the GL context creation code still lives in
Clutter but it's a step forward none the less.

Since our current designs introduce a CoglDisplay object as something
that would be passed to the context constructor this provides a stub
cogl-display.h with CoglDisplay typedef.

_cogl_context_get_default() which Clutter uses to access the Cogl
context has been modified to use cogl_context_new() to initialize
the default context.

There is one rather nasty hack used in this patch which is that the
implementation of cogl_context_new() has to forcibly make the allocated
context become the default context because currently all the code in
Cogl assumes it can access the context using _COGL_GET_CONTEXT including
code used to initialize the context.
This commit is contained in:
Robert Bragg 2010-11-05 00:00:25 +00:00
parent fdbc741770
commit e9b1ca0165
6 changed files with 305 additions and 137 deletions

View File

@ -82,6 +82,7 @@ cogl_public_h = \
$(NULL)
cogl_experimental_h = \
$(srcdir)/cogl-context.h \
$(srcdir)/cogl2-path.h \
$(srcdir)/cogl2-clip-state.h \
$(NULL)

View File

@ -25,6 +25,7 @@
#define __COGL_CONTEXT_PRIVATE_H
#include "cogl-internal.h"
#include "cogl-context.h"
#if HAVE_COGL_GL
#include "cogl-context-driver-gl.h"
@ -50,8 +51,10 @@ typedef struct
GLubyte c[4];
} CoglTextureGLVertex;
typedef struct
struct _CoglContext
{
CoglObject _parent;
/* Features cache */
CoglFeatureFlags feature_flags;
CoglFeatureFlagsPrivate feature_flags_private;
@ -236,7 +239,7 @@ typedef struct
CoglContextDriver drv;
CoglContextWinsys winsys;
} CoglContext;
};
CoglContext *
_cogl_context_get_default ();

View File

@ -26,6 +26,7 @@
#endif
#include "cogl.h"
#include "cogl-object.h"
#include "cogl-internal.h"
#include "cogl-profile.h"
#include "cogl-util.h"
@ -49,6 +50,10 @@
#define GL_POINT_SPRITE 0x8861
#endif
static void _cogl_context_free (CoglContext *context);
COGL_OBJECT_DEFINE (Context, context);
extern void
_cogl_create_context_driver (CoglContext *context);
extern void
@ -81,16 +86,29 @@ _cogl_init_feature_overrides (CoglContext *ctx)
COGL_FEATURE_TEXTURE_NPOT_REPEAT);
}
static gboolean
cogl_create_context (void)
/* FIXME: We don't report a GError here should we? With non NULL
* displays then there should basically be no risk of error I think,
* but NULL just says "please do the right thing" and we could hit any
* number of problems that should be reported back to the caller!
*
* Also is it acceptable for construction to report an error
* or should there be a separate cogl_context_check_status()
* API of some kind?
*/
CoglContext *
cogl_context_new (CoglDisplay *display)
{
CoglContext *context;
GLubyte default_texture_data[] = { 0xff, 0xff, 0xff, 0x0 };
unsigned long enable_flags = 0;
unsigned long enable_flags = 0;
CoglHandle window_buffer;
int i;
if (_context != NULL)
return FALSE;
/* A NULL display means "please just do something sensible"
* and since we haven't implemented anything for CoglDisplay
* yet that's the only kind of context construction we allow
* for now. */
g_return_val_if_fail (display == NULL, NULL);
#ifdef CLUTTER_ENABLE_PROFILE
/* We need to be absolutely sure that uprof has been initialized
@ -109,105 +127,114 @@ cogl_create_context (void)
#endif
/* Allocate context memory */
_context = (CoglContext*) g_malloc (sizeof (CoglContext));
context = g_malloc (sizeof (CoglContext));
/* XXX: Gross hack!
* Currently everything in Cogl just assumes there is a default
* context which it can access via _COGL_GET_CONTEXT() including
* code used to construct a CoglContext. Until all of that code
* has been updated to take an explicit context argument we have
* to immediatly make our pointer the default context.
*/
_context = context;
/* Init default values */
_context->feature_flags = 0;
_context->feature_flags_private = 0;
_context->texture_types = NULL;
_context->buffer_types = NULL;
context->texture_types = NULL;
context->buffer_types = NULL;
/* Initialise the driver specific state */
/* TODO: combine these two into one function */
_cogl_create_context_driver (_context);
_cogl_create_context_driver (context);
_cogl_features_init ();
_cogl_init_feature_overrides (_context);
_cogl_create_context_winsys (_context);
_cogl_create_context_winsys (context);
_cogl_pipeline_init_default_pipeline ();
_cogl_pipeline_init_default_layers ();
_cogl_pipeline_init_state_hash_functions ();
_cogl_pipeline_init_layer_state_hash_functions ();
_context->enable_flags = 0;
context->enable_flags = 0;
_context->enable_backface_culling = FALSE;
_context->flushed_front_winding = COGL_FRONT_WINDING_COUNTER_CLOCKWISE;
context->enable_backface_culling = FALSE;
context->flushed_front_winding = COGL_FRONT_WINDING_COUNTER_CLOCKWISE;
_context->indirect = gl_is_indirect;
context->indirect = gl_is_indirect;
cogl_matrix_init_identity (&_context->identity_matrix);
cogl_matrix_init_identity (&_context->y_flip_matrix);
cogl_matrix_scale (&_context->y_flip_matrix, 1, -1, 1);
cogl_matrix_init_identity (&context->identity_matrix);
cogl_matrix_init_identity (&context->y_flip_matrix);
cogl_matrix_scale (&context->y_flip_matrix, 1, -1, 1);
_context->flushed_matrix_mode = COGL_MATRIX_MODELVIEW;
context->flushed_matrix_mode = COGL_MATRIX_MODELVIEW;
_context->texture_units =
context->texture_units =
g_array_new (FALSE, FALSE, sizeof (CoglTextureUnit));
/* See cogl-pipeline.c for more details about why we leave texture unit 1
* active by default... */
_context->active_texture_unit = 1;
context->active_texture_unit = 1;
GE (glActiveTexture (GL_TEXTURE1));
_context->legacy_fog_state.enabled = FALSE;
context->legacy_fog_state.enabled = FALSE;
_context->opaque_color_pipeline = cogl_pipeline_new ();
_context->blended_color_pipeline = cogl_pipeline_new ();
_context->texture_pipeline = cogl_pipeline_new ();
_context->codegen_header_buffer = g_string_new ("");
_context->codegen_source_buffer = g_string_new ("");
_context->source_stack = NULL;
context->opaque_color_pipeline = cogl_pipeline_new ();
context->blended_color_pipeline = cogl_pipeline_new ();
context->texture_pipeline = cogl_pipeline_new ();
context->codegen_header_buffer = g_string_new ("");
context->codegen_source_buffer = g_string_new ("");
context->source_stack = NULL;
_context->legacy_state_set = 0;
context->legacy_state_set = 0;
_context->default_gl_texture_2d_tex = COGL_INVALID_HANDLE;
_context->default_gl_texture_rect_tex = COGL_INVALID_HANDLE;
context->default_gl_texture_2d_tex = COGL_INVALID_HANDLE;
context->default_gl_texture_rect_tex = COGL_INVALID_HANDLE;
_context->framebuffers = NULL;
context->framebuffers = NULL;
_context->journal_flush_attributes_array =
context->journal_flush_attributes_array =
g_array_new (TRUE, FALSE, sizeof (CoglAttribute *));
_context->journal_clip_bounds = NULL;
context->journal_clip_bounds = NULL;
_context->polygon_vertices = g_array_new (FALSE, FALSE, sizeof (float));
context->polygon_vertices = g_array_new (FALSE, FALSE, sizeof (float));
_context->current_pipeline = NULL;
_context->current_pipeline_changes_since_flush = 0;
_context->current_pipeline_skip_gl_color = FALSE;
context->current_pipeline = NULL;
context->current_pipeline_changes_since_flush = 0;
context->current_pipeline_skip_gl_color = FALSE;
_context->pipeline0_nodes =
context->pipeline0_nodes =
g_array_sized_new (FALSE, FALSE, sizeof (CoglHandle), 20);
_context->pipeline1_nodes =
context->pipeline1_nodes =
g_array_sized_new (FALSE, FALSE, sizeof (CoglHandle), 20);
_cogl_bitmask_init (&_context->arrays_enabled);
_cogl_bitmask_init (&_context->temp_bitmask);
_cogl_bitmask_init (&_context->arrays_to_change);
_cogl_bitmask_init (&context->arrays_enabled);
_cogl_bitmask_init (&context->temp_bitmask);
_cogl_bitmask_init (&context->arrays_to_change);
_context->max_texture_units = -1;
_context->max_texture_image_units = -1;
_context->max_activateable_texture_units = -1;
context->max_texture_units = -1;
context->max_texture_image_units = -1;
context->max_activateable_texture_units = -1;
_context->current_program = COGL_INVALID_HANDLE;
context->current_program = COGL_INVALID_HANDLE;
_context->current_fragment_program_type = COGL_PIPELINE_PROGRAM_TYPE_FIXED;
_context->current_vertex_program_type = COGL_PIPELINE_PROGRAM_TYPE_FIXED;
_context->current_gl_program = 0;
context->current_fragment_program_type = COGL_PIPELINE_PROGRAM_TYPE_FIXED;
context->current_vertex_program_type = COGL_PIPELINE_PROGRAM_TYPE_FIXED;
context->current_gl_program = 0;
_context->gl_blend_enable_cache = FALSE;
context->gl_blend_enable_cache = FALSE;
_context->depth_test_enabled_cache = FALSE;
_context->depth_test_function_cache = COGL_DEPTH_TEST_FUNCTION_LESS;
_context->depth_writing_enabled_cache = TRUE;
_context->depth_range_near_cache = 0;
_context->depth_range_far_cache = 1;
context->depth_test_enabled_cache = FALSE;
context->depth_test_function_cache = COGL_DEPTH_TEST_FUNCTION_LESS;
context->depth_writing_enabled_cache = TRUE;
context->depth_range_near_cache = 0;
context->depth_range_far_cache = 1;
_context->point_size_cache = 1.0f;
context->point_size_cache = 1.0f;
_context->legacy_depth_test_enabled = FALSE;
context->legacy_depth_test_enabled = FALSE;
#ifdef HAVE_COGL_GL
_context->arbfp_cache = g_hash_table_new (_cogl_pipeline_fragend_arbfp_hash,
@ -215,9 +242,9 @@ cogl_create_context (void)
#endif
for (i = 0; i < COGL_BUFFER_BIND_TARGET_COUNT; i++)
_context->current_buffer[i] = NULL;
context->current_buffer[i] = NULL;
_context->framebuffer_stack = _cogl_create_framebuffer_stack ();
context->framebuffer_stack = _cogl_create_framebuffer_stack ();
_context->current_clip_stack_valid = FALSE;
@ -225,26 +252,26 @@ cogl_create_context (void)
cogl_set_framebuffer (window_buffer);
/* XXX: the deprecated _cogl_set_draw_buffer API expects to
* find the window buffer here... */
_context->window_buffer = window_buffer;
context->window_buffer = window_buffer;
_context->dirty_bound_framebuffer = TRUE;
_context->dirty_gl_viewport = TRUE;
context->dirty_bound_framebuffer = TRUE;
context->dirty_gl_viewport = TRUE;
_context->current_path = cogl2_path_new ();
_context->stencil_pipeline = cogl_pipeline_new ();
context->current_path = cogl2_path_new ();
context->stencil_pipeline = cogl_pipeline_new ();
_context->in_begin_gl_block = FALSE;
context->in_begin_gl_block = FALSE;
_context->quad_buffer_indices_byte = COGL_INVALID_HANDLE;
_context->quad_buffer_indices = COGL_INVALID_HANDLE;
_context->quad_buffer_indices_len = 0;
context->quad_buffer_indices_byte = COGL_INVALID_HANDLE;
context->quad_buffer_indices = COGL_INVALID_HANDLE;
context->quad_buffer_indices_len = 0;
_context->rectangle_byte_indices = NULL;
_context->rectangle_short_indices = NULL;
_context->rectangle_short_indices_len = 0;
context->rectangle_byte_indices = NULL;
context->rectangle_short_indices = NULL;
context->rectangle_short_indices_len = 0;
_context->texture_download_pipeline = COGL_INVALID_HANDLE;
_context->blit_texture_pipeline = COGL_INVALID_HANDLE;
context->texture_download_pipeline = COGL_INVALID_HANDLE;
context->blit_texture_pipeline = COGL_INVALID_HANDLE;
#ifndef HAVE_COGL_GLES2
/* The default for GL_ALPHA_TEST is to always pass which is equivalent to
@ -262,7 +289,7 @@ cogl_create_context (void)
#endif
/* Create default textures used for fall backs */
_context->default_gl_texture_2d_tex =
context->default_gl_texture_2d_tex =
cogl_texture_new_from_data (1, /* width */
1, /* height */
COGL_TEXTURE_NO_SLICING,
@ -271,7 +298,7 @@ cogl_create_context (void)
COGL_PIXEL_FORMAT_RGBA_8888_PRE,
0, /* auto calc row stride */
default_texture_data);
_context->default_gl_texture_rect_tex =
context->default_gl_texture_rect_tex =
cogl_texture_new_from_data (1, /* width */
1, /* height */
COGL_TEXTURE_NO_SLICING,
@ -281,12 +308,12 @@ cogl_create_context (void)
0, /* auto calc row stride */
default_texture_data);
cogl_push_source (_context->opaque_color_pipeline);
_cogl_pipeline_flush_gl_state (_context->opaque_color_pipeline, FALSE, 0);
cogl_push_source (context->opaque_color_pipeline);
_cogl_pipeline_flush_gl_state (context->opaque_color_pipeline, FALSE, 0);
_cogl_enable (enable_flags);
_cogl_flush_face_winding ();
_context->atlases = NULL;
context->atlases = NULL;
_context->buffer_map_fallback_array = g_byte_array_new ();
_context->buffer_map_fallback_in_use = FALSE;
@ -303,79 +330,75 @@ cogl_create_context (void)
GE (glEnable (GL_POINT_SPRITE));
#endif
return TRUE;
return _cogl_context_object_new (context);
}
void
_cogl_destroy_context (void)
static void
_cogl_context_free (CoglContext *context)
{
if (_context == NULL)
return;
_cogl_destroy_context_winsys (_context);
_cogl_destroy_context_winsys (context);
_cogl_destroy_texture_units ();
_cogl_free_framebuffer_stack (_context->framebuffer_stack);
_cogl_free_framebuffer_stack (context->framebuffer_stack);
if (_context->current_path)
cogl_handle_unref (_context->current_path);
if (context->current_path)
cogl_handle_unref (context->current_path);
if (_context->default_gl_texture_2d_tex)
cogl_handle_unref (_context->default_gl_texture_2d_tex);
if (_context->default_gl_texture_rect_tex)
cogl_handle_unref (_context->default_gl_texture_rect_tex);
if (context->default_gl_texture_2d_tex)
cogl_handle_unref (context->default_gl_texture_2d_tex);
if (context->default_gl_texture_rect_tex)
cogl_handle_unref (context->default_gl_texture_rect_tex);
if (_context->opaque_color_pipeline)
cogl_handle_unref (_context->opaque_color_pipeline);
if (_context->blended_color_pipeline)
cogl_handle_unref (_context->blended_color_pipeline);
if (_context->texture_pipeline)
cogl_handle_unref (_context->texture_pipeline);
if (context->opaque_color_pipeline)
cogl_handle_unref (context->opaque_color_pipeline);
if (context->blended_color_pipeline)
cogl_handle_unref (context->blended_color_pipeline);
if (context->texture_pipeline)
cogl_handle_unref (context->texture_pipeline);
if (_context->blit_texture_pipeline)
cogl_handle_unref (_context->blit_texture_pipeline);
if (context->blit_texture_pipeline)
cogl_handle_unref (context->blit_texture_pipeline);
if (_context->journal_flush_attributes_array)
g_array_free (_context->journal_flush_attributes_array, TRUE);
if (_context->journal_clip_bounds)
g_array_free (_context->journal_clip_bounds, TRUE);
if (context->journal_flush_attributes_array)
g_array_free (context->journal_flush_attributes_array, TRUE);
if (context->journal_clip_bounds)
g_array_free (context->journal_clip_bounds, TRUE);
if (_context->polygon_vertices)
g_array_free (_context->polygon_vertices, TRUE);
if (context->polygon_vertices)
g_array_free (context->polygon_vertices, TRUE);
if (_context->quad_buffer_indices_byte)
cogl_handle_unref (_context->quad_buffer_indices_byte);
if (_context->quad_buffer_indices)
cogl_handle_unref (_context->quad_buffer_indices);
if (context->quad_buffer_indices_byte)
cogl_handle_unref (context->quad_buffer_indices_byte);
if (context->quad_buffer_indices)
cogl_handle_unref (context->quad_buffer_indices);
if (_context->rectangle_byte_indices)
cogl_object_unref (_context->rectangle_byte_indices);
if (_context->rectangle_short_indices)
cogl_object_unref (_context->rectangle_short_indices);
if (context->rectangle_byte_indices)
cogl_object_unref (context->rectangle_byte_indices);
if (context->rectangle_short_indices)
cogl_object_unref (context->rectangle_short_indices);
if (_context->default_pipeline)
cogl_handle_unref (_context->default_pipeline);
if (context->default_pipeline)
cogl_handle_unref (context->default_pipeline);
if (_context->dummy_layer_dependant)
cogl_handle_unref (_context->dummy_layer_dependant);
if (_context->default_layer_n)
cogl_handle_unref (_context->default_layer_n);
if (_context->default_layer_0)
cogl_handle_unref (_context->default_layer_0);
if (context->dummy_layer_dependant)
cogl_handle_unref (context->dummy_layer_dependant);
if (context->default_layer_n)
cogl_handle_unref (context->default_layer_n);
if (context->default_layer_0)
cogl_handle_unref (context->default_layer_0);
if (_context->current_clip_stack_valid)
_cogl_clip_stack_unref (_context->current_clip_stack);
if (context->current_clip_stack_valid)
_cogl_clip_stack_unref (context->current_clip_stack);
g_slist_free (_context->atlases);
g_slist_free (context->atlases);
_cogl_bitmask_destroy (&_context->arrays_enabled);
_cogl_bitmask_destroy (&_context->temp_bitmask);
_cogl_bitmask_destroy (&_context->arrays_to_change);
_cogl_bitmask_destroy (&context->arrays_enabled);
_cogl_bitmask_destroy (&context->temp_bitmask);
_cogl_bitmask_destroy (&context->arrays_to_change);
g_slist_free (_context->texture_types);
g_slist_free (_context->buffer_types);
g_slist_free (context->texture_types);
g_slist_free (context->buffer_types);
#ifdef HAVE_COGL_GLES2
if (_context->flushed_modelview_stack)
@ -385,12 +408,12 @@ _cogl_destroy_context (void)
#endif
#ifdef HAVE_COGL_GL
g_hash_table_unref (_context->arbfp_cache);
g_hash_table_unref (context->arbfp_cache);
#endif
g_byte_array_free (_context->buffer_map_fallback_array, TRUE);
g_byte_array_free (context->buffer_map_fallback_array, TRUE);
g_free (_context);
g_free (context);
}
CoglContext *
@ -398,7 +421,7 @@ _cogl_context_get_default (void)
{
/* Create if doesn't exist yet */
if (_context == NULL)
cogl_create_context ();
_context = cogl_context_new (NULL);
return _context;
}

62
cogl/cogl-context.h Normal file
View File

@ -0,0 +1,62 @@
/*
* 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_CONTEXT_H__
#define __COGL_CONTEXT_H__
#include <cogl/cogl-display.h>
G_BEGIN_DECLS
/**
* SECTION:cogl-context
* @short_description: The top level application context.
*
* A CoglContext is the topmost sandbox of Cogl state for an
* application or toolkit. Its main purpose is to bind together the
* key state objects at any one time; with the most significant being
* the current framebuffer being drawn too (See #CoglFramebuffer for
* more details) and the current GPU pipeline configuration (See
* #CoglPipeline for more details).
*/
typedef struct _CoglContext CoglContext;
#define COGL_CONTEXT(OBJECT) ((CoglContext *)OBJECT)
#define cogl_context_new cogl_context_new_EXP
CoglContext *
cogl_context_new (CoglDisplay *display);
G_END_DECLS
#endif /* __COGL_CONTEXT_H__ */

78
cogl/cogl-display.h Normal file
View File

@ -0,0 +1,78 @@
/*
* 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_DISPLAY_H__
#define __COGL_DISPLAY_H__
G_BEGIN_DECLS
/**
* SECTION:cogl-display
* @short_description: Represents a display pipeline
*
* TODO: We still need to decide if we really need this object or if
* it's enough to just have the CoglSwapChain CoglOnscreenTemplate
* objects.
*
* The basic intention is for this object to let the application
* specify its display preferences before creating a context, and
* there are a few different aspects to this...
*
* Firstly there is the physical display pipeline that is currently
* being used including the digital to analogue conversion hardware
* and the screen the user sees. Although we don't have a plan to
* expose all the advanced features of arbitrary display hardware with
* a Cogl API, some backends may want to expose limited control over
* this hardware via Cogl and simpler features like providing a list
* of modes to choose from in a UI could be nice too.
*
* Another aspect is that the display configuration may be tightly
* related to how onscreen framebuffers should be configured. In fact
* one of the early rationals for this object was to let us handle
* GLX's requirement that framebuffers must be "compatible" with the
* fbconfig associated with the current context meaning we have to
* force the user to describe how they would like to create their
* onscreen windows before we can choose a suitable fbconfig and
* create a GLContext.
*
* TODO: continue this thought process and come to a decision...
*/
typedef struct _CoglDisplay CoglDisplay;
#define COGL_DISPLAY(OBJECT) ((CoglDisplay *)OBJECT)
CoglDisplay *
cogl_display_new (CoglDisplay *display);
G_END_DECLS
#endif /* __COGL_DISPLAY_H__ */

View File

@ -68,6 +68,7 @@
#include <cogl/cogl-deprecated.h>
#if defined (COGL_ENABLE_EXPERIMENTAL_API)
#include <cogl/cogl-context.h>
#include <cogl/cogl-buffer.h>
#include <cogl/cogl-pixel-array.h>
#include <cogl/cogl-vector.h>