mirror of
https://github.com/brl/mutter.git
synced 2024-11-10 07:56:14 -05:00
1b2dd815b4
This adds much more comprehensive support for gobject-introspection based bindings by registering all objects as fundamental types that inherit from CoglObject, and all structs as boxed types. Co-Author: Robert Bragg <robert@linux.intel.com> Reviewed-by: Neil Roberts <neil@linux.intel.com>
302 lines
13 KiB
C
302 lines
13 KiB
C
/*
|
|
* Cogl
|
|
*
|
|
* A Low Level GPU Graphics and Utilities API
|
|
*
|
|
* Copyright (C) 2011 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.
|
|
*
|
|
*
|
|
* Authors:
|
|
* Robert Bragg <robert@linux.intel.com>
|
|
*/
|
|
|
|
#ifndef __COGL_TEXURE_2D_SLICED_H
|
|
#define __COGL_TEXURE_2D_SLICED_H
|
|
|
|
#include "cogl-context.h"
|
|
#include "cogl-types.h"
|
|
|
|
/**
|
|
* SECTION:cogl-texture-2d-sliced
|
|
* @short_description: Functions for creating and manipulating 2D meta
|
|
* textures that may internally be comprised of
|
|
* multiple 2D textures with power-of-two sizes.
|
|
*
|
|
* These functions allow high-level meta textures (See the
|
|
* #CoglMetaTexture interface) to be allocated that may internally be
|
|
* comprised of multiple 2D texture "slices" with power-of-two sizes.
|
|
*
|
|
* This API can be useful when working with GPUs that don't have
|
|
* native support for non-power-of-two textures or if you want to load
|
|
* a texture that is larger than the GPUs maximum texture size limits.
|
|
*
|
|
* The algorithm for slicing works by first trying to map a virtual
|
|
* size to the next larger power-of-two size and then seeing how many
|
|
* wasted pixels that would result in. For example if you have a
|
|
* virtual texture that's 259 texels wide, the next pot size = 512 and
|
|
* the amount of waste would be 253 texels. If the amount of waste is
|
|
* above a max-waste threshold then we would next slice that texture
|
|
* into one that's 256 texels and then looking at how many more texels
|
|
* remain unallocated after that we choose the next power-of-two size.
|
|
* For the example of a 259 texel image that would mean having a 256
|
|
* texel wide texture, leaving 3 texels unallocated so we'd then
|
|
* create a 4 texel wide texture - now there is only one texel of
|
|
* waste. The algorithm continues to slice the right most textures
|
|
* until the amount of waste is less than or equal to a specfied
|
|
* max-waste threshold. The same logic for slicing from left to right
|
|
* is also applied from top to bottom.
|
|
*/
|
|
|
|
typedef struct _CoglTexture2DSliced CoglTexture2DSliced;
|
|
#define COGL_TEXTURE_2D_SLICED(X) ((CoglTexture2DSliced *)X)
|
|
|
|
#ifdef COGL_HAS_GTYPE_SUPPORT
|
|
/**
|
|
* cogl_texture_2d_sliced_get_gtype:
|
|
*
|
|
* Returns: a #GType that can be used with the GLib type system.
|
|
*/
|
|
GType cogl_texture_2d_sliced_get_gtype (void);
|
|
#endif
|
|
|
|
/**
|
|
* cogl_texture_2d_sliced_new_with_size:
|
|
* @ctx: A #CoglContext
|
|
* @width: The virtual width of your sliced texture.
|
|
* @height: The virtual height of your sliced texture.
|
|
* @max_waste: The threshold of how wide a strip of wasted texels
|
|
* are allowed along the right and bottom textures before
|
|
* they must be sliced to reduce the amount of waste. A
|
|
* negative can be passed to disable slicing.
|
|
*
|
|
* Creates a #CoglTexture2DSliced that may internally be comprised of
|
|
* 1 or more #CoglTexture2D textures depending on GPU limitations.
|
|
* For example if the GPU only supports power-of-two sized textures
|
|
* then a sliced texture will turn a non-power-of-two size into a
|
|
* combination of smaller power-of-two sized textures. If the
|
|
* requested texture size is larger than is supported by the hardware
|
|
* then the texture will be sliced into smaller textures that can be
|
|
* accessed by the hardware.
|
|
*
|
|
* @max_waste is used as a threshold for recursively slicing the
|
|
* right-most or bottom-most slices into smaller sizes until the
|
|
* wasted padding at the bottom and right of the textures is less than
|
|
* specified. A negative @max_waste will disable slicing.
|
|
*
|
|
* 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.
|
|
*
|
|
* <note>It's possible for the allocation of a sliced texture to fail
|
|
* later due to impossible slicing constraints if a negative
|
|
* @max_waste value is given. If the given virtual texture size size
|
|
* is larger than is supported by the hardware but slicing is disabled
|
|
* the texture size would be too large to handle.</note>
|
|
*
|
|
* Returns: (transfer full): A new #CoglTexture2DSliced object with no storage
|
|
* allocated yet.
|
|
*
|
|
* Since: 1.10
|
|
* Stability: unstable
|
|
*/
|
|
CoglTexture2DSliced *
|
|
cogl_texture_2d_sliced_new_with_size (CoglContext *ctx,
|
|
int width,
|
|
int height,
|
|
int max_waste);
|
|
|
|
/**
|
|
* cogl_texture_2d_sliced_new_from_file:
|
|
* @ctx: A #CoglContext
|
|
* @filename: the file to load
|
|
* @max_waste: The threshold of how wide a strip of wasted texels
|
|
* are allowed along the right and bottom textures before
|
|
* they must be sliced to reduce the amount of waste. A
|
|
* negative can be passed to disable slicing.
|
|
* @error: A #CoglError to catch exceptional errors or %NULL
|
|
*
|
|
* Creates a #CoglTexture2DSliced from an image file.
|
|
*
|
|
* A #CoglTexture2DSliced may internally be comprised of 1 or more
|
|
* #CoglTexture2D textures depending on GPU limitations. For example
|
|
* if the GPU only supports power-of-two sized textures then a sliced
|
|
* texture will turn a non-power-of-two size into a combination of
|
|
* smaller power-of-two sized textures. If the requested texture size
|
|
* is larger than is supported by the hardware then the texture will
|
|
* be sliced into smaller textures that can be accessed by the
|
|
* hardware.
|
|
*
|
|
* @max_waste is used as a threshold for recursively slicing the
|
|
* right-most or bottom-most slices into smaller sizes until the
|
|
* wasted padding at the bottom and right of the textures is less than
|
|
* specified. A negative @max_waste will disable slicing.
|
|
*
|
|
* 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.
|
|
*
|
|
* <note>It's possible for the allocation of a sliced texture to fail
|
|
* later due to impossible slicing constraints if a negative
|
|
* @max_waste value is given. If the given virtual texture size is
|
|
* larger than is supported by the hardware but slicing is disabled
|
|
* the texture size would be too large to handle.</note>
|
|
*
|
|
* Return value: (transfer full): A newly created #CoglTexture2DSliced
|
|
* or %NULL on failure and @error will be updated.
|
|
*
|
|
* Since: 1.16
|
|
*/
|
|
CoglTexture2DSliced *
|
|
cogl_texture_2d_sliced_new_from_file (CoglContext *ctx,
|
|
const char *filename,
|
|
int max_waste,
|
|
CoglError **error);
|
|
|
|
/**
|
|
* cogl_texture_2d_sliced_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
|
|
* @max_waste: The threshold of how wide a strip of wasted texels
|
|
* are allowed along the right and bottom textures before
|
|
* they must be sliced to reduce the amount of waste. A
|
|
* negative can be passed to disable slicing.
|
|
* @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 the memory region where the source buffer resides
|
|
* @error: A #CoglError to catch exceptional errors or %NULL
|
|
*
|
|
* Creates a new #CoglTexture2DSliced texture based on data residing
|
|
* in memory.
|
|
*
|
|
* A #CoglTexture2DSliced may internally be comprised of 1 or more
|
|
* #CoglTexture2D textures depending on GPU limitations. For example
|
|
* if the GPU only supports power-of-two sized textures then a sliced
|
|
* texture will turn a non-power-of-two size into a combination of
|
|
* smaller power-of-two sized textures. If the requested texture size
|
|
* is larger than is supported by the hardware then the texture will
|
|
* be sliced into smaller textures that can be accessed by the
|
|
* hardware.
|
|
*
|
|
* @max_waste is used as a threshold for recursively slicing the
|
|
* right-most or bottom-most slices into smaller sizes until the
|
|
* wasted padding at the bottom and right of the textures is less than
|
|
* specified. A negative @max_waste will disable slicing.
|
|
*
|
|
* <note>This api will always immediately allocate GPU memory for all
|
|
* the required texture slices 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_texture_2d_sliced_new_from_bitmap() or use
|
|
* cogl_texture_2d_sliced_new_with_size() and then upload data using
|
|
* cogl_texture_set_data()</note>
|
|
*
|
|
* <note>It's possible for the allocation of a sliced texture to fail
|
|
* due to impossible slicing constraints if a negative @max_waste
|
|
* value is given. If the given virtual texture size is larger than is
|
|
* supported by the hardware but slicing is disabled the texture size
|
|
* would be too large to handle.</note>
|
|
*
|
|
* Return value: (transfer full): A newly created #CoglTexture2DSliced
|
|
* or %NULL on failure and @error will be updated.
|
|
*
|
|
* Since: 1.16
|
|
*/
|
|
CoglTexture2DSliced *
|
|
cogl_texture_2d_sliced_new_from_data (CoglContext *ctx,
|
|
int width,
|
|
int height,
|
|
int max_waste,
|
|
CoglPixelFormat format,
|
|
int rowstride,
|
|
const uint8_t *data,
|
|
CoglError **error);
|
|
|
|
/**
|
|
* cogl_texture_2d_sliced_new_from_bitmap:
|
|
* @bmp: A #CoglBitmap
|
|
* @max_waste: The threshold of how wide a strip of wasted texels
|
|
* are allowed along the right and bottom textures before
|
|
* they must be sliced to reduce the amount of waste. A
|
|
* negative can be passed to disable slicing.
|
|
*
|
|
* Creates a new #CoglTexture2DSliced texture based on data residing
|
|
* in a bitmap.
|
|
*
|
|
* A #CoglTexture2DSliced may internally be comprised of 1 or more
|
|
* #CoglTexture2D textures depending on GPU limitations. For example
|
|
* if the GPU only supports power-of-two sized textures then a sliced
|
|
* texture will turn a non-power-of-two size into a combination of
|
|
* smaller power-of-two sized textures. If the requested texture size
|
|
* is larger than is supported by the hardware then the texture will
|
|
* be sliced into smaller textures that can be accessed by the
|
|
* hardware.
|
|
*
|
|
* @max_waste is used as a threshold for recursively slicing the
|
|
* right-most or bottom-most slices into smaller sizes until the
|
|
* wasted padding at the bottom and right of the textures is less than
|
|
* specified. A negative @max_waste will disable slicing.
|
|
*
|
|
* 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.
|
|
*
|
|
* <note>It's possible for the allocation of a sliced texture to fail
|
|
* later due to impossible slicing constraints if a negative
|
|
* @max_waste value is given. If the given virtual texture size is
|
|
* larger than is supported by the hardware but slicing is disabled
|
|
* the texture size would be too large to handle.</note>
|
|
*
|
|
* Return value: (transfer full): A newly created #CoglTexture2DSliced
|
|
* or %NULL on failure and @error will be updated.
|
|
*
|
|
* Since: 1.16
|
|
*/
|
|
CoglTexture2DSliced *
|
|
cogl_texture_2d_sliced_new_from_bitmap (CoglBitmap *bmp,
|
|
int max_waste);
|
|
|
|
/**
|
|
* cogl_is_texture_2d_sliced:
|
|
* @object: A #CoglObject pointer
|
|
*
|
|
* Gets whether the given object references a #CoglTexture2DSliced.
|
|
*
|
|
* Return value: %TRUE if the object references a #CoglTexture2DSliced
|
|
* and %FALSE otherwise.
|
|
* Since: 1.10
|
|
* Stability: unstable
|
|
*/
|
|
CoglBool
|
|
cogl_is_texture_2d_sliced (void *object);
|
|
|
|
#endif /* __COGL_TEXURE_2D_SLICED_H */
|