@girs/clutterx11-4 4.0.0-4.0.0-beta.39 → 4.0.0-4.0.0-beta.41
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/clutterx11-4.d.ts +58 -33
- package/package.json +18 -18
- package/tsconfig.json +54 -1
- package/typedoc.json +3 -1
package/README.md
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
|
|
7
7
|
|
|
8
|
-
GJS TypeScript type definitions for ClutterX11-4, generated from library version 4.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.0.0-beta.
|
|
8
|
+
GJS TypeScript type definitions for ClutterX11-4, generated from library version 4.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.0.0-beta.41.
|
|
9
9
|
|
|
10
10
|
## Install
|
|
11
11
|
|
package/clutterx11-4.d.ts
CHANGED
|
@@ -33,16 +33,17 @@ export namespace ClutterX11 {
|
|
|
33
33
|
*/
|
|
34
34
|
|
|
35
35
|
/**
|
|
36
|
-
*
|
|
37
|
-
*/
|
|
38
|
-
|
|
39
|
-
/**
|
|
40
|
-
* Return values for the #ClutterX11FilterFunc function.
|
|
36
|
+
* @gir-type Enum
|
|
41
37
|
*/
|
|
42
38
|
export namespace FilterReturn {
|
|
43
39
|
export const $gtype: GObject.GType<FilterReturn>;
|
|
44
40
|
}
|
|
45
41
|
|
|
42
|
+
/**
|
|
43
|
+
* Return values for the {@link ClutterX11.FilterFunc} function.
|
|
44
|
+
* @gir-type Enum
|
|
45
|
+
* @since 0.6
|
|
46
|
+
*/
|
|
46
47
|
enum FilterReturn {
|
|
47
48
|
/**
|
|
48
49
|
* The event was not handled, continues the
|
|
@@ -59,16 +60,17 @@ export namespace ClutterX11 {
|
|
|
59
60
|
*/
|
|
60
61
|
REMOVE,
|
|
61
62
|
}
|
|
63
|
+
|
|
62
64
|
/**
|
|
63
65
|
* Disables the internal polling of X11 events in the main loop.
|
|
64
66
|
*
|
|
65
67
|
* Libraries or applications calling this function will be responsible of
|
|
66
68
|
* polling all X11 events.
|
|
67
69
|
*
|
|
68
|
-
* You also must call clutter_x11_handle_event() to let Clutter process
|
|
70
|
+
* You also must call `clutter_x11_handle_event()` to let Clutter process
|
|
69
71
|
* events and maintain its internal state.
|
|
70
72
|
*
|
|
71
|
-
* This function can only be called before calling clutter_init()
|
|
73
|
+
* This function can only be called before calling `clutter_init()`.
|
|
72
74
|
*
|
|
73
75
|
* Even with event handling disabled, Clutter will still select
|
|
74
76
|
* all the events required to maintain its internal state on the stage
|
|
@@ -78,45 +80,53 @@ export namespace ClutterX11 {
|
|
|
78
80
|
* XFixes extension.
|
|
79
81
|
*
|
|
80
82
|
* This function should not be normally used by applications.
|
|
83
|
+
* @since 0.8
|
|
81
84
|
*/
|
|
82
85
|
function disable_event_retrieval(): void;
|
|
83
86
|
/**
|
|
84
87
|
* Retrieves the group for the modifiers set in `event`
|
|
85
|
-
* @param event a
|
|
88
|
+
* @param event a {@link Clutter.Event} of type {@link Clutter.EventType.KEY_PRESS} or {@link Clutter.EventType.KEY_RELEASE}
|
|
86
89
|
* @returns the group id
|
|
90
|
+
* @since 1.4
|
|
87
91
|
*/
|
|
88
92
|
function event_get_key_group(event: Clutter.Event): number;
|
|
89
93
|
/**
|
|
90
|
-
* Retrieves the touch detail froma
|
|
91
|
-
* @param sequence a
|
|
94
|
+
* Retrieves the touch detail froma {@link Clutter.EventSequence}.
|
|
95
|
+
* @param sequence a {@link Clutter.EventSequence}
|
|
92
96
|
* @returns the touch detail
|
|
97
|
+
* @since 1.12
|
|
93
98
|
*/
|
|
94
99
|
function event_sequence_get_touch_detail(sequence: Clutter.EventSequence): number;
|
|
95
100
|
/**
|
|
96
101
|
* Retrieves the pointer to the default display.
|
|
97
102
|
* @returns the default display
|
|
103
|
+
* @since 0.6
|
|
98
104
|
*/
|
|
99
105
|
function get_default_display(): xlib.Display;
|
|
100
106
|
/**
|
|
101
107
|
* Gets the number of the default X Screen object.
|
|
102
108
|
* @returns the number of the default screen
|
|
109
|
+
* @since 0.6
|
|
103
110
|
*/
|
|
104
111
|
function get_default_screen(): number;
|
|
105
112
|
/**
|
|
106
113
|
* Gets the stage for a particular X window.
|
|
107
114
|
* @param win an X Window ID
|
|
108
|
-
* @returns A
|
|
115
|
+
* @returns A {@link Clutter.Stage}, or% NULL if a stage does not exist for the window
|
|
116
|
+
* @since 0.8
|
|
109
117
|
*/
|
|
110
118
|
function get_stage_from_window(win: xlib.Window): Clutter.Stage;
|
|
111
119
|
/**
|
|
112
120
|
* Retrieves whether the Clutter X11 backend is using ARGB visuals by default
|
|
113
|
-
* @returns
|
|
121
|
+
* @returns `true` if ARGB visuals are queried by default
|
|
122
|
+
* @since 1.2
|
|
114
123
|
*/
|
|
115
124
|
function get_use_argb_visual(): boolean;
|
|
116
125
|
/**
|
|
117
126
|
* Retrieves whether the Clutter X11 backend will create stereo
|
|
118
127
|
* stages if possible.
|
|
119
|
-
* @returns
|
|
128
|
+
* @returns `true` if stereo stages are used if possible
|
|
129
|
+
* @since 1.22
|
|
120
130
|
*/
|
|
121
131
|
function get_use_stereo_stage(): boolean;
|
|
122
132
|
/**
|
|
@@ -124,45 +134,50 @@ export namespace ClutterX11 {
|
|
|
124
134
|
* into external X11 event processing (for example, a GDK filter
|
|
125
135
|
* function).
|
|
126
136
|
*
|
|
127
|
-
* If clutter_x11_disable_event_retrieval() has been called, you must
|
|
137
|
+
* If `clutter_x11_disable_event_retrieval()` has been called, you must
|
|
128
138
|
* let this function process events to update Clutter's internal state.
|
|
129
139
|
* @param xevent pointer to XEvent structure
|
|
130
|
-
* @returns
|
|
140
|
+
* @returns {@link ClutterX11.FilterReturn}. {@link ClutterX11.FilterReturn.REMOVE} indicates that Clutter has internally handled the event and the caller should do no further processing. {@link ClutterX11.FilterReturn.CONTINUE} indicates that Clutter is either not interested in the event, or has used the event to update internal state without taking any exclusive action. {@link ClutterX11.FilterReturn.TRANSLATE} will not occur.
|
|
141
|
+
* @since 0.8
|
|
131
142
|
*/
|
|
132
143
|
function handle_event(xevent: xlib.XEvent): FilterReturn;
|
|
133
144
|
/**
|
|
134
145
|
* Retrieves whether Clutter is running on an X11 server with the
|
|
135
146
|
* XComposite extension
|
|
136
|
-
* @returns
|
|
147
|
+
* @returns `true` if the XComposite extension is available
|
|
137
148
|
*/
|
|
138
149
|
function has_composite_extension(): boolean;
|
|
139
150
|
/**
|
|
140
151
|
* Queries the X11 backend to check if event collection has been disabled.
|
|
141
152
|
* @returns TRUE if event retrival has been disabled. FALSE otherwise.
|
|
153
|
+
* @since 0.8
|
|
142
154
|
*/
|
|
143
155
|
function has_event_retrieval(): boolean;
|
|
144
156
|
/**
|
|
145
157
|
* Gets whether Clutter has XInput support.
|
|
146
|
-
* @returns
|
|
158
|
+
* @returns `true` if Clutter was compiled with XInput support and XInput support is available at run time.
|
|
159
|
+
* @since 0.8
|
|
147
160
|
*/
|
|
148
161
|
function has_xinput(): boolean;
|
|
149
162
|
/**
|
|
150
163
|
* Sets the display connection Clutter should use; must be called
|
|
151
|
-
* before clutter_init()
|
|
164
|
+
* before `clutter_init()`, `clutter_init_with_args()` or other functions
|
|
152
165
|
* pertaining Clutter's initialization process.
|
|
153
166
|
*
|
|
154
167
|
* If you are parsing the command line arguments by retrieving Clutter's
|
|
155
|
-
*
|
|
156
|
-
* g_option_context_parse() yourself, you should also call
|
|
157
|
-
* clutter_x11_set_display() before g_option_context_parse()
|
|
168
|
+
* {@link GLib.OptionGroup} with `clutter_get_option_group()` and calling
|
|
169
|
+
* `g_option_context_parse()` yourself, you should also call
|
|
170
|
+
* `clutter_x11_set_display()` before `g_option_context_parse()`.
|
|
158
171
|
* @param xdpy pointer to a X display connection.
|
|
172
|
+
* @since 0.8
|
|
159
173
|
*/
|
|
160
174
|
function set_display(xdpy: xlib.Display): void;
|
|
161
175
|
/**
|
|
162
|
-
* Target the
|
|
163
|
-
* @param stage a
|
|
176
|
+
* Target the {@link Clutter.Stage} to use an existing external X Window
|
|
177
|
+
* @param stage a {@link Clutter.Stage}
|
|
164
178
|
* @param xwindow an existing X Window id
|
|
165
|
-
* @returns
|
|
179
|
+
* @returns `true` if foreign window is valid
|
|
180
|
+
* @since 0.4
|
|
166
181
|
*/
|
|
167
182
|
function set_stage_foreign(stage: Clutter.Stage, xwindow: xlib.Window): boolean;
|
|
168
183
|
/**
|
|
@@ -174,11 +189,12 @@ export namespace ClutterX11 {
|
|
|
174
189
|
* If no ARGB visuals are found, the X11 backend will fall back to
|
|
175
190
|
* requesting a RGB visual instead.
|
|
176
191
|
*
|
|
177
|
-
* ARGB visuals are required for the
|
|
192
|
+
* ARGB visuals are required for the {@link Clutter.Stage.use_alpha} property to work.
|
|
178
193
|
*
|
|
179
|
-
* This function can only be called once, and before clutter_init() is
|
|
194
|
+
* This function can only be called once, and before `clutter_init()` is
|
|
180
195
|
* called.
|
|
181
|
-
* @param use_argb
|
|
196
|
+
* @param use_argb `true` if ARGB visuals should be requested by default
|
|
197
|
+
* @since 1.2
|
|
182
198
|
*/
|
|
183
199
|
function set_use_argb_visual(use_argb: boolean): void;
|
|
184
200
|
/**
|
|
@@ -186,32 +202,41 @@ export namespace ClutterX11 {
|
|
|
186
202
|
* if possible, be created with the ability to support stereo drawing
|
|
187
203
|
* (drawing separate images for the left and right eyes).
|
|
188
204
|
*
|
|
189
|
-
* This function must be called before clutter_init() is called.
|
|
190
|
-
* During paint callbacks, cogl_framebuffer_is_stereo() can be called
|
|
191
|
-
* on the framebuffer retrieved by cogl_get_draw_framebuffer() to
|
|
205
|
+
* This function must be called before `clutter_init()` is called.
|
|
206
|
+
* During paint callbacks, `cogl_framebuffer_is_stereo()` can be called
|
|
207
|
+
* on the framebuffer retrieved by `cogl_get_draw_framebuffer()` to
|
|
192
208
|
* determine if stereo support was successfully enabled, and
|
|
193
|
-
* cogl_framebuffer_set_stereo_mode() to determine which buffers
|
|
209
|
+
* `cogl_framebuffer_set_stereo_mode()` to determine which buffers
|
|
194
210
|
* will be drawn to.
|
|
195
211
|
*
|
|
196
212
|
* Note that this function *does not* cause the stage to be drawn
|
|
197
213
|
* multiple times with different perspective transformations and thus
|
|
198
214
|
* appear in 3D, it simply enables individual ClutterActors to paint
|
|
199
215
|
* different images for the left and and right eye.
|
|
200
|
-
* @param use_stereo
|
|
216
|
+
* @param use_stereo `true` if the stereo stages should be used if possible.
|
|
217
|
+
* @since 1.22
|
|
201
218
|
*/
|
|
202
219
|
function set_use_stereo_stage(use_stereo: boolean): void;
|
|
203
220
|
/**
|
|
204
|
-
* Traps every X error until clutter_x11_untrap_x_errors() is called.
|
|
221
|
+
* Traps every X error until `clutter_x11_untrap_x_errors()` is called.
|
|
222
|
+
* @since 0.6
|
|
205
223
|
*/
|
|
206
224
|
function trap_x_errors(): void;
|
|
207
225
|
/**
|
|
208
226
|
* Removes the X error trap and returns the current status.
|
|
209
227
|
* @returns the trapped error code, or 0 for success
|
|
228
|
+
* @since 0.4
|
|
210
229
|
*/
|
|
211
230
|
function untrap_x_errors(): number;
|
|
231
|
+
/**
|
|
232
|
+
* @gir-type Callback
|
|
233
|
+
*/
|
|
212
234
|
interface FilterFunc {
|
|
213
235
|
(xev: xlib.XEvent, cev: Clutter.Event): FilterReturn;
|
|
214
236
|
}
|
|
237
|
+
/**
|
|
238
|
+
* @gir-type Struct
|
|
239
|
+
*/
|
|
215
240
|
abstract class XInputDevice {
|
|
216
241
|
static $gtype: GObject.GType<XInputDevice>;
|
|
217
242
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@girs/clutterx11-4",
|
|
3
|
-
"version": "4.0.0-4.0.0-beta.
|
|
3
|
+
"version": "4.0.0-4.0.0-beta.41",
|
|
4
4
|
"description": "GJS TypeScript type definitions for ClutterX11-4, generated from library version 4.0.0",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"module": "clutterx11-4.js",
|
|
@@ -31,23 +31,23 @@
|
|
|
31
31
|
"test": "tsc --project tsconfig.json"
|
|
32
32
|
},
|
|
33
33
|
"dependencies": {
|
|
34
|
-
"@girs/gjs": "4.0.0-beta.
|
|
35
|
-
"@girs/xlib-2.0": "2.0.0-4.0.0-beta.
|
|
36
|
-
"@girs/coglpango-4": "4.0.0-4.0.0-beta.
|
|
37
|
-
"@girs/pangocairo-1.0": "1.0.0-4.0.0-beta.
|
|
38
|
-
"@girs/cairo-1.0": "1.0.0-4.0.0-beta.
|
|
39
|
-
"@girs/gobject-2.0": "2.
|
|
40
|
-
"@girs/glib-2.0": "2.
|
|
41
|
-
"@girs/pango-1.0": "1.57.0-4.0.0-beta.
|
|
42
|
-
"@girs/harfbuzz-0.0": "
|
|
43
|
-
"@girs/freetype2-2.0": "2.0.0-4.0.0-beta.
|
|
44
|
-
"@girs/gio-2.0": "2.
|
|
45
|
-
"@girs/gmodule-2.0": "2.0.0-4.0.0-beta.
|
|
46
|
-
"@girs/cogl-4": "4.0.0-4.0.0-beta.
|
|
47
|
-
"@girs/gl-1.0": "1.0.0-4.0.0-beta.
|
|
48
|
-
"@girs/clutter-4": "4.0.0-4.0.0-beta.
|
|
49
|
-
"@girs/json-1.0": "1.10.8-4.0.0-beta.
|
|
50
|
-
"@girs/atk-1.0": "2.
|
|
34
|
+
"@girs/gjs": "4.0.0-beta.41",
|
|
35
|
+
"@girs/xlib-2.0": "2.0.0-4.0.0-beta.41",
|
|
36
|
+
"@girs/coglpango-4": "4.0.0-4.0.0-beta.41",
|
|
37
|
+
"@girs/pangocairo-1.0": "1.0.0-4.0.0-beta.41",
|
|
38
|
+
"@girs/cairo-1.0": "1.0.0-4.0.0-beta.41",
|
|
39
|
+
"@girs/gobject-2.0": "2.88.0-4.0.0-beta.41",
|
|
40
|
+
"@girs/glib-2.0": "2.88.0-4.0.0-beta.41",
|
|
41
|
+
"@girs/pango-1.0": "1.57.0-4.0.0-beta.41",
|
|
42
|
+
"@girs/harfbuzz-0.0": "12.3.2-4.0.0-beta.41",
|
|
43
|
+
"@girs/freetype2-2.0": "2.0.0-4.0.0-beta.41",
|
|
44
|
+
"@girs/gio-2.0": "2.88.0-4.0.0-beta.41",
|
|
45
|
+
"@girs/gmodule-2.0": "2.0.0-4.0.0-beta.41",
|
|
46
|
+
"@girs/cogl-4": "4.0.0-4.0.0-beta.41",
|
|
47
|
+
"@girs/gl-1.0": "1.0.0-4.0.0-beta.41",
|
|
48
|
+
"@girs/clutter-4": "4.0.0-4.0.0-beta.41",
|
|
49
|
+
"@girs/json-1.0": "1.10.8-4.0.0-beta.41",
|
|
50
|
+
"@girs/atk-1.0": "2.60.0-4.0.0-beta.41" },
|
|
51
51
|
"devDependencies": {
|
|
52
52
|
"typescript": "*"
|
|
53
53
|
},
|
package/tsconfig.json
CHANGED
|
@@ -17,7 +17,60 @@
|
|
|
17
17
|
"inlineSources": false,
|
|
18
18
|
"newLine": "LF",
|
|
19
19
|
// Show diagnostics
|
|
20
|
-
"diagnostics": true
|
|
20
|
+
"diagnostics": true,
|
|
21
|
+
"paths": {
|
|
22
|
+
"@girs/xlib-2.0": [
|
|
23
|
+
"../xlib-2.0/index.d.ts"
|
|
24
|
+
],
|
|
25
|
+
"@girs/coglpango-4": [
|
|
26
|
+
"../coglpango-4/index.d.ts"
|
|
27
|
+
],
|
|
28
|
+
"@girs/pangocairo-1.0": [
|
|
29
|
+
"../pangocairo-1.0/index.d.ts"
|
|
30
|
+
],
|
|
31
|
+
"@girs/cairo-1.0": [
|
|
32
|
+
"../cairo-1.0/index.d.ts"
|
|
33
|
+
],
|
|
34
|
+
"@girs/gobject-2.0": [
|
|
35
|
+
"../gobject-2.0/index.d.ts"
|
|
36
|
+
],
|
|
37
|
+
"@girs/glib-2.0": [
|
|
38
|
+
"../glib-2.0/index.d.ts"
|
|
39
|
+
],
|
|
40
|
+
"@girs/pango-1.0": [
|
|
41
|
+
"../pango-1.0/index.d.ts"
|
|
42
|
+
],
|
|
43
|
+
"@girs/harfbuzz-0.0": [
|
|
44
|
+
"../harfbuzz-0.0/index.d.ts"
|
|
45
|
+
],
|
|
46
|
+
"@girs/freetype2-2.0": [
|
|
47
|
+
"../freetype2-2.0/index.d.ts"
|
|
48
|
+
],
|
|
49
|
+
"@girs/gio-2.0": [
|
|
50
|
+
"../gio-2.0/index.d.ts"
|
|
51
|
+
],
|
|
52
|
+
"@girs/gmodule-2.0": [
|
|
53
|
+
"../gmodule-2.0/index.d.ts"
|
|
54
|
+
],
|
|
55
|
+
"@girs/cogl-4": [
|
|
56
|
+
"../cogl-4/index.d.ts"
|
|
57
|
+
],
|
|
58
|
+
"@girs/gl-1.0": [
|
|
59
|
+
"../gl-1.0/index.d.ts"
|
|
60
|
+
],
|
|
61
|
+
"@girs/clutter-4": [
|
|
62
|
+
"../clutter-4/index.d.ts"
|
|
63
|
+
],
|
|
64
|
+
"@girs/json-1.0": [
|
|
65
|
+
"../json-1.0/index.d.ts"
|
|
66
|
+
],
|
|
67
|
+
"@girs/atk-1.0": [
|
|
68
|
+
"../atk-1.0/index.d.ts"
|
|
69
|
+
],
|
|
70
|
+
"@girs/gjs": [
|
|
71
|
+
"../gjs/index.d.ts"
|
|
72
|
+
]
|
|
73
|
+
}
|
|
21
74
|
},
|
|
22
75
|
"include": ["./clutterx11-4.d.ts"]
|
|
23
76
|
}
|
package/typedoc.json
CHANGED
|
@@ -2,6 +2,8 @@
|
|
|
2
2
|
"entryPoints": ["./clutterx11-4.d.ts"],
|
|
3
3
|
"readme": "./README.md",
|
|
4
4
|
"name": "ClutterX11-4",
|
|
5
|
-
"tsconfig": "./tsconfig.json"
|
|
5
|
+
"tsconfig": "./tsconfig.json",
|
|
6
|
+
"skipErrorChecking": true,
|
|
7
|
+
"highlightLanguages": ["typescript", "javascript", "c", "cpp", "xml", "bash", "json", "css"]
|
|
6
8
|
}
|
|
7
9
|
|