mirror of
https://github.com/brl/mutter.git
synced 2024-12-02 04:40:43 -05:00
54735dec84
The coding style has for a long time said to avoid using redundant glib
data types such as gint or gchar etc because we feel that they make the
code look unnecessarily foreign to developers coming from outside of the
Gnome developer community.
Note: When we tried to find the historical rationale for the types we
just found that they were apparently only added for consistent syntax
highlighting which didn't seem that compelling.
Up until now we have been continuing to use some of the platform
specific type such as gint{8,16,32,64} and gsize but this patch switches
us over to using the standard c99 equivalents instead so we can further
ensure that our code looks familiar to the widest range of C developers
who might potentially contribute to Cogl.
So instead of using the gint{8,16,32,64} and guint{8,16,32,64} types this
switches all Cogl code to instead use the int{8,16,32,64}_t and
uint{8,16,32,64}_t c99 types instead.
Instead of gsize we now use size_t
For now we are not going to use the c99 _Bool type and instead we have
introduced a new CoglBool type to use instead of gboolean.
Reviewed-by: Neil Roberts <neil@linux.intel.com>
(cherry picked from commit 5967dad2400d32ca6319cef6cb572e81bf2c15f0)
99 lines
3.3 KiB
C
99 lines
3.3 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(CLUTTER_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"
|
|
|
|
G_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 attributes API such as cogl_framebuffer_draw_attributes().
|
|
* 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>
|
|
*/
|
|
|
|
typedef struct _CoglPrimitiveTexture CoglPrimitiveTexture;
|
|
#define COGL_PRIMITIVE_TEXTURE(X) ((CoglPrimitiveTexture *)X)
|
|
|
|
/**
|
|
* 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);
|
|
|
|
G_END_DECLS
|
|
|
|
#endif /* __COGL_PRIMITIVE_TEXTURE_H__ */
|