weston/ivi-shell/ivi-layout-private.h
Michael Olbrich a3a8431634 ivi-layout: simplify API
Use assert() to check for invalid NULL arguments. Something like that happens
during development and assert() makes it easier to find the error. And it avoids
unnecessary additional error handling.
The hmi-controller asserted anyways so this just moves the assert on level
deeper. Other controller probably do the same thing, or don't check the return
values at all.

Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
2023-04-19 09:38:09 +03:00

227 lines
6.5 KiB
C

/*
* Copyright (C) 2014 DENSO 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 (including the
* next paragraph) 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 _ivi_layout_PRIVATE_H_
#define _ivi_layout_PRIVATE_H_
#include <stdint.h>
#include <libweston/libweston.h>
#include "ivi-layout-export.h"
#include <libweston/desktop.h>
struct ivi_layout_view {
struct wl_list link; /* ivi_layout::view_list */
struct wl_list surf_link; /*ivi_layout_surface::view_list */
struct wl_list pending_link; /* ivi_layout_layer::pending.view_list */
struct wl_list order_link; /* ivi_layout_layer::order.view_list */
struct weston_view *view;
struct weston_transform transform;
struct ivi_layout_surface *ivisurf;
struct ivi_layout_layer *on_layer;
};
struct ivi_layout_surface {
struct wl_list link; /* ivi_layout::surface_list */
struct wl_signal property_changed;
int32_t update_count;
uint32_t id_surface;
struct ivi_layout *layout;
struct weston_surface *surface;
struct weston_desktop_surface *weston_desktop_surface;
struct ivi_layout_view *ivi_view;
struct ivi_layout_surface_properties prop;
struct {
struct ivi_layout_surface_properties prop;
} pending;
struct wl_list view_list; /* ivi_layout_view::surf_link */
};
struct ivi_layout_layer {
struct wl_list link; /* ivi_layout::layer_list */
struct wl_signal property_changed;
uint32_t id_layer;
struct ivi_layout *layout;
struct ivi_layout_screen *on_screen;
struct ivi_layout_layer_properties prop;
struct {
struct ivi_layout_layer_properties prop;
struct wl_list view_list; /* ivi_layout_view::pending_link */
struct wl_list link; /* ivi_layout_screen::pending.layer_list */
} pending;
struct {
int dirty;
struct wl_list view_list; /* ivi_layout_view::order_link */
struct wl_list link; /* ivi_layout_screen::order.layer_list */
} order;
int32_t ref_count;
};
struct ivi_layout {
struct ivi_shell *shell;
struct wl_list surface_list; /* ivi_layout_surface::link */
struct wl_list layer_list; /* ivi_layout_layer::link */
struct wl_list screen_list; /* ivi_layout_screen::link */
struct wl_list view_list; /* ivi_layout_view::link */
struct {
struct wl_signal destroy_signal;
} shell_notification;
struct {
struct wl_signal created;
struct wl_signal removed;
} layer_notification;
struct {
struct wl_signal created;
struct wl_signal removed;
struct wl_signal configure_changed;
struct wl_signal configure_desktop_changed;
} surface_notification;
struct {
struct wl_signal configure_changed;
struct wl_signal show;
struct wl_signal hide;
struct wl_signal update;
} input_panel_notification;
struct weston_layer layout_layer;
struct ivi_layout_transition_set *transitions;
struct wl_list pending_transition_list; /* transition_node::link */
struct wl_listener output_created;
struct wl_listener output_destroyed;
struct {
struct ivi_layout_surface *ivisurf;
pixman_box32_t cursor_rectangle;
} text_input;
};
struct ivi_layout *get_instance(void);
struct ivi_layout_transition;
struct ivi_layout_transition_set {
struct wl_event_source *event_source;
struct wl_list transition_list;
};
typedef void (*ivi_layout_transition_destroy_user_func)(void *user_data);
struct ivi_layout_transition_set *
ivi_layout_transition_set_create(struct weston_compositor *ec);
void
ivi_layout_transition_move_resize_view(struct ivi_layout_surface *surface,
int32_t dest_x, int32_t dest_y,
int32_t dest_width, int32_t dest_height,
uint32_t duration);
void
ivi_layout_transition_visibility_on(struct ivi_layout_surface *surface,
uint32_t duration);
void
ivi_layout_transition_visibility_off(struct ivi_layout_surface *surface,
uint32_t duration);
void
ivi_layout_transition_move_layer(struct ivi_layout_layer *layer,
int32_t dest_x, int32_t dest_y,
uint32_t duration);
void
ivi_layout_transition_fade_layer(struct ivi_layout_layer *layer,
uint32_t is_fade_in,
double start_alpha, double end_alpha,
void *user_data,
ivi_layout_transition_destroy_user_func destroy_func,
uint32_t duration);
int32_t
is_surface_transition(struct ivi_layout_surface *surface);
void
ivi_layout_remove_all_surface_transitions(struct ivi_layout_surface *surface);
/**
* methods of interaction between transition animation with ivi-layout
*/
int32_t
ivi_layout_commit_changes(void);
uint32_t
ivi_layout_get_id_of_surface(struct ivi_layout_surface *ivisurf);
void
ivi_layout_surface_set_destination_rectangle(struct ivi_layout_surface *ivisurf,
int32_t x, int32_t y,
int32_t width, int32_t height);
int32_t
ivi_layout_surface_set_opacity(struct ivi_layout_surface *ivisurf,
wl_fixed_t opacity);
void
ivi_layout_surface_set_visibility(struct ivi_layout_surface *ivisurf,
bool newVisibility);
void
ivi_layout_surface_set_size(struct ivi_layout_surface *ivisurf,
int32_t width, int32_t height);
struct ivi_layout_surface *
ivi_layout_get_surface_from_id(uint32_t id_surface);
int32_t
ivi_layout_layer_set_opacity(struct ivi_layout_layer *ivilayer,
wl_fixed_t opacity);
void
ivi_layout_layer_set_visibility(struct ivi_layout_layer *ivilayer,
bool newVisibility);
void
ivi_layout_layer_set_destination_rectangle(struct ivi_layout_layer *ivilayer,
int32_t x, int32_t y,
int32_t width, int32_t height);
void
ivi_layout_layer_set_render_order(struct ivi_layout_layer *ivilayer,
struct ivi_layout_surface **pSurface,
int32_t number);
void
ivi_layout_transition_move_layer_cancel(struct ivi_layout_layer *layer);
#endif