mutter/cogl/cogl/cogl-wayland-server.h
Jonas Ådahl e2f5579391 cogl: Don't undef __INSIDE_COGL_H__ in file not defining it
If you include a file that might define __INSIDE_COGL_H__, don't
undefine it if it wasn't defined in that file. This makes it possible
to include for example cogl-gles2.h from some other file which defines
__INSIDE_COGL_H__.

https://bugzilla.gnome.org/show_bug.cgi?id=768976
2016-07-20 14:23:48 +08:00

164 lines
6.2 KiB
C

/*
* Cogl
*
* A Low Level GPU Graphics and Utilities API
*
* Copyright (C) 2012 Intel Corporation.
*
* 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.
*
*/
#ifndef __COGL_WAYLAND_SERVER_H
#define __COGL_WAYLAND_SERVER_H
#include <wayland-server.h>
/* NB: this is a top-level header that can be included directly but we
* want to be careful not to define __COGL_H_INSIDE__ when this is
* included internally while building Cogl itself since
* __COGL_H_INSIDE__ is used in headers to guard public vs private api
* definitions
*/
#ifndef COGL_COMPILATION
/* Note: When building Cogl .gir we explicitly define
* __COGL_H_INSIDE__ */
#ifndef __COGL_H_INSIDE__
#define __COGL_H_INSIDE__
#define __COGL_MUST_UNDEF_COGL_H_INSIDE_COGL_WAYLAND_SERVER_
#endif
#endif /* COGL_COMPILATION */
#include <cogl/cogl-context.h>
#include <cogl/cogl-texture-2d.h>
COGL_BEGIN_DECLS
/**
* cogl_wayland_display_set_compositor_display:
* @display: a #CoglDisplay
* @wayland_display: A compositor's Wayland display pointer
*
* Informs Cogl of a compositor's Wayland display pointer. This
* enables Cogl to register private wayland extensions required to
* pass buffers between the clients and compositor.
*
* Since: 1.10
* Stability: unstable
*/
void
cogl_wayland_display_set_compositor_display (CoglDisplay *display,
struct wl_display *wayland_display);
/**
* cogl_wayland_texture_2d_new_from_buffer:
* @ctx: A #CoglContext
* @buffer: A Wayland resource for a buffer
* @error: A #CoglError for exceptions
*
* Uploads the @buffer referenced by the given Wayland resource to a
* #CoglTexture2D. The buffer resource may refer to a wl_buffer or a
* wl_shm_buffer.
*
* <note>The results are undefined for passing an invalid @buffer
* pointer</note>
* <note>It is undefined if future updates to @buffer outside the
* control of Cogl will affect the allocated #CoglTexture2D. In some
* cases the contents of the buffer are copied (such as shm buffers),
* and in other cases the underlying storage is re-used directly (such
* as drm buffers)</note>
*
* Returns: A newly allocated #CoglTexture2D, or if Cogl could not
* validate the @buffer in some way (perhaps because of
* an unsupported format) it will return %NULL and set
* @error.
*
* Since: 1.10
* Stability: unstable
*/
CoglTexture2D *
cogl_wayland_texture_2d_new_from_buffer (CoglContext *ctx,
struct wl_resource *buffer,
CoglError **error);
/**
* cogl_wayland_texture_set_region_from_shm_buffer:
* @texture: a #CoglTexture
* @width: The width of the region to copy
* @height: The height of the region to copy
* @shm_buffer: The source buffer
* @src_x: The X offset within the source bufer to copy from
* @src_y: The Y offset within the source bufer to copy from
* @dst_x: The X offset within the texture to copy to
* @dst_y: The Y offset within the texture to copy to
* @level: The mipmap level of the texture to copy to
* @error: A #CoglError to return exceptional errors
*
* Sets the pixels in a rectangular subregion of @texture from a
* Wayland SHM buffer. Generally this would be used in response to
* wl_surface.damage event in a compositor in order to update the
* texture with the damaged region. This is just a convenience wrapper
* around getting the SHM buffer pointer and calling
* cogl_texture_set_region(). See that function for a description of
* the level parameter.
*
* <note>Since the storage for a #CoglTexture is allocated lazily then
* if the given @texture has not previously been allocated then this
* api can return %FALSE and throw an exceptional @error if there is
* not enough memory to allocate storage for @texture.</note>
*
* Return value: %TRUE if the subregion upload was successful, and
* %FALSE otherwise
* Since: 1.18
* Stability: unstable
*/
CoglBool
cogl_wayland_texture_set_region_from_shm_buffer (CoglTexture *texture,
int src_x,
int src_y,
int width,
int height,
struct wl_shm_buffer *
shm_buffer,
int dst_x,
int dst_y,
int level,
CoglError **error);
COGL_END_DECLS
/* The gobject introspection scanner seems to parse public headers in
* isolation which means we need to be extra careful about how we
* define and undefine __COGL_H_INSIDE__ used to detect when internal
* headers are incorrectly included by developers. In the gobject
* introspection case we have to manually define __COGL_H_INSIDE__ as
* a commandline argument for the scanner which means we must be
* careful not to undefine it in a header...
*/
#ifdef __COGL_MUST_UNDEF_COGL_H_INSIDE_COGL_WAYLAND_SERVER_
#undef __COGL_H_INSIDE__
#undef __COGL_MUST_UNDEF_COGL_H_INSIDE_COGL_WAYLAND_SERVER_
#endif
#endif /* __COGL_WAYLAND_SERVER_H */