blob: e3ca11bbeddf54752cc2837a2dbd7b6b9b70d59c (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
|
/*
* Cogl
*
* An object oriented GL/GLES Abstraction/Utility Layer
*
* Copyright (C) 2007,2008,2009,2012 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/>.
*
*
*/
#if !defined(__COGL_H_INSIDE__) && !defined(COGL_COMPILATION)
#error "Only <cogl/cogl.h> can be included directly."
#endif
#ifndef __COGL_OFFSCREEN_H__
#define __COGL_OFFSCREEN_H__
#include <cogl/cogl-types.h>
#include <cogl/cogl-texture.h>
G_BEGIN_DECLS
/**
* SECTION:cogl-offscreen
* @short_description: Fuctions for creating and manipulating offscreen
* framebuffers.
*
* Cogl allows creating and operating on offscreen framebuffers.
*/
typedef struct _CoglOffscreen CoglOffscreen;
#define COGL_OFFSCREEN(X) ((CoglOffscreen *)X)
/* Offscreen api */
/**
* cogl_offscreen_new_to_texture:
* @texture: A #CoglTexture pointer
*
* This creates an offscreen buffer object using the given @texture as the
* primary color buffer. It doesn't just initialize the contents of the
* offscreen buffer with the @texture; they are tightly bound so that
* drawing to the offscreen buffer effectivly updates the contents of the
* given texture. You don't need to destroy the offscreen buffer before
* you can use the @texture again.
*
* <note>This only works with low-level #CoglTexture types such as
* #CoglTexture2D, #CoglTexture3D and #CoglTextureRectangle, and not
* with meta-texture types such as #CoglTexture2DSliced.</note>
*
* Return value: (transfer full): a newly instantiated #CoglOffscreen
* framebuffer or %NULL if it wasn't possible to create the
* buffer.
*/
CoglOffscreen *
cogl_offscreen_new_to_texture (CoglTexture *texture);
/**
* cogl_is_offscreen:
* @object: A pointer to a #CoglObject
*
* Determines whether the given #CoglObject references an offscreen
* framebuffer object.
*
* Returns: %TRUE if @object is a #CoglOffscreen framebuffer,
* %FALSE otherwise
*/
CoglBool
cogl_is_offscreen (void *object);
#ifndef COGL_DISABLE_DEPRECATED
/**
* cogl_offscreen_ref:
* @offscreen: A pointer to a #CoglOffscreen framebuffer
*
* Increments the reference count on the @offscreen framebuffer.
*
* Return value: (transfer none): For convenience it returns the
* given @offscreen
*
* Deprecated: 1.2: cogl_object_ref() should be used in new code.
*/
void *
cogl_offscreen_ref (void *offscreen) G_GNUC_DEPRECATED;
/**
* cogl_offscreen_unref:
* @offscreen: A pointer to a #CoglOffscreen framebuffer
*
* Decreases the reference count for the @offscreen buffer and frees it when
* the count reaches 0.
*
* Deprecated: 1.2: cogl_object_unref() should be used in new code.
*/
void
cogl_offscreen_unref (void *offscreen) G_GNUC_DEPRECATED;
#endif /* COGL_DISABLE_DEPRECATED */
G_END_DECLS
#endif /* __COGL_OFFSCREEN_H__ */
|
