e7a920f94d
By stopping using gtk-doc annotations Part-of: <https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/3489>
114 lines
4.6 KiB
C
114 lines
4.6 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>
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#if !defined(__COGL_H_INSIDE__) && !defined(COGL_COMPILATION)
|
|
#error "Only <cogl/cogl.h> can be included directly."
|
|
#endif
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
/**
|
|
* CoglSubTexture:
|
|
*
|
|
* 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_TYPE_SUB_TEXTURE (cogl_sub_texture_get_type ())
|
|
#define COGL_SUB_TEXTURE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), COGL_TYPE_SUB_TEXTURE, CoglSubTexture))
|
|
#define COGL_SUB_TEXTURE_CONST(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), COGL_TYPE_SUB_TEXTURE, CoglSubTexture const))
|
|
#define COGL_SUB_TEXTURE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), COGL_TYPE_SUB_TEXTURE, CoglSubTextureClass))
|
|
#define COGL_IS_SUB_TEXTURE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), COGL_TYPE_SUB_TEXTURE))
|
|
#define COGL_IS_SUB_TEXTURE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), COGL_TYPE_SUB_TEXTURE))
|
|
#define COGL_SUB_TEXTURE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), COGL_TYPE_SUB_TEXTURE, CoglSubTextureClass))
|
|
|
|
typedef struct _CoglSubTextureClass CoglSubTextureClass;
|
|
typedef struct _CoglSubTexture CoglSubTexture;
|
|
|
|
G_DEFINE_AUTOPTR_CLEANUP_FUNC (CoglSubTexture, g_object_unref)
|
|
|
|
COGL_EXPORT
|
|
GType cogl_sub_texture_get_type (void) G_GNUC_CONST;
|
|
/**
|
|
* 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.
|
|
*
|
|
* 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.
|
|
*
|
|
* Return value: (transfer full): A newly allocated #CoglSubTexture
|
|
* representing a sub-region of @parent_texture.
|
|
*/
|
|
COGL_EXPORT CoglTexture *
|
|
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.
|
|
*/
|
|
COGL_EXPORT CoglTexture *
|
|
cogl_sub_texture_get_parent (CoglSubTexture *sub_texture);
|
|
|
|
G_END_DECLS
|