mirror of
https://github.com/hajimehoshi/ebiten.git
synced 2024-12-26 03:38:55 +01:00
236 lines
9.1 KiB
C
236 lines
9.1 KiB
C
// SPDX-License-Identifier: Apache-2.0
|
|
// SPDX-FileCopyrightText: 2023 The Ebitengine Authors
|
|
|
|
//go:build (freebsd || linux || netbsd || openbsd) && wayland
|
|
|
|
// Generated by wayland-scanner 1.18.0
|
|
|
|
#ifndef IDLE_INHIBIT_UNSTABLE_V1_CLIENT_PROTOCOL_H
|
|
#define IDLE_INHIBIT_UNSTABLE_V1_CLIENT_PROTOCOL_H
|
|
|
|
#include <stdint.h>
|
|
#include <stddef.h>
|
|
#include "wayland-client.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* @page page_idle_inhibit_unstable_v1 The idle_inhibit_unstable_v1 protocol
|
|
* @section page_ifaces_idle_inhibit_unstable_v1 Interfaces
|
|
* - @subpage page_iface_zwp_idle_inhibit_manager_v1 - control behavior when display idles
|
|
* - @subpage page_iface_zwp_idle_inhibitor_v1 - context object for inhibiting idle behavior
|
|
* @section page_copyright_idle_inhibit_unstable_v1 Copyright
|
|
* <pre>
|
|
*
|
|
* Copyright © 2015 Samsung Electronics Co., Ltd
|
|
*
|
|
* 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.
|
|
* </pre>
|
|
*/
|
|
struct wl_surface;
|
|
struct zwp_idle_inhibit_manager_v1;
|
|
struct zwp_idle_inhibitor_v1;
|
|
|
|
/**
|
|
* @page page_iface_zwp_idle_inhibit_manager_v1 zwp_idle_inhibit_manager_v1
|
|
* @section page_iface_zwp_idle_inhibit_manager_v1_desc Description
|
|
*
|
|
* This interface permits inhibiting the idle behavior such as screen
|
|
* blanking, locking, and screensaving. The client binds the idle manager
|
|
* globally, then creates idle-inhibitor objects for each surface.
|
|
*
|
|
* Warning! The protocol described in this file is experimental and
|
|
* backward incompatible changes may be made. Backward compatible changes
|
|
* may be added together with the corresponding interface version bump.
|
|
* Backward incompatible changes are done by bumping the version number in
|
|
* the protocol and interface names and resetting the interface version.
|
|
* Once the protocol is to be declared stable, the 'z' prefix and the
|
|
* version number in the protocol and interface names are removed and the
|
|
* interface version number is reset.
|
|
* @section page_iface_zwp_idle_inhibit_manager_v1_api API
|
|
* See @ref iface_zwp_idle_inhibit_manager_v1.
|
|
*/
|
|
/**
|
|
* @defgroup iface_zwp_idle_inhibit_manager_v1 The zwp_idle_inhibit_manager_v1 interface
|
|
*
|
|
* This interface permits inhibiting the idle behavior such as screen
|
|
* blanking, locking, and screensaving. The client binds the idle manager
|
|
* globally, then creates idle-inhibitor objects for each surface.
|
|
*
|
|
* Warning! The protocol described in this file is experimental and
|
|
* backward incompatible changes may be made. Backward compatible changes
|
|
* may be added together with the corresponding interface version bump.
|
|
* Backward incompatible changes are done by bumping the version number in
|
|
* the protocol and interface names and resetting the interface version.
|
|
* Once the protocol is to be declared stable, the 'z' prefix and the
|
|
* version number in the protocol and interface names are removed and the
|
|
* interface version number is reset.
|
|
*/
|
|
extern const struct wl_interface zwp_idle_inhibit_manager_v1_interface;
|
|
/**
|
|
* @page page_iface_zwp_idle_inhibitor_v1 zwp_idle_inhibitor_v1
|
|
* @section page_iface_zwp_idle_inhibitor_v1_desc Description
|
|
*
|
|
* An idle inhibitor prevents the output that the associated surface is
|
|
* visible on from being set to a state where it is not visually usable due
|
|
* to lack of user interaction (e.g. blanked, dimmed, locked, set to power
|
|
* save, etc.) Any screensaver processes are also blocked from displaying.
|
|
*
|
|
* If the surface is destroyed, unmapped, becomes occluded, loses
|
|
* visibility, or otherwise becomes not visually relevant for the user, the
|
|
* idle inhibitor will not be honored by the compositor; if the surface
|
|
* subsequently regains visibility the inhibitor takes effect once again.
|
|
* Likewise, the inhibitor isn't honored if the system was already idled at
|
|
* the time the inhibitor was established, although if the system later
|
|
* de-idles and re-idles the inhibitor will take effect.
|
|
* @section page_iface_zwp_idle_inhibitor_v1_api API
|
|
* See @ref iface_zwp_idle_inhibitor_v1.
|
|
*/
|
|
/**
|
|
* @defgroup iface_zwp_idle_inhibitor_v1 The zwp_idle_inhibitor_v1 interface
|
|
*
|
|
* An idle inhibitor prevents the output that the associated surface is
|
|
* visible on from being set to a state where it is not visually usable due
|
|
* to lack of user interaction (e.g. blanked, dimmed, locked, set to power
|
|
* save, etc.) Any screensaver processes are also blocked from displaying.
|
|
*
|
|
* If the surface is destroyed, unmapped, becomes occluded, loses
|
|
* visibility, or otherwise becomes not visually relevant for the user, the
|
|
* idle inhibitor will not be honored by the compositor; if the surface
|
|
* subsequently regains visibility the inhibitor takes effect once again.
|
|
* Likewise, the inhibitor isn't honored if the system was already idled at
|
|
* the time the inhibitor was established, although if the system later
|
|
* de-idles and re-idles the inhibitor will take effect.
|
|
*/
|
|
extern const struct wl_interface zwp_idle_inhibitor_v1_interface;
|
|
|
|
#define ZWP_IDLE_INHIBIT_MANAGER_V1_DESTROY 0
|
|
#define ZWP_IDLE_INHIBIT_MANAGER_V1_CREATE_INHIBITOR 1
|
|
|
|
|
|
/**
|
|
* @ingroup iface_zwp_idle_inhibit_manager_v1
|
|
*/
|
|
#define ZWP_IDLE_INHIBIT_MANAGER_V1_DESTROY_SINCE_VERSION 1
|
|
/**
|
|
* @ingroup iface_zwp_idle_inhibit_manager_v1
|
|
*/
|
|
#define ZWP_IDLE_INHIBIT_MANAGER_V1_CREATE_INHIBITOR_SINCE_VERSION 1
|
|
|
|
/** @ingroup iface_zwp_idle_inhibit_manager_v1 */
|
|
static inline void
|
|
zwp_idle_inhibit_manager_v1_set_user_data(struct zwp_idle_inhibit_manager_v1 *zwp_idle_inhibit_manager_v1, void *user_data)
|
|
{
|
|
wl_proxy_set_user_data((struct wl_proxy *) zwp_idle_inhibit_manager_v1, user_data);
|
|
}
|
|
|
|
/** @ingroup iface_zwp_idle_inhibit_manager_v1 */
|
|
static inline void *
|
|
zwp_idle_inhibit_manager_v1_get_user_data(struct zwp_idle_inhibit_manager_v1 *zwp_idle_inhibit_manager_v1)
|
|
{
|
|
return wl_proxy_get_user_data((struct wl_proxy *) zwp_idle_inhibit_manager_v1);
|
|
}
|
|
|
|
static inline uint32_t
|
|
zwp_idle_inhibit_manager_v1_get_version(struct zwp_idle_inhibit_manager_v1 *zwp_idle_inhibit_manager_v1)
|
|
{
|
|
return wl_proxy_get_version((struct wl_proxy *) zwp_idle_inhibit_manager_v1);
|
|
}
|
|
|
|
/**
|
|
* @ingroup iface_zwp_idle_inhibit_manager_v1
|
|
*
|
|
* Destroy the inhibit manager.
|
|
*/
|
|
static inline void
|
|
zwp_idle_inhibit_manager_v1_destroy(struct zwp_idle_inhibit_manager_v1 *zwp_idle_inhibit_manager_v1)
|
|
{
|
|
wl_proxy_marshal((struct wl_proxy *) zwp_idle_inhibit_manager_v1,
|
|
ZWP_IDLE_INHIBIT_MANAGER_V1_DESTROY);
|
|
|
|
wl_proxy_destroy((struct wl_proxy *) zwp_idle_inhibit_manager_v1);
|
|
}
|
|
|
|
/**
|
|
* @ingroup iface_zwp_idle_inhibit_manager_v1
|
|
*
|
|
* Create a new inhibitor object associated with the given surface.
|
|
*/
|
|
static inline struct zwp_idle_inhibitor_v1 *
|
|
zwp_idle_inhibit_manager_v1_create_inhibitor(struct zwp_idle_inhibit_manager_v1 *zwp_idle_inhibit_manager_v1, struct wl_surface *surface)
|
|
{
|
|
struct wl_proxy *id;
|
|
|
|
id = wl_proxy_marshal_constructor((struct wl_proxy *) zwp_idle_inhibit_manager_v1,
|
|
ZWP_IDLE_INHIBIT_MANAGER_V1_CREATE_INHIBITOR, &zwp_idle_inhibitor_v1_interface, NULL, surface);
|
|
|
|
return (struct zwp_idle_inhibitor_v1 *) id;
|
|
}
|
|
|
|
#define ZWP_IDLE_INHIBITOR_V1_DESTROY 0
|
|
|
|
|
|
/**
|
|
* @ingroup iface_zwp_idle_inhibitor_v1
|
|
*/
|
|
#define ZWP_IDLE_INHIBITOR_V1_DESTROY_SINCE_VERSION 1
|
|
|
|
/** @ingroup iface_zwp_idle_inhibitor_v1 */
|
|
static inline void
|
|
zwp_idle_inhibitor_v1_set_user_data(struct zwp_idle_inhibitor_v1 *zwp_idle_inhibitor_v1, void *user_data)
|
|
{
|
|
wl_proxy_set_user_data((struct wl_proxy *) zwp_idle_inhibitor_v1, user_data);
|
|
}
|
|
|
|
/** @ingroup iface_zwp_idle_inhibitor_v1 */
|
|
static inline void *
|
|
zwp_idle_inhibitor_v1_get_user_data(struct zwp_idle_inhibitor_v1 *zwp_idle_inhibitor_v1)
|
|
{
|
|
return wl_proxy_get_user_data((struct wl_proxy *) zwp_idle_inhibitor_v1);
|
|
}
|
|
|
|
static inline uint32_t
|
|
zwp_idle_inhibitor_v1_get_version(struct zwp_idle_inhibitor_v1 *zwp_idle_inhibitor_v1)
|
|
{
|
|
return wl_proxy_get_version((struct wl_proxy *) zwp_idle_inhibitor_v1);
|
|
}
|
|
|
|
/**
|
|
* @ingroup iface_zwp_idle_inhibitor_v1
|
|
*
|
|
* Remove the inhibitor effect from the associated wl_surface.
|
|
*/
|
|
static inline void
|
|
zwp_idle_inhibitor_v1_destroy(struct zwp_idle_inhibitor_v1 *zwp_idle_inhibitor_v1)
|
|
{
|
|
wl_proxy_marshal((struct wl_proxy *) zwp_idle_inhibitor_v1,
|
|
ZWP_IDLE_INHIBITOR_V1_DESTROY);
|
|
|
|
wl_proxy_destroy((struct wl_proxy *) zwp_idle_inhibitor_v1);
|
|
}
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif
|