2a6e8bda8d
We currently have mutter set a global frame counter on the frame info in the native backend, but in order to do this from clutter, change the frame info construction from being implicitly done so when swapping buffers to having the caller create the frame info and passing that to the swap buffers call. While this commit doesn't introduce any other changes than the API, the intention is later to have the caller be able to pass it's own state (e.g. the global frame count) along with the frame info. https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/1285
143 lines
4.0 KiB
C
143 lines
4.0 KiB
C
/*
|
|
* Cogl
|
|
*
|
|
* A Low Level GPU Graphics and Utilities API
|
|
*
|
|
* Copyright (C) 2012 Red Hat, Inc.
|
|
*
|
|
* 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 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.
|
|
*
|
|
*
|
|
*
|
|
* Authors:
|
|
* Owen Taylor <otaylor@redhat.com>
|
|
*/
|
|
#if !defined(__COGL_H_INSIDE__) && !defined(COGL_COMPILATION)
|
|
#error "Only <cogl/cogl.h> can be included directly."
|
|
#endif
|
|
|
|
#ifndef __COGL_FRAME_INFO_H
|
|
#define __COGL_FRAME_INFO_H
|
|
|
|
#include <cogl/cogl-types.h>
|
|
#include <cogl/cogl-output.h>
|
|
|
|
#include <glib-object.h>
|
|
#include <glib.h>
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
/**
|
|
* CoglFrameInfo:
|
|
*
|
|
* Frame information.
|
|
*/
|
|
typedef struct _CoglFrameInfo CoglFrameInfo;
|
|
#define COGL_FRAME_INFO(X) ((CoglFrameInfo *)(X))
|
|
|
|
/**
|
|
* cogl_frame_info_get_gtype:
|
|
*
|
|
* Returns: a #GType that can be used with the GLib type system.
|
|
*/
|
|
COGL_EXPORT
|
|
GType cogl_frame_info_get_gtype (void);
|
|
|
|
/**
|
|
* cogl_is_frame_info:
|
|
* @object: A #CoglObject pointer
|
|
*
|
|
* Gets whether the given object references a #CoglFrameInfo.
|
|
*
|
|
* Return value: %TRUE if the object references a #CoglFrameInfo
|
|
* and %FALSE otherwise.
|
|
* Since: 2.0
|
|
* Stability: unstable
|
|
*/
|
|
COGL_EXPORT gboolean
|
|
cogl_is_frame_info (void *object);
|
|
|
|
/**
|
|
* cogl_frame_info_get_frame_counter:
|
|
* @info: a #CoglFrameInfo object
|
|
*
|
|
* Gets the frame counter for the #CoglOnscreen that corresponds
|
|
* to this frame.
|
|
*
|
|
* Return value: The frame counter value
|
|
* Since: 1.14
|
|
* Stability: unstable
|
|
*/
|
|
COGL_EXPORT
|
|
int64_t cogl_frame_info_get_frame_counter (CoglFrameInfo *info);
|
|
|
|
/**
|
|
* cogl_frame_info_get_presentation_time:
|
|
* @info: a #CoglFrameInfo object
|
|
*
|
|
* Gets the presentation time for the frame. This is the time at which
|
|
* the frame became visible to the user.
|
|
*
|
|
* The presentation time measured in nanoseconds, is based on
|
|
* cogl_get_clock_time().
|
|
*
|
|
* <note>Linux kernel version less that 3.8 can result in
|
|
* non-monotonic timestamps being reported when using a drm based
|
|
* OpenGL driver. Also some buggy Mesa drivers up to 9.0.1 may also
|
|
* incorrectly report non-monotonic timestamps.</note>
|
|
*
|
|
* Return value: the presentation time for the frame
|
|
* Since: 1.14
|
|
* Stability: unstable
|
|
*/
|
|
COGL_EXPORT
|
|
int64_t cogl_frame_info_get_presentation_time (CoglFrameInfo *info);
|
|
|
|
/**
|
|
* cogl_frame_info_get_refresh_rate:
|
|
* @info: a #CoglFrameInfo object
|
|
*
|
|
* Gets the refresh rate in Hertz for the output that the frame was on
|
|
* at the time the frame was presented.
|
|
*
|
|
* <note>Some platforms can't associate a #CoglOutput with a
|
|
* #CoglFrameInfo object but are able to report a refresh rate via
|
|
* this api. Therefore if you need this information then this api is
|
|
* more reliable than using cogl_frame_info_get_output() followed by
|
|
* cogl_output_get_refresh_rate().</note>
|
|
*
|
|
* Return value: the refresh rate in Hertz
|
|
* Since: 1.14
|
|
* Stability: unstable
|
|
*/
|
|
COGL_EXPORT
|
|
float cogl_frame_info_get_refresh_rate (CoglFrameInfo *info);
|
|
|
|
/**
|
|
* cogl_frame_info_get_global_frame_counter: (skip)
|
|
*/
|
|
COGL_EXPORT
|
|
int64_t cogl_frame_info_get_global_frame_counter (CoglFrameInfo *info);
|
|
|
|
G_END_DECLS
|
|
|
|
#endif /* __COGL_FRAME_INFO_H */
|