From: Emmanuele Bassi <ebassi@linux.intel.com>
Date: Fri, 12 Feb 2010 11:38:47 +0000 (+0000)
Subject: docs: Update the backend HACKING file
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=34c7611407154fcbb61c82c959c2a38972c2534f;p=profile%2Fivi%2Fclutter.git

docs: Update the backend HACKING file

Clarify the Backend::create_context() vfunc role, and the
Stage::realize() vfunc with regards to creating the GL/GLES
context.
---

diff --git a/doc/HACKING.backends b/doc/HACKING.backends
index 4ea724f..12f96f2 100644
--- a/doc/HACKING.backends
+++ b/doc/HACKING.backends
@@ -90,12 +90,11 @@ can be overridden:
      from the GL or GLES implementation, plus the eventual backend-specific
      features.
 
-  ClutterBackend::get_display_size
-  -- Use this function to retrieve the size of the display.
-
   ClutterBackend::create_context
   -- This function is used to create the drawing context to be used
-     by Clutter.
+     by Clutter. Clutter will call this function during the initialization
+     phase. A GL (or GLES) context must always be available after the
+     initialization, so that Cogl and Clutter can query it for capabilities.
 
   ClutterBackend::ensure_context
   -- This function is used to ensure that the backend drawing context
@@ -140,8 +139,9 @@ ClutterStage actor using the ClutterStageWindow implementation.
 In the ::realize virtual function the stage implementation should:
 
   - create a new native window handle
-  - if the backend doesn't have a drawing context (either GL or GLES),
-    create one and pass it to the backend
+  - ensure that there is a GL (or GLES) context
+  - make sure that the native window handle is compatible with
+    the GL (or GLES) context
 
 The return value should be TRUE if the stage implementation was successfully
 realized, and FALSE otherwise.