mirror of
https://github.com/brl/mutter.git
synced 2024-11-22 08:00:42 -05:00
6436cd073d
This declares the interface types CoglFramebuffer, CoglBuffer, CoglTexture, CoglMetaTexture and CoglPrimitiveTexture as void when including the public cogl.h header so that users don't have to use lots of C type casts between instance types and interface types. This also removes all of the COGL_XYZ() type cast macros since they do nothing more than compile time type casting but it's less readable if you haven't seen that coding pattern before. Unlike with gobject based apis that use per-type macros for casting and performing runtime type checking we instead prefer to do our runtime type checking internally within the front-end public apis when objects are passed into Cogl. This greatly reduces the verbosity for users of the api and may help reduce the chance of excessive runtime type checking that can sometimes be a problem. (cherry picked from commit 248a76f5eac7e5ae4fb45208577f9a55360812a7) Since we can't break the 1.x api this version of the patch actually defines compatible NOP macros within deprecated/cogl-type-casts.h
106 lines
3.5 KiB
C
106 lines
3.5 KiB
C
/*
|
|
* Cogl
|
|
*
|
|
* An object oriented GL/GLES Abstraction/Utility Layer
|
|
*
|
|
* Copyright (C) 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_PRIMITIVE_TEXTURE_H__
|
|
#define __COGL_PRIMITIVE_TEXTURE_H__
|
|
|
|
#include "cogl-types.h"
|
|
|
|
COGL_BEGIN_DECLS
|
|
|
|
/**
|
|
* SECTION:cogl-primitive-texture
|
|
* @short_description: Interface for low-level textures like
|
|
* #CoglTexture2D and #CoglTexture3D.
|
|
*
|
|
* A #CoglPrimitiveTexture is a texture that is directly represented
|
|
* by a single texture on the GPU. For example these could be a
|
|
* #CoglTexture2D, #CoglTexture3D or #CoglTextureRectangle. This is
|
|
* opposed to high level meta textures which may be composed of
|
|
* multiple primitive textures or a sub-region of another texture such
|
|
* as #CoglAtlasTexture and #CoglTexture2DSliced.
|
|
*
|
|
* A texture that implements this interface can be directly used with
|
|
* the low level cogl_primitive_draw() API. Other types of textures
|
|
* need to be first resolved to primitive textures using the
|
|
* #CoglMetaTexture interface.
|
|
*
|
|
* <note>Most developers won't need to use this interface directly but
|
|
* still it is worth understanding the distinction between high-level
|
|
* and primitive textures because you may find other references in the
|
|
* documentation that detail limitations of using
|
|
* primitive textures.</note>
|
|
*/
|
|
|
|
#ifdef __COGL_H_INSIDE__
|
|
/* For the public C api we typedef interface types as void to avoid needing
|
|
* lots of casting in code and instead we will rely on runtime type checking
|
|
* for these objects. */
|
|
typedef void CoglPrimitiveTexture;
|
|
#else
|
|
typedef struct _CoglPrimitiveTexture CoglPrimitiveTexture;
|
|
#define COGL_PRIMITIVE_TEXTURE(X) ((CoglPrimitiveTexture *)X)
|
|
#endif
|
|
|
|
/**
|
|
* cogl_is_primitive_texture:
|
|
* @object: A #CoglObject pointer
|
|
*
|
|
* Gets whether the given object references a primitive texture object.
|
|
*
|
|
* Return value: %TRUE if the pointer references a primitive texture, and
|
|
* %FALSE otherwise
|
|
* Since: 2.0
|
|
* Stability: unstable
|
|
*/
|
|
CoglBool
|
|
cogl_is_primitive_texture (void *object);
|
|
|
|
/**
|
|
* cogl_primitive_texture_set_auto_mipmap:
|
|
* @primitive_texture: A #CoglPrimitiveTexture
|
|
* @value: The new value for whether to auto mipmap
|
|
*
|
|
* Sets whether the texture will automatically update the smaller
|
|
* mipmap levels after any part of level 0 is updated. The update will
|
|
* only occur whenever the texture is used for drawing with a texture
|
|
* filter that requires the lower mipmap levels. An application should
|
|
* disable this if it wants to upload its own data for the other
|
|
* levels. By default auto mipmapping is enabled.
|
|
*
|
|
* Since: 2.0
|
|
* Stability: unstable
|
|
*/
|
|
void
|
|
cogl_primitive_texture_set_auto_mipmap (CoglPrimitiveTexture *primitive_texture,
|
|
CoglBool value);
|
|
|
|
COGL_END_DECLS
|
|
|
|
#endif /* __COGL_PRIMITIVE_TEXTURE_H__ */
|