libweston: change windowed_output_api output_create to create_head

Rename the function pointer to create_head() because that is what it
does on backends that are converted to the head-based API. Update the
documentation to match.

Surprisingly this is not an ABI break, as the function behaviour and
signature remain intact. Hence API_NAME is not bumped.

This is only an API break, and main.c is fixed accordingly.

Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
Reviewed-by: Ian Ray <ian.ray@ge.com>
Reviewed-by: Daniel Stone <daniels@collabora.com>
Acked-by: Derek Foreman <derekf@osg.samsung.com>

diff --git a/compositor/main.c b/compositor/main.c
index 9306cb8..372de49 100644 (file)
--- a/compositor/main.c
+++ b/compositor/main.c
@@ -1384,7 +1384,7 @@ load_headless_backend(struct weston_compositor *c,
                        return -1;
                }
 
-               if (api->output_create(c, "headless") < 0)
+               if (api->create_head(c, "headless") < 0)
                        return -1;
        }
 
@@ -1604,7 +1604,7 @@ load_x11_backend(struct weston_compositor *c,
                        continue;
                }
 
-               if (api->output_create(c, output_name) < 0) {
+               if (api->create_head(c, output_name) < 0) {
                        free(output_name);
                        return -1;
                }
@@ -1620,7 +1620,7 @@ load_x11_backend(struct weston_compositor *c,
                        return -1;
                }
 
-               if (api->output_create(c, default_output) < 0) {
+               if (api->create_head(c, default_output) < 0) {
                        free(default_output);
                        return -1;
                }
@@ -1736,7 +1736,7 @@ load_wayland_backend(struct weston_compositor *c,
                        continue;
                }
 
-               if (api->output_create(c, output_name) < 0) {
+               if (api->create_head(c, output_name) < 0) {
                        free(output_name);
                        return -1;
                }
@@ -1749,7 +1749,7 @@ load_wayland_backend(struct weston_compositor *c,
                if (asprintf(&output_name, "wayland%d", i) < 0)
                        return -1;
 
-               if (api->output_create(c, output_name) < 0) {
+               if (api->create_head(c, output_name) < 0) {
                        free(output_name);
                        return -1;
                }

diff --git a/libweston/windowed-output-api.h b/libweston/windowed-output-api.h
index e0f78b4..388413f 100644 (file)
--- a/libweston/windowed-output-api.h
+++ b/libweston/windowed-output-api.h
@@ -56,23 +56,26 @@ struct weston_windowed_output_api {
        int (*output_set_size)(struct weston_output *output,
                               int width, int height);
 
-       /** Create a new windowed output.
+       /** Create a new windowed head.
         *
         * \param compositor The compositor instance.
-        * \param name       Desired name for a new output.
+        * \param name       Desired name for a new head, not NULL.
         *
         * Returns 0 on success, -1 on failure.
         *
-        * This creates a new output in the backend using this API.
-        * After this function is ran, the created output should be
-        * ready for configuration using the output_configure() and
-        * weston_output_set_{scale,transform}().
+        * This creates a new head in the backend. The new head will
+        * be advertised in the compositor's head list and triggers a
+        * head_changed callback.
         *
-        * An optional name can be assigned to it, so it can be used
-        * by compositor to configure it. It can't be NULL.
+        * A new output can be created for the head. The output must be
+        * configured with output_set_size() and
+        * weston_output_set_{scale,transform}() before enabling it.
+        *
+        * \sa weston_compositor_set_heads_changed_cb(),
+        * weston_compositor_create_output_with_head()
         */
-       int (*output_create)(struct weston_compositor *compositor,
-                            const char *name);
+       int (*create_head)(struct weston_compositor *compositor,
+                          const char *name);
 };
 
 static inline const struct weston_windowed_output_api *