mirror of
https://github.com/brl/mutter.git
synced 2024-12-26 12:52:14 +00:00
4c3dadd35e
As part of the on going, incremental effort to purge the non type safe CoglHandle type from the Cogl API this patch tackles most of the CoglHandle uses relating to textures. We'd postponed making this change for quite a while because we wanted to have a clearer understanding of how we wanted to evolve the texture APIs towards Cogl 2.0 before exposing type safety here which would be difficult to change later since it would imply breaking APIs. The basic idea that we are steering towards now is that CoglTexture can be considered to be the most primitive interface we have for any object representing a texture. The texture interface would provide roughly these methods: cogl_texture_get_width cogl_texture_get_height cogl_texture_can_repeat cogl_texture_can_mipmap cogl_texture_generate_mipmap; cogl_texture_get_format cogl_texture_set_region cogl_texture_get_region Besides the texture interface we will then start to expose types corresponding to specific texture types: CoglTexture2D, CoglTexture3D, CoglTexture2DSliced, CoglSubTexture, CoglAtlasTexture and CoglTexturePixmapX11. We will then also expose an interface for the high-level texture types we have (such as CoglTexture2DSlice, CoglSubTexture and CoglAtlasTexture) called CoglMetaTexture. CoglMetaTexture is an additional interface that lets you iterate a virtual region of a meta texture and get mappings of primitive textures to sub-regions of that virtual region. Internally we already have this kind of abstraction for dealing with sliced texture, sub-textures and atlas textures in a consistent way, so this will just make that abstraction public. The aim here is to clarify that there is a difference between primitive textures (CoglTexture2D/3D) and some of the other high-level textures, and also enable developers to implement primitives that can support meta textures since they can only be used with the cogl_rectangle API currently. The thing that's not so clean-cut with this are the texture constructors we have currently; such as cogl_texture_new_from_file which no longer make sense when CoglTexture is considered to be an interface. These will basically just become convenient factory functions and it's just a bit unusual that they are within the cogl_texture namespace. It's worth noting here that all the texture type APIs will also have their own type specific constructors so these functions will only be used for the convenience of being able to create a texture without really wanting to know the details of what type of texture you need. Longer term for 2.0 we may come up with replacement names for these factory functions or the other thing we are considering is designing some asynchronous factory functions instead since it's so often detrimental to application performance to be blocked waiting for a texture to be uploaded to the GPU. Reviewed-by: Neil Roberts <neil@linux.intel.com>
107 lines
3.2 KiB
C
107 lines
3.2 KiB
C
/*
|
|
* Cogl
|
|
*
|
|
* An object oriented GL/GLES Abstraction/Utility Layer
|
|
*
|
|
* Copyright (C) 2007,2008,2009 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(CLUTTER_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>
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
/**
|
|
* SECTION:cogl-offscreen
|
|
* @short_description: Fuctions for creating and manipulating offscreen
|
|
* framebuffers.
|
|
*
|
|
* Cogl allows creating and operating on offscreen framebuffers.
|
|
*/
|
|
|
|
/* 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 does not work with sliced Cogl textures.
|
|
*
|
|
* Return value: (transfer full): a #CoglHandle for the new offscreen
|
|
* buffer or %COGL_INVALID_HANDLE if it wasn't possible to create the
|
|
* buffer.
|
|
*/
|
|
CoglHandle cogl_offscreen_new_to_texture (CoglTexture *texture);
|
|
|
|
/**
|
|
* cogl_is_offscreen:
|
|
* @handle: A CoglHandle for an offscreen buffer
|
|
*
|
|
* Determines whether the given #CoglHandle references an offscreen buffer
|
|
* object.
|
|
*
|
|
* Returns: %TRUE if the handle references an offscreen buffer,
|
|
* %FALSE otherwise
|
|
*/
|
|
gboolean cogl_is_offscreen (CoglHandle handle);
|
|
|
|
#ifndef COGL_DISABLE_DEPRECATED
|
|
|
|
/**
|
|
* cogl_offscreen_ref:
|
|
* @handle: A CoglHandle for an offscreen buffer
|
|
*
|
|
* Increments the reference count on the offscreen buffer.
|
|
*
|
|
* Return value: (transfer none): For convenience it returns the given CoglHandle
|
|
*
|
|
* Deprecated: 1.2: cogl_handle_ref() should be used in new code.
|
|
*/
|
|
CoglHandle cogl_offscreen_ref (CoglHandle handle) G_GNUC_DEPRECATED;
|
|
|
|
/**
|
|
* cogl_offscreen_unref:
|
|
* @handle: A CoglHandle for an offscreen buffer
|
|
*
|
|
* Decreases the reference count for the offscreen buffer and frees it when
|
|
* the count reaches 0.
|
|
*
|
|
* Deprecated: 1.2: cogl_handle_unref() should be used in new code.
|
|
*/
|
|
void cogl_offscreen_unref (CoglHandle handle) G_GNUC_DEPRECATED;
|
|
|
|
#endif /* COGL_DISABLE_DEPRECATED */
|
|
|
|
G_END_DECLS
|
|
|
|
#endif /* __COGL_OFFSCREEN_H__ */
|