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>
This commit is contained in:
Pekka Paalanen
2017-10-12 15:03:42 +03:00
parent 1394ac303e
commit e868c3fc15
2 changed files with 18 additions and 15 deletions
+13 -10
View File
@@ -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 *