137 lines
4.1 KiB
C
137 lines
4.1 KiB
C
|
/*
|
||
|
|
* Cogl
|
||
|
|
*
|
||
|
|
* An object oriented GL/GLES Abstraction/Utility Layer
|
||
|
|
*
|
||
|
|
* Copyright (C) 2012 Collabora Ltd.
|
||
|
|
*
|
||
|
|
* 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/>.
|
||
|
|
*
|
||
|
|
*
|
||
|
|
*/
|
||
|
|
|
||
|
|
#if !defined(__COGL_H_INSIDE__) && !defined(COGL_COMPILATION)
|
||
|
|
#error "Only <cogl/cogl.h> can be included directly."
|
||
|
|
#endif
|
||
|
|
|
||
|
|
#ifndef __COGL_FENCE_H__
|
||
|
|
#define __COGL_FENCE_H__
|
||
|
|
|
||
|
|
#include <cogl/cogl-types.h>
|
||
|
|
#include <cogl/cogl-framebuffer.h>
|
||
|
|
|
||
|
|
/**
|
||
|
|
* SECTION:cogl-fence
|
||
|
|
* @short_description: Functions for notification of command completion
|
||
|
|
*
|
||
|
|
* Cogl allows notification of GPU command completion; users may mark
|
||
|
|
* points in the GPU command stream and receive notification when the GPU
|
||
|
|
* has executed to that point.
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* CoglFence:
|
||
|
|
*
|
||
|
|
* An opaque object representing a fence. This type is currently
|
||
|
|
* unused but in the future may be used to pass extra information
|
||
|
|
* about the fence completion.
|
||
|
|
*
|
||
|
|
* Since: 2.0
|
||
|
|
* Stability: Unstable
|
||
|
|
*/
|
||
|
|
typedef struct _CoglFence CoglFence;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* CoglFenceCallback:
|
||
|
|
* @fence: Unused. In the future this parameter may be used to pass
|
||
|
|
* extra information about the fence completion but for now it
|
||
|
|
* should be ignored.
|
||
|
|
* @user_data: The private data passed to cogl_framebuffer_add_fence_callback()
|
||
|
|
*
|
||
|
|
* The callback prototype used with
|
||
|
|
* cogl_framebuffer_add_fence_callback() for notification of GPU
|
||
|
|
* command completion.
|
||
|
|
*
|
||
|
|
* Since: 2.0
|
||
|
|
* Stability: Unstable
|
||
|
|
*/
|
||
|
|
typedef void (* CoglFenceCallback) (CoglFence *fence,
|
||
|
|
void *user_data);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* CoglFenceClosure:
|
||
|
|
*
|
||
|
|
* An opaque type representing one future callback to be made when the
|
||
|
|
* GPU command stream has passed a certain point.
|
||
|
|
*
|
||
|
|
* Since: 2.0
|
||
|
|
* Stability: Unstable
|
||
|
|
*/
|
||
|
|
typedef struct _CoglFenceClosure CoglFenceClosure;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* cogl_frame_closure_get_user_data:
|
||
|
|
* @closure: A #CoglFenceClosure returned from cogl_framebuffer_add_fence()
|
||
|
|
*
|
||
|
|
* Returns the user_data submitted to cogl_framebuffer_add_fence() which
|
||
|
|
* returned a given #CoglFenceClosure.
|
||
|
|
*
|
||
|
|
* Since: 2.0
|
||
|
|
* Stability: Unstable
|
||
|
|
*/
|
||
|
|
void *
|
||
|
|
cogl_fence_closure_get_user_data (CoglFenceClosure *closure);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* cogl_framebuffer_add_fence_callback:
|
||
|
|
* @framebuffer: The #CoglFramebuffer the commands have been submitted to
|
||
|
|
* @callback: A #CoglFenceCallback to be called when all commands submitted
|
||
|
|
* to Cogl have been executed
|
||
|
|
* @user_data: Private data that will be passed to the callback
|
||
|
|
*
|
||
|
|
* Calls the provided callback when all previously-submitted commands have
|
||
|
|
* been executed by the GPU.
|
||
|
|
*
|
||
|
|
* Returns non-NULL if the fence succeeded, or %NULL if it was unable to
|
||
|
|
* be inserted and the callback will never be called. The user does not
|
||
|
|
* need to free the closure; it will be freed automatically when the
|
||
|
|
* callback is called, or cancelled.
|
||
|
|
*
|
||
|
|
* Since: 2.0
|
||
|
|
* Stability: Unstable
|
||
|
|
*/
|
||
|
|
CoglFenceClosure *
|
||
|
|
cogl_framebuffer_add_fence_callback (CoglFramebuffer *framebuffer,
|
||
|
|
CoglFenceCallback callback,
|
||
|
|
void *user_data);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* cogl_framebuffer_cancel_fence_callback:
|
||
|
|
* @framebuffer: The #CoglFramebuffer the commands were submitted to
|
||
|
|
* @closure: The #CoglFenceClosure returned from
|
||
|
|
* cogl_framebuffer_add_fence_callback()
|
||
|
|
*
|
||
|
|
* Removes a fence previously submitted with
|
||
|
|
* cogl_framebuffer_add_fence_callback(); the callback will not be
|
||
|
|
* called.
|
||
|
|
*
|
||
|
|
* Since: 2.0
|
||
|
|
* Stability: Unstable
|
||
|
|
*/
|
||
|
|
void
|
||
|
|
cogl_framebuffer_cancel_fence_callback (CoglFramebuffer *framebuffer,
|
||
|
|
CoglFenceClosure *closure);
|
||
|
|
|
||
|
|
#endif /* __COGL_FENCE_H__ */
|