2011-05-16 23:05:54 +00:00
|
|
|
/*
|
|
|
|
* Cogl
|
|
|
|
*
|
|
|
|
* An object oriented GL/GLES Abstraction/Utility Layer
|
|
|
|
*
|
|
|
|
* Copyright (C) 2011 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/>.
|
|
|
|
*
|
|
|
|
*
|
|
|
|
* Authors:
|
|
|
|
* Robert Bragg <robert@linux.intel.com>
|
|
|
|
*/
|
|
|
|
|
2012-06-20 17:49:08 +00:00
|
|
|
#if !defined(__COGL_H_INSIDE__) && !defined(COGL_COMPILATION)
|
2012-03-20 13:21:18 +00:00
|
|
|
#error "Only <cogl/cogl.h> can be included directly."
|
|
|
|
#endif
|
|
|
|
|
2012-07-31 14:12:01 +00:00
|
|
|
#ifndef __COGL_TEXTURE_2D_H
|
|
|
|
#define __COGL_TEXTURE_2D_H
|
2011-05-16 23:05:54 +00:00
|
|
|
|
2011-06-13 17:52:20 +00:00
|
|
|
#include "cogl-context.h"
|
2012-09-10 20:45:33 +00:00
|
|
|
#include "cogl-bitmap.h"
|
2011-06-13 17:52:20 +00:00
|
|
|
|
2011-05-16 23:05:54 +00:00
|
|
|
#include <glib.h>
|
|
|
|
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
|
|
|
|
/**
|
|
|
|
* SECTION:cogl-texture-2d
|
|
|
|
* @short_description: Functions for creating and manipulating 2D textures
|
|
|
|
*
|
|
|
|
* These functions allow low-level 2D textures to be allocated. These
|
|
|
|
* differ from sliced textures for example which may internally be
|
|
|
|
* made up of multiple 2D textures, or atlas textures where Cogl must
|
|
|
|
* internally modify user texture coordinates before they can be used
|
|
|
|
* by the GPU.
|
|
|
|
*
|
|
|
|
* You should be aware that many GPUs only support power of two sizes
|
|
|
|
* for #CoglTexture2D textures. You can check support for non power of
|
2011-10-12 21:31:12 +00:00
|
|
|
* two textures by checking for the %COGL_FEATURE_ID_TEXTURE_NPOT feature
|
|
|
|
* via cogl_has_feature().
|
2011-05-16 23:05:54 +00:00
|
|
|
*/
|
|
|
|
|
|
|
|
typedef struct _CoglTexture2D CoglTexture2D;
|
|
|
|
#define COGL_TEXTURE_2D(X) ((CoglTexture2D *)X)
|
|
|
|
|
|
|
|
/**
|
|
|
|
* cogl_is_texture_2d:
|
|
|
|
* @object: A #CoglObject
|
|
|
|
*
|
|
|
|
* Gets whether the given object references an existing #CoglTexture2D
|
|
|
|
* object.
|
|
|
|
*
|
|
|
|
* Return value: %TRUE if the object references a #CoglTexture2D,
|
|
|
|
* %FALSE otherwise
|
|
|
|
*/
|
Switch use of primitive glib types to c99 equivalents
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)
2012-04-16 20:56:40 +00:00
|
|
|
CoglBool
|
2011-05-16 23:05:54 +00:00
|
|
|
cogl_is_texture_2d (void *object);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* cogl_texture_2d_new_with_size:
|
|
|
|
* @ctx: A #CoglContext
|
|
|
|
* @width: Width of the texture to allocate
|
|
|
|
* @height: Height of the texture to allocate
|
|
|
|
* @internal_format: The format of the texture
|
2012-08-31 18:28:27 +00:00
|
|
|
* @error: A #CoglError for exceptions
|
2011-05-16 23:05:54 +00:00
|
|
|
*
|
|
|
|
* Allocates a low-level #CoglTexture2D texture that your GPU can
|
|
|
|
* texture from directly. This is unlike sliced textures for example
|
|
|
|
* which may be comprised of multiple internal textures, or atlas
|
|
|
|
* textures where Cogl has to modify texture coordinates before they
|
|
|
|
* may be used by the GPU.
|
|
|
|
*
|
|
|
|
* <note>Many GPUs only support power of two sizes for #CoglTexture2D
|
|
|
|
* textures. You can check support for non power of two textures by
|
2011-10-12 21:31:12 +00:00
|
|
|
* checking for the %COGL_FEATURE_ID_TEXTURE_NPOT feature via
|
|
|
|
* cogl_has_feature().</note>
|
2011-05-16 23:05:54 +00:00
|
|
|
*
|
|
|
|
* Returns: A newly allocated #CoglTexture2D, or if the size is not
|
|
|
|
* supported (because it is too large or a non-power-of-two
|
|
|
|
* size that the hardware doesn't support) it will return
|
|
|
|
* %NULL and set @error.
|
|
|
|
*
|
|
|
|
* Since: 2.0
|
|
|
|
*/
|
|
|
|
CoglTexture2D *
|
|
|
|
cogl_texture_2d_new_with_size (CoglContext *ctx,
|
|
|
|
int width,
|
|
|
|
int height,
|
|
|
|
CoglPixelFormat internal_format,
|
2012-08-31 18:28:27 +00:00
|
|
|
CoglError **error);
|
2011-05-16 23:05:54 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* cogl_texture_2d_new_from_data:
|
|
|
|
* @ctx: A #CoglContext
|
|
|
|
* @width: width of texture in pixels
|
|
|
|
* @height: height of texture in pixels
|
|
|
|
* @format: the #CoglPixelFormat the buffer is stored in in RAM
|
|
|
|
* @internal_format: the #CoglPixelFormat that will be used for storing
|
2012-04-04 14:10:04 +00:00
|
|
|
* the buffer on the GPU. If %COGL_PIXEL_FORMAT_ANY is given then a
|
2011-05-16 23:05:54 +00:00
|
|
|
* premultiplied format similar to the format of the source data will
|
|
|
|
* be used. The default blending equations of Cogl expect premultiplied
|
|
|
|
* color data; the main use of passing a non-premultiplied format here
|
|
|
|
* is if you have non-premultiplied source data and are going to adjust
|
2012-04-04 14:10:04 +00:00
|
|
|
* the blend mode (see cogl_pipeline_set_blend()) or use the data for
|
2011-05-16 23:05:54 +00:00
|
|
|
* something other than straight blending.
|
|
|
|
* @rowstride: the memory offset in bytes between the starts of
|
|
|
|
* scanlines in @data. A value of 0 will make Cogl automatically
|
|
|
|
* calculate @rowstride from @width and @format.
|
|
|
|
* @data: pointer the memory region where the source buffer resides
|
2012-08-31 18:28:27 +00:00
|
|
|
* @error: A #CoglError for exceptions
|
2011-05-16 23:05:54 +00:00
|
|
|
*
|
|
|
|
* Creates a new #CoglTexture2D texture based on data residing in memory.
|
|
|
|
* These are unlike sliced textures for example which may be comprised
|
|
|
|
* of multiple internal textures, or atlas textures where Cogl has to
|
|
|
|
* modify texture coordinates before they may be used by the GPU.
|
|
|
|
*
|
|
|
|
* <note>Many GPUs only support power of two sizes for #CoglTexture2D
|
|
|
|
* textures. You can check support for non power of two textures by
|
2011-10-12 21:31:12 +00:00
|
|
|
* checking for the %COGL_FEATURE_ID_TEXTURE_NPOT feature via
|
|
|
|
* cogl_has_feature().</note>
|
2011-05-16 23:05:54 +00:00
|
|
|
*
|
|
|
|
* Returns: A newly allocated #CoglTexture2D, or if the size is not
|
|
|
|
* supported (because it is too large or a non-power-of-two
|
|
|
|
* size that the hardware doesn't support) it will return
|
|
|
|
* %NULL and set @error.
|
|
|
|
*
|
|
|
|
* Since: 2.0
|
|
|
|
*/
|
|
|
|
CoglTexture2D *
|
|
|
|
cogl_texture_2d_new_from_data (CoglContext *ctx,
|
|
|
|
int width,
|
|
|
|
int height,
|
|
|
|
CoglPixelFormat format,
|
|
|
|
CoglPixelFormat internal_format,
|
|
|
|
int rowstride,
|
Switch use of primitive glib types to c99 equivalents
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)
2012-04-16 20:56:40 +00:00
|
|
|
const uint8_t *data,
|
2012-08-31 18:28:27 +00:00
|
|
|
CoglError **error);
|
2011-05-16 23:05:54 +00:00
|
|
|
|
2012-04-04 14:10:04 +00:00
|
|
|
/**
|
|
|
|
* cogl_texture_2d_new_from_bitmap:
|
|
|
|
* @bitmap: A #CoglBitmap
|
|
|
|
* @internal_format: the #CoglPixelFormat that will be used for storing
|
|
|
|
* the buffer on the GPU. If %COGL_PIXEL_FORMAT_ANY is given then a
|
|
|
|
* premultiplied format similar to the format of the source data will
|
|
|
|
* be used. The default blending equations of Cogl expect premultiplied
|
|
|
|
* color data; the main use of passing a non-premultiplied format here
|
|
|
|
* is if you have non-premultiplied source data and are going to adjust
|
|
|
|
* the blend mode (see cogl_pipeline_set_blend()) or use the data for
|
|
|
|
* something other than straight blending.
|
2012-08-31 18:28:27 +00:00
|
|
|
* @error: A #CoglError for exceptions
|
2012-04-04 14:10:04 +00:00
|
|
|
*
|
|
|
|
* Creates a new #CoglTexture2D texture based on data residing in a
|
|
|
|
* bitmap. These are unlike sliced textures for example which may be
|
|
|
|
* comprised of multiple internal textures, or atlas textures where
|
|
|
|
* Cogl has to modify texture coordinates before they may be used by
|
|
|
|
* the GPU.
|
|
|
|
*
|
|
|
|
* <note>Many GPUs only support power of two sizes for #CoglTexture2D
|
|
|
|
* textures. You can check support for non power of two textures by
|
|
|
|
* checking for the %COGL_FEATURE_ID_TEXTURE_NPOT feature via
|
|
|
|
* cogl_has_feature().</note>
|
|
|
|
*
|
|
|
|
* Returns: A newly allocated #CoglTexture2D, or if the size is not
|
|
|
|
* supported (because it is too large or a non-power-of-two
|
|
|
|
* size that the hardware doesn't support) it will return
|
|
|
|
* %NULL and set @error.
|
|
|
|
*
|
|
|
|
* Since: 2.0
|
|
|
|
* Stability: unstable
|
|
|
|
*/
|
|
|
|
CoglTexture2D *
|
|
|
|
cogl_texture_2d_new_from_bitmap (CoglBitmap *bitmap,
|
|
|
|
CoglPixelFormat internal_format,
|
2012-08-31 18:28:27 +00:00
|
|
|
CoglError **error);
|
2012-04-04 14:10:04 +00:00
|
|
|
|
2011-05-16 23:05:54 +00:00
|
|
|
G_END_DECLS
|
|
|
|
|
2012-07-31 14:12:01 +00:00
|
|
|
#endif /* __COGL_TEXTURE_2D_H */
|