mirror of
https://github.com/brl/mutter.git
synced 2024-11-23 16:40:41 -05:00
50cda9fed1
The code that has been deprecated should live into its own directory, both in the repository and when installed. This should make it clear which functionality is actually maintained and which is not. We start with an oldie: the frame source API.
264 lines
8.4 KiB
C
264 lines
8.4 KiB
C
/*
|
|
* Clutter.
|
|
*
|
|
* An OpenGL based 'interactive canvas' library.
|
|
*
|
|
* Authored By Neil Roberts <neil@linux.intel.com>
|
|
*
|
|
* Copyright (C) 2008 OpenedHand
|
|
*
|
|
* 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/>.
|
|
*
|
|
*
|
|
*/
|
|
|
|
#ifdef HAVE_CONFIG_H
|
|
#include "config.h"
|
|
#endif
|
|
|
|
#include "clutter-frame-source.h"
|
|
#include "clutter-timeout-interval.h"
|
|
#include "clutter-private.h"
|
|
|
|
typedef struct _ClutterFrameSource ClutterFrameSource;
|
|
|
|
struct _ClutterFrameSource
|
|
{
|
|
GSource source;
|
|
|
|
ClutterTimeoutInterval timeout;
|
|
};
|
|
|
|
static gboolean clutter_frame_source_prepare (GSource *source,
|
|
gint *timeout);
|
|
static gboolean clutter_frame_source_check (GSource *source);
|
|
static gboolean clutter_frame_source_dispatch (GSource *source,
|
|
GSourceFunc callback,
|
|
gpointer user_data);
|
|
|
|
static GSourceFuncs clutter_frame_source_funcs =
|
|
{
|
|
clutter_frame_source_prepare,
|
|
clutter_frame_source_check,
|
|
clutter_frame_source_dispatch,
|
|
NULL
|
|
};
|
|
|
|
/**
|
|
* clutter_frame_source_add_full:
|
|
* @priority: the priority of the frame source. Typically this will be in the
|
|
* range between %G_PRIORITY_DEFAULT and %G_PRIORITY_HIGH.
|
|
* @fps: the number of times per second to call the function
|
|
* @func: function to call
|
|
* @data: data to pass to the function
|
|
* @notify: function to call when the timeout source is removed
|
|
*
|
|
* Sets a function to be called at regular intervals with the given
|
|
* priority. The function is called repeatedly until it returns
|
|
* %FALSE, at which point the timeout is automatically destroyed and
|
|
* the function will not be called again. The @notify function is
|
|
* called when the timeout is destroyed. The first call to the
|
|
* function will be at the end of the first @interval.
|
|
*
|
|
* This function is similar to g_timeout_add_full() except that it
|
|
* will try to compensate for delays. For example, if @func takes half
|
|
* the interval time to execute then the function will be called again
|
|
* half the interval time after it finished. In contrast
|
|
* g_timeout_add_full() would not fire until a full interval after the
|
|
* function completes so the delay between calls would be 1.0 / @fps *
|
|
* 1.5. This function does not however try to invoke the function
|
|
* multiple times to catch up missing frames if @func takes more than
|
|
* @interval ms to execute.
|
|
*
|
|
* Rename to: clutter_frame_source_add
|
|
*
|
|
* Return value: the ID (greater than 0) of the event source.
|
|
*
|
|
* Since: 0.8
|
|
*
|
|
* Deprecated: 1.6
|
|
*/
|
|
guint
|
|
clutter_frame_source_add_full (gint priority,
|
|
guint fps,
|
|
GSourceFunc func,
|
|
gpointer data,
|
|
GDestroyNotify notify)
|
|
{
|
|
guint ret;
|
|
GSource *source = g_source_new (&clutter_frame_source_funcs,
|
|
sizeof (ClutterFrameSource));
|
|
ClutterFrameSource *frame_source = (ClutterFrameSource *) source;
|
|
|
|
_clutter_timeout_interval_init (&frame_source->timeout, fps);
|
|
|
|
if (priority != G_PRIORITY_DEFAULT)
|
|
g_source_set_priority (source, priority);
|
|
|
|
g_source_set_name (source, "Clutter frame timeout");
|
|
g_source_set_callback (source, func, data, notify);
|
|
|
|
ret = g_source_attach (source, NULL);
|
|
|
|
g_source_unref (source);
|
|
|
|
return ret;
|
|
}
|
|
|
|
/**
|
|
* clutter_frame_source_add: (skip)
|
|
* @fps: the number of times per second to call the function
|
|
* @func: function to call
|
|
* @data: data to pass to the function
|
|
*
|
|
* Simple wrapper around clutter_frame_source_add_full().
|
|
*
|
|
* Return value: the ID (greater than 0) of the event source.
|
|
*
|
|
* Since: 0.8
|
|
*
|
|
* Deprecated: 1.6
|
|
*/
|
|
guint
|
|
clutter_frame_source_add (guint fps,
|
|
GSourceFunc func,
|
|
gpointer data)
|
|
{
|
|
return clutter_frame_source_add_full (G_PRIORITY_DEFAULT,
|
|
fps, func, data, NULL);
|
|
}
|
|
|
|
static gboolean
|
|
clutter_frame_source_prepare (GSource *source,
|
|
gint *delay)
|
|
{
|
|
ClutterFrameSource *frame_source = (ClutterFrameSource *) source;
|
|
gint64 current_time;
|
|
|
|
#if GLIB_CHECK_VERSION (2, 27, 3)
|
|
current_time = g_source_get_time (source) / 1000;
|
|
#else
|
|
{
|
|
GTimeVal source_time;
|
|
g_source_get_current_time (source, &source_time);
|
|
current_time = source_time.tv_sec * 1000 + source_time.tv_usec / 1000;
|
|
}
|
|
#endif
|
|
|
|
return _clutter_timeout_interval_prepare (current_time,
|
|
&frame_source->timeout,
|
|
delay);
|
|
}
|
|
|
|
static gboolean
|
|
clutter_frame_source_check (GSource *source)
|
|
{
|
|
return clutter_frame_source_prepare (source, NULL);
|
|
}
|
|
|
|
static gboolean
|
|
clutter_frame_source_dispatch (GSource *source,
|
|
GSourceFunc callback,
|
|
gpointer user_data)
|
|
{
|
|
ClutterFrameSource *frame_source = (ClutterFrameSource *) source;
|
|
|
|
return _clutter_timeout_interval_dispatch (&frame_source->timeout,
|
|
callback, user_data);
|
|
}
|
|
|
|
/**
|
|
* clutter_threads_add_frame_source_full:
|
|
* @priority: the priority of the frame source. Typically this will be in the
|
|
* range between %G_PRIORITY_DEFAULT and %G_PRIORITY_HIGH.
|
|
* @fps: the number of times per second to call the function
|
|
* @func: function to call
|
|
* @data: data to pass to the function
|
|
* @notify: function to call when the timeout source is removed
|
|
*
|
|
* Sets a function to be called at regular intervals holding the Clutter
|
|
* threads lock, with the given priority. The function is called repeatedly
|
|
* until it returns %FALSE, at which point the timeout is automatically
|
|
* removed and the function will not be called again. The @notify function
|
|
* is called when the timeout is removed.
|
|
*
|
|
* This function is similar to clutter_threads_add_timeout_full()
|
|
* except that it will try to compensate for delays. For example, if
|
|
* @func takes half the interval time to execute then the function
|
|
* will be called again half the interval time after it finished. In
|
|
* contrast clutter_threads_add_timeout_full() would not fire until a
|
|
* full interval after the function completes so the delay between
|
|
* calls would be @interval * 1.5. This function does not however try
|
|
* to invoke the function multiple times to catch up missing frames if
|
|
* @func takes more than @interval ms to execute.
|
|
*
|
|
* See also clutter_threads_add_idle_full().
|
|
*
|
|
* Rename to: clutter_threads_add_frame_source
|
|
*
|
|
* Return value: the ID (greater than 0) of the event source.
|
|
*
|
|
* Since: 0.8
|
|
*
|
|
* Deprecated: 1.6
|
|
*/
|
|
guint
|
|
clutter_threads_add_frame_source_full (gint priority,
|
|
guint fps,
|
|
GSourceFunc func,
|
|
gpointer data,
|
|
GDestroyNotify notify)
|
|
{
|
|
ClutterThreadsDispatch *dispatch;
|
|
|
|
g_return_val_if_fail (func != NULL, 0);
|
|
|
|
dispatch = g_slice_new (ClutterThreadsDispatch);
|
|
dispatch->func = func;
|
|
dispatch->data = data;
|
|
dispatch->notify = notify;
|
|
|
|
return clutter_frame_source_add_full (priority,
|
|
fps,
|
|
_clutter_threads_dispatch, dispatch,
|
|
_clutter_threads_dispatch_free);
|
|
}
|
|
|
|
/**
|
|
* clutter_threads_add_frame_source: (skip)
|
|
* @fps: the number of times per second to call the function
|
|
* @func: function to call
|
|
* @data: data to pass to the function
|
|
*
|
|
* Simple wrapper around clutter_threads_add_frame_source_full().
|
|
*
|
|
* Return value: the ID (greater than 0) of the event source.
|
|
*
|
|
* Since: 0.8
|
|
*
|
|
* Deprecated: 1.6
|
|
*/
|
|
guint
|
|
clutter_threads_add_frame_source (guint fps,
|
|
GSourceFunc func,
|
|
gpointer data)
|
|
{
|
|
g_return_val_if_fail (func != NULL, 0);
|
|
|
|
return clutter_threads_add_frame_source_full (G_PRIORITY_DEFAULT,
|
|
fps,
|
|
func, data,
|
|
NULL);
|
|
}
|