mutter/clutter/clutter/clutter-frame.h
Robert Mader ff246a2dc8 clutter/frame: Add API to query minimal render time of a frame
It will be used to schedule Wayland frame events independently from both
update and presentation time, as the former may happen multiple times
frame and the later not at all.

For frame events we want a timing that is just late enough to ensure
that a following commit by a Wayland client will not get included into
the current frame any more.

Part-of: <https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/2823>
2023-04-17 09:16:10 +00:00

61 lines
1.9 KiB
C

/*
* Copyright (C) 2020 Red Hat Inc.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef CLUTTER_FRAME_H
#define CLUTTER_FRAME_H
#if !defined(__CLUTTER_H_INSIDE__) && !defined(CLUTTER_COMPILATION)
#error "Only <clutter/clutter.h> can be included directly."
#endif
#include "clutter/clutter-frame-clock.h"
typedef struct _ClutterFrame ClutterFrame;
#define CLUTTER_TYPE_FRAME (clutter_frame_get_type ())
CLUTTER_EXPORT
GType clutter_frame_get_type (void);
CLUTTER_EXPORT
ClutterFrame * clutter_frame_ref (ClutterFrame *frame);
CLUTTER_EXPORT
void clutter_frame_unref (ClutterFrame *frame);
CLUTTER_EXPORT
int64_t clutter_frame_get_count (ClutterFrame *frame);
CLUTTER_EXPORT
gboolean clutter_frame_get_target_presentation_time (ClutterFrame *frame,
int64_t *target_presentation_time_us);
CLUTTER_EXPORT
gboolean clutter_frame_get_min_render_time_allowed (ClutterFrame *frame,
int64_t *min_render_time_allowed_us);
CLUTTER_EXPORT
void clutter_frame_set_result (ClutterFrame *frame,
ClutterFrameResult result);
CLUTTER_EXPORT
gboolean clutter_frame_has_result (ClutterFrame *frame);
G_DEFINE_AUTOPTR_CLEANUP_FUNC (ClutterFrame, clutter_frame_unref)
#endif /* CLUTTER_FRAME_H */