bb5af3a6bd
They are no longer useful since the merge of cogl inside mutter Part-of: <https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/2708>
126 lines
4.3 KiB
C
126 lines
4.3 KiB
C
/*
|
|
* Cogl
|
|
*
|
|
* A Low Level GPU Graphics and Utilities API
|
|
*
|
|
* Copyright (C) 2012 Collabora 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 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.
|
|
*
|
|
*
|
|
*/
|
|
|
|
#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.
|
|
*/
|
|
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.
|
|
*/
|
|
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.
|
|
*/
|
|
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.
|
|
*/
|
|
COGL_EXPORT void *
|
|
cogl_fence_closure_get_user_data (CoglFenceClosure *closure);
|
|
|
|
/**
|
|
* cogl_framebuffer_add_fence_callback:
|
|
* @framebuffer: The #CoglFramebuffer the commands have been submitted to
|
|
* @callback: (scope notified): A #CoglFenceCallback to be called when
|
|
* all commands submitted to Cogl have been executed
|
|
* @user_data: (closure): 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.
|
|
*/
|
|
COGL_EXPORT 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.
|
|
*/
|
|
COGL_EXPORT void
|
|
cogl_framebuffer_cancel_fence_callback (CoglFramebuffer *framebuffer,
|
|
CoglFenceClosure *closure);
|
|
|
|
#endif /* __COGL_FENCE_H__ */
|