mirror of
https://github.com/brl/mutter.git
synced 2024-11-25 17:40:40 -05:00
afbb13e1a4
This adds compiler symbol deprecation declarations for old Cogl APIs so that users can easily see via compiler warning when they are using these symbols, and also see a hint for what the apis should be replaced with. So that users of Cogl can manage when to show these warnings this introduces a scheme borrowed from glib whereby you can declare what version of the Cogl api you are using: COGL_VERSION_MIN_REQUIRED can be defined to indicate the oldest Cogl api that the application wants to use. Cogl will only warn about deprecations for symbols that were deprecated earlier than this required version. If this is left undefined then by default Cogl will warn about all deprecations. COGL_VERSION_MAX_ALLOWED can be defined to indicate the newest api that the application uses. If the application uses symbols newer than this then Cogl will give a warning about that. This patch removes the need to maintain the COGL_DISABLE_DEPRECATED guards around deprecated symbols. This patch fixes a few uses of deprecated symbols in the examples/ Reviewed-by: Neil Roberts <neil@linux.intel.com>
114 lines
3.3 KiB
C
114 lines
3.3 KiB
C
/*
|
|
* Cogl
|
|
*
|
|
* An object oriented GL/GLES Abstraction/Utility Layer
|
|
*
|
|
* Copyright (C) 2007,2008,2009,2012 Intel Corporation.
|
|
*
|
|
* 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_OFFSCREEN_H__
|
|
#define __COGL_OFFSCREEN_H__
|
|
|
|
#include <cogl/cogl-types.h>
|
|
#include <cogl/cogl-texture.h>
|
|
|
|
COGL_BEGIN_DECLS
|
|
|
|
/**
|
|
* SECTION:cogl-offscreen
|
|
* @short_description: Functions for creating and manipulating offscreen
|
|
* framebuffers.
|
|
*
|
|
* Cogl allows creating and operating on offscreen framebuffers.
|
|
*/
|
|
|
|
typedef struct _CoglOffscreen CoglOffscreen;
|
|
|
|
#define COGL_OFFSCREEN(X) ((CoglOffscreen *)X)
|
|
|
|
/* Offscreen api */
|
|
|
|
/**
|
|
* cogl_offscreen_new_to_texture:
|
|
* @texture: A #CoglTexture pointer
|
|
*
|
|
* This creates an offscreen buffer object using the given @texture as the
|
|
* primary color buffer. It doesn't just initialize the contents of the
|
|
* offscreen buffer with the @texture; they are tightly bound so that
|
|
* drawing to the offscreen buffer effectivly updates the contents of the
|
|
* given texture. You don't need to destroy the offscreen buffer before
|
|
* you can use the @texture again.
|
|
*
|
|
* <note>This only works with low-level #CoglTexture types such as
|
|
* #CoglTexture2D, #CoglTexture3D and #CoglTextureRectangle, and not
|
|
* with meta-texture types such as #CoglTexture2DSliced.</note>
|
|
*
|
|
* Return value: (transfer full): a newly instantiated #CoglOffscreen
|
|
* framebuffer or %NULL if it wasn't possible to create the
|
|
* buffer.
|
|
*/
|
|
CoglOffscreen *
|
|
cogl_offscreen_new_to_texture (CoglTexture *texture);
|
|
|
|
/**
|
|
* cogl_is_offscreen:
|
|
* @object: A pointer to a #CoglObject
|
|
*
|
|
* Determines whether the given #CoglObject references an offscreen
|
|
* framebuffer object.
|
|
*
|
|
* Returns: %TRUE if @object is a #CoglOffscreen framebuffer,
|
|
* %FALSE otherwise
|
|
*/
|
|
CoglBool
|
|
cogl_is_offscreen (void *object);
|
|
|
|
/**
|
|
* cogl_offscreen_ref:
|
|
* @offscreen: A pointer to a #CoglOffscreen framebuffer
|
|
*
|
|
* Increments the reference count on the @offscreen framebuffer.
|
|
*
|
|
* Return value: (transfer none): For convenience it returns the
|
|
* given @offscreen
|
|
*
|
|
* Deprecated: 1.2: cogl_object_ref() should be used in new code.
|
|
*/
|
|
void *
|
|
cogl_offscreen_ref (void *offscreen) COGL_DEPRECATED_FOR (cogl_object_ref);
|
|
|
|
/**
|
|
* cogl_offscreen_unref:
|
|
* @offscreen: A pointer to a #CoglOffscreen framebuffer
|
|
*
|
|
* Decreases the reference count for the @offscreen buffer and frees it when
|
|
* the count reaches 0.
|
|
*
|
|
* Deprecated: 1.2: cogl_object_unref() should be used in new code.
|
|
*/
|
|
void
|
|
cogl_offscreen_unref (void *offscreen) COGL_DEPRECATED_FOR (cogl_object_unref);
|
|
|
|
COGL_END_DECLS
|
|
|
|
#endif /* __COGL_OFFSCREEN_H__ */
|