mutter/cogl/cogl-sub-texture.h
Lionel Landwerlin 1b2dd815b4 Registers gtypes for all public objects and structs
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>
2014-03-20 18:27:12 +00:00

137 lines
4.4 KiB
C

/*
* Cogl
*
* A Low Level GPU Graphics and Utilities API
*
* Copyright (C) 2010 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:
* Neil Roberts <neil@linux.intel.com>
*/
#if !defined(__COGL_H_INSIDE__) && !defined(COGL_COMPILATION)
#error "Only <cogl/cogl.h> can be included directly."
#endif
#ifndef __COGL_SUB_TEXTURE_H
#define __COGL_SUB_TEXTURE_H
COGL_BEGIN_DECLS
/**
* SECTION:cogl-sub-texture
* @short_description: Functions for creating and manipulating
* sub-textures.
*
* These functions allow high-level textures to be created that
* represent a sub-region of another texture. For example these
* can be used to implement custom texture atlasing schemes.
*/
#define COGL_SUB_TEXTURE(tex) ((CoglSubTexture *) tex)
typedef struct _CoglSubTexture CoglSubTexture;
#ifdef COGL_HAS_GTYPE_SUPPORT
/**
* cogl_sub_texture_get_gtype:
*
* Returns: a #GType that can be used with the GLib type system.
*/
GType cogl_sub_texture_get_gtype (void);
#endif
/**
* cogl_sub_texture_new:
* @ctx: A #CoglContext pointer
* @parent_texture: The full texture containing a sub-region you want
* to make a #CoglSubTexture from.
* @sub_x: The top-left x coordinate of the parent region to make
* a texture from.
* @sub_y: The top-left y coordinate of the parent region to make
* a texture from.
* @sub_width: The width of the parent region to make a texture from.
* @sub_height: The height of the parent region to make a texture
* from.
*
* Creates a high-level #CoglSubTexture representing a sub-region of
* any other #CoglTexture. The sub-region must strictly lye within the
* bounds of the @parent_texture. The returned texture implements the
* #CoglMetaTexture interface because it's not a low level texture
* that hardware can understand natively.
*
* <note>Remember: Unless you are using high level drawing APIs such
* as cogl_rectangle() or other APIs documented to understand the
* #CoglMetaTexture interface then you need to use the
* #CoglMetaTexture interface to resolve a #CoglSubTexture into a
* low-level texture before drawing.</note>
*
* Return value: (transfer full): A newly allocated #CoglSubTexture
* representing a sub-region of @parent_texture.
*
* Since: 1.10
* Stability: unstable
*/
CoglSubTexture *
cogl_sub_texture_new (CoglContext *ctx,
CoglTexture *parent_texture,
int sub_x,
int sub_y,
int sub_width,
int sub_height);
/**
* cogl_sub_texture_get_parent:
* @sub_texture: A pointer to a #CoglSubTexture
*
* Retrieves the parent texture that @sub_texture derives its content
* from. This is the texture that was passed to
* cogl_sub_texture_new() as the parent_texture argument.
*
* Return value: (transfer none): The parent texture that @sub_texture
* derives its content from.
* Since: 1.10
* Stability: unstable
*/
CoglTexture *
cogl_sub_texture_get_parent (CoglSubTexture *sub_texture);
/**
* cogl_is_sub_texture:
* @object: a #CoglObject
*
* Checks whether @object is a #CoglSubTexture.
*
* Return value: %TRUE if the passed @object represents a
* #CoglSubTexture and %FALSE otherwise.
*
* Since: 1.10
* Stability: unstable
*/
CoglBool
cogl_is_sub_texture (void *object);
COGL_END_DECLS
#endif /* __COGL_SUB_TEXTURE_H */