mirror of
https://github.com/brl/mutter.git
synced 2024-11-29 03:20:46 -05:00
a0441778ad
Since the Cogl 1.18 branch is actively maintained in parallel with the
master branch; this is a counter part to commit 1b83ef938fc16b which
re-licensed the master branch to use the MIT license.
This re-licensing is a follow up to the proposal that was sent to the
Cogl mailing list:
http://lists.freedesktop.org/archives/cogl/2013-December/001465.html
Note: there was a copyright assignment policy in place for Clutter (and
therefore Cogl which was part of Clutter at the time) until the 11th of
June 2010 and so we only checked the details after that point (commit
0bbf50f905)
For each file, authors were identified via this Git command:
$ git blame -p -C -C -C20 -M -M10 0bbf50f905..HEAD
We received blanket approvals for re-licensing all Red Hat and Collabora
contributions which reduced how many people needed to be contacted
individually:
- http://lists.freedesktop.org/archives/cogl/2013-December/001470.html
- http://lists.freedesktop.org/archives/cogl/2014-January/001536.html
Individual approval requests were sent to all the other identified authors
who all confirmed the re-license on the Cogl mailinglist:
http://lists.freedesktop.org/archives/cogl/2014-January
As well as updating the copyright header in all sources files, the
COPYING file has been updated to reflect the license change and also
document the other licenses used in Cogl such as the SGI Free Software
License B, version 2.0 and the 3-clause BSD license.
This patch was not simply cherry-picked from master; but the same
methodology was used to check the source files.
247 lines
8.9 KiB
C
247 lines
8.9 KiB
C
/*
|
|
* Cogl
|
|
*
|
|
* A Low Level GPU Graphics and Utilities API
|
|
*
|
|
* Copyright (C) 2013 Intel Corporation.
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person
|
|
* obtaining a copy of this software and associated documentation
|
|
* files (the "Software"), to deal in the Software without
|
|
* restriction, including without limitation the rights to use, copy,
|
|
* modify, merge, publish, distribute, sublicense, and/or sell copies
|
|
* of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be
|
|
* included in all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
|
|
* BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
|
|
* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
|
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
* SOFTWARE.
|
|
*
|
|
*
|
|
*/
|
|
|
|
#if !defined(__COGL_H_INSIDE__) && !defined(COGL_COMPILATION)
|
|
#error "Only <cogl/cogl.h> can be included directly."
|
|
#endif
|
|
|
|
#ifndef _COGL_ATLAS_TEXTURE_H_
|
|
#define _COGL_ATLAS_TEXTURE_H_
|
|
|
|
#include <cogl/cogl-context.h>
|
|
|
|
COGL_BEGIN_DECLS
|
|
|
|
/**
|
|
* SECTION:cogl-atlas-texture
|
|
* @short_description: Functions for managing textures in Cogl's global
|
|
* set of texture atlases
|
|
*
|
|
* A texture atlas is a texture that contains many smaller images that
|
|
* an application is interested in. These are packed together as a way
|
|
* of optimizing drawing with those images by avoiding the costs of
|
|
* repeatedly telling the hardware to change what texture it should
|
|
* sample from. This can enable more geometry to be batched together
|
|
* into few draw calls.
|
|
*
|
|
* Each #CoglContext has an shared, pool of texture atlases that are
|
|
* are managed by Cogl.
|
|
*
|
|
* This api lets applications upload texture data into one of Cogl's
|
|
* shared texture atlases using a high-level #CoglAtlasTexture which
|
|
* represents a sub-region of one of these atlases.
|
|
*
|
|
* <note>A #CoglAtlasTexture is a high-level meta texture which has
|
|
* some limitations to be aware of. Please see the documentation for
|
|
* #CoglMetaTexture for more details.</note>
|
|
*/
|
|
|
|
|
|
typedef struct _CoglAtlasTexture CoglAtlasTexture;
|
|
#define COGL_ATLAS_TEXTURE(tex) ((CoglAtlasTexture *) tex)
|
|
|
|
|
|
/**
|
|
* cogl_atlas_texture_new_with_size:
|
|
* @ctx: A #CoglContext
|
|
* @width: The width of your atlased texture.
|
|
* @height: The height of your atlased texture.
|
|
*
|
|
* Creates a #CoglAtlasTexture with a given @width and @height. A
|
|
* #CoglAtlasTexture represents a sub-region within one of Cogl's
|
|
* shared texture atlases.
|
|
*
|
|
* The storage for the texture is not allocated before this function
|
|
* returns. You can call cogl_texture_allocate() to explicitly
|
|
* allocate the underlying storage or let Cogl automatically allocate
|
|
* storage lazily.
|
|
*
|
|
* The texture is still configurable until it has been allocated so
|
|
* for example you can influence the internal format of the texture
|
|
* using cogl_texture_set_components() and
|
|
* cogl_texture_set_premultiplied().
|
|
*
|
|
* <note>Allocate call can fail if Cogl considers the internal
|
|
* format to be incompatible with the format of its internal
|
|
* atlases.</note>
|
|
*
|
|
* <note>The returned #CoglAtlasTexture is a high-level meta-texture
|
|
* with some limitations. See the documentation for #CoglMetaTexture
|
|
* for more details.</note>
|
|
*
|
|
* Returns: (transfer full): A new #CoglAtlasTexture object.
|
|
* Since: 1.16
|
|
* Stability: unstable
|
|
*/
|
|
CoglAtlasTexture *
|
|
cogl_atlas_texture_new_with_size (CoglContext *ctx,
|
|
int width,
|
|
int height);
|
|
|
|
/**
|
|
* cogl_atlas_texture_new_from_file:
|
|
* @ctx: A #CoglContext
|
|
* @filename: the file to load
|
|
* @error: A #CoglError to catch exceptional errors or %NULL
|
|
*
|
|
* Creates a #CoglAtlasTexture from an image file. A #CoglAtlasTexture
|
|
* represents a sub-region within one of Cogl's shared texture
|
|
* atlases.
|
|
*
|
|
* The storage for the texture is not allocated before this function
|
|
* returns. You can call cogl_texture_allocate() to explicitly
|
|
* allocate the underlying storage or let Cogl automatically allocate
|
|
* storage lazily.
|
|
*
|
|
* The texture is still configurable until it has been allocated so
|
|
* for example you can influence the internal format of the texture
|
|
* using cogl_texture_set_components() and
|
|
* cogl_texture_set_premultiplied().
|
|
*
|
|
* <note>Allocate call can fail if Cogl considers the internal
|
|
* format to be incompatible with the format of its internal
|
|
* atlases.</note>
|
|
*
|
|
* <note>The returned #CoglAtlasTexture is a high-level meta-texture
|
|
* with some limitations. See the documentation for #CoglMetaTexture
|
|
* for more details.</note>
|
|
*
|
|
* Return value: (transfer full): A new #CoglAtlasTexture object or
|
|
* %NULL on failure and @error will be updated.
|
|
* Since: 1.16
|
|
* Stability: unstable
|
|
*/
|
|
CoglAtlasTexture *
|
|
cogl_atlas_texture_new_from_file (CoglContext *ctx,
|
|
const char *filename,
|
|
CoglError **error);
|
|
|
|
/**
|
|
* cogl_atlas_texture_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
|
|
* @rowstride: the memory offset in bytes between the start of each
|
|
* row in @data. A value of 0 will make Cogl automatically
|
|
* calculate @rowstride from @width and @format.
|
|
* @data: pointer to the memory region where the source buffer resides
|
|
* @error: A #CoglError to catch exceptional errors or %NULL
|
|
*
|
|
* Creates a new #CoglAtlasTexture texture based on data residing in
|
|
* memory. A #CoglAtlasTexture represents a sub-region within one of
|
|
* Cogl's shared texture atlases.
|
|
*
|
|
* <note>This api will always immediately allocate GPU memory for the
|
|
* texture and upload the given data so that the @data pointer does
|
|
* not need to remain valid once this function returns. This means it
|
|
* is not possible to configure the texture before it is allocated. If
|
|
* you do need to configure the texture before allocation (to specify
|
|
* constraints on the internal format for example) then you can
|
|
* instead create a #CoglBitmap for your data and use
|
|
* cogl_atlas_texture_new_from_bitmap() or use
|
|
* cogl_atlas_texture_new_with_size() and then upload data using
|
|
* cogl_texture_set_data()</note>
|
|
*
|
|
* <note>Allocate call can fail if Cogl considers the internal
|
|
* format to be incompatible with the format of its internal
|
|
* atlases.</note>
|
|
*
|
|
* <note>The returned #CoglAtlasTexture is a high-level
|
|
* meta-texture with some limitations. See the documentation for
|
|
* #CoglMetaTexture for more details.</note>
|
|
*
|
|
* Return value: (transfer full): A new #CoglAtlasTexture object or
|
|
* %NULL on failure and @error will be updated.
|
|
* Since: 1.16
|
|
* Stability: unstable
|
|
*/
|
|
CoglAtlasTexture *
|
|
cogl_atlas_texture_new_from_data (CoglContext *ctx,
|
|
int width,
|
|
int height,
|
|
CoglPixelFormat format,
|
|
int rowstride,
|
|
const uint8_t *data,
|
|
CoglError **error);
|
|
|
|
/**
|
|
* cogl_atlas_texture_new_from_bitmap:
|
|
* @bitmap: A #CoglBitmap
|
|
*
|
|
* Creates a new #CoglAtlasTexture texture based on data residing in a
|
|
* @bitmap. A #CoglAtlasTexture represents a sub-region within one of
|
|
* Cogl's shared texture atlases.
|
|
*
|
|
* The storage for the texture is not allocated before this function
|
|
* returns. You can call cogl_texture_allocate() to explicitly
|
|
* allocate the underlying storage or preferably let Cogl
|
|
* automatically allocate storage lazily when it may know more about
|
|
* how the texture is being used and can optimize how it is allocated.
|
|
*
|
|
* The texture is still configurable until it has been allocated so
|
|
* for example you can influence the internal format of the texture
|
|
* using cogl_texture_set_components() and
|
|
* cogl_texture_set_premultiplied().
|
|
*
|
|
* <note>Allocate call can fail if Cogl considers the internal
|
|
* format to be incompatible with the format of its internal
|
|
* atlases.</note>
|
|
*
|
|
* <note>The returned #CoglAtlasTexture is a high-level meta-texture
|
|
* with some limitations. See the documentation for #CoglMetaTexture
|
|
* for more details.</note>
|
|
*
|
|
* Returns: (transfer full): A new #CoglAtlasTexture object.
|
|
* Since: 1.16
|
|
* Stability: unstable
|
|
*/
|
|
CoglAtlasTexture *
|
|
cogl_atlas_texture_new_from_bitmap (CoglBitmap *bmp);
|
|
|
|
/**
|
|
* cogl_is_atlas_texture:
|
|
* @object: a #CoglObject
|
|
*
|
|
* Checks whether the given object references a #CoglAtlasTexture
|
|
*
|
|
* Return value: %TRUE if the passed object represents an atlas
|
|
* texture and %FALSE otherwise
|
|
*
|
|
* Since: 1.16
|
|
* Stability: Unstable
|
|
*/
|
|
CoglBool
|
|
cogl_is_atlas_texture (void *object);
|
|
|
|
COGL_END_DECLS
|
|
|
|
#endif /* _COGL_ATLAS_TEXTURE_H_ */
|