@girs/cogl-10 4.3.0 → 4.4.0

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.
Files changed (3) hide show
  1. package/README.md +1 -1
  2. package/cogl-10.d.ts +170 -0
  3. package/package.json +7 -7
package/README.md CHANGED
@@ -5,7 +5,7 @@
5
5
  ![downloads/week](https://img.shields.io/npm/dw/@girs/cogl-10)
6
6
 
7
7
 
8
- GJS TypeScript type definitions for Cogl-10 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.3.0.
8
+ GJS TypeScript type definitions for Cogl-10 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.4.0.
9
9
 
10
10
  ## Install
11
11
 
package/cogl-10.d.ts CHANGED
@@ -1545,27 +1545,32 @@ export namespace Cogl {
1545
1545
  * Parses an image file enough to extract the width and height
1546
1546
  * of the bitmap.
1547
1547
  * @param filename the file to check
1548
+ * @since 1.0
1548
1549
  */
1549
1550
  static get_size_from_file(filename: string): [boolean, number, number];
1550
1551
 
1551
1552
  // Methods
1552
1553
  /**
1553
1554
  * @returns the {@link Cogl.PixelFormat} that the data for the bitmap is in.
1555
+ * @since 1.10
1554
1556
  */
1555
1557
  get_format(): PixelFormat;
1556
1558
 
1557
1559
  /**
1558
1560
  * @returns the height of the bitmap
1561
+ * @since 1.10
1559
1562
  */
1560
1563
  get_height(): number;
1561
1564
 
1562
1565
  /**
1563
1566
  * @returns the rowstride of the bitmap. This is the number of bytes between the address of start of one row to the address of the next row in the image.
1567
+ * @since 1.10
1564
1568
  */
1565
1569
  get_rowstride(): number;
1566
1570
 
1567
1571
  /**
1568
1572
  * @returns the width of the bitmap
1573
+ * @since 1.10
1569
1574
  */
1570
1575
  get_width(): number;
1571
1576
  }
@@ -1672,6 +1677,7 @@ export namespace Cogl {
1672
1677
  * Gets the frame counter for the {@link Cogl.Onscreen} that corresponds
1673
1678
  * to this frame.
1674
1679
  * @returns The frame counter value
1680
+ * @since 1.14
1675
1681
  */
1676
1682
  get_frame_counter(): number;
1677
1683
 
@@ -1687,6 +1693,7 @@ export namespace Cogl {
1687
1693
  * <note>Some buggy Mesa drivers up to 9.0.1 may
1688
1694
  * incorrectly report non-monotonic timestamps.</note>
1689
1695
  * @returns the presentation time for the frame
1696
+ * @since 1.14
1690
1697
  */
1691
1698
  get_presentation_time_us(): number;
1692
1699
 
@@ -1700,6 +1707,7 @@ export namespace Cogl {
1700
1707
  * more reliable than using `cogl_frame_info_get_output()` followed by
1701
1708
  * `cogl_output_get_refresh_rate()`.</note>
1702
1709
  * @returns the refresh rate in Hertz
1710
+ * @since 1.14
1703
1711
  */
1704
1712
  get_refresh_rate(): number;
1705
1713
 
@@ -1804,6 +1812,7 @@ export namespace Cogl {
1804
1812
  * used. The disadvantage of relying on automatic allocation is that the
1805
1813
  * program will abort with an error message if there is an error during
1806
1814
  * automatic allocation.</note>
1815
+ * @since 1.8
1807
1816
  * @virtual
1808
1817
  */
1809
1818
  vfunc_allocate(): boolean;
@@ -1826,6 +1835,7 @@ export namespace Cogl {
1826
1835
  * program will abort with an error message if there is an error during
1827
1836
  * automatic allocation.</note>
1828
1837
  * @returns `true` if there were no error allocating the framebuffer, else `false`.
1838
+ * @since 1.8
1829
1839
  */
1830
1840
  allocate(): boolean;
1831
1841
 
@@ -1834,6 +1844,7 @@ export namespace Cogl {
1834
1844
  * that includes the color buffer then the specified `color` is used.
1835
1845
  * @param buffers A mask of {@link Cogl.BufferBit}<!-- -->'s identifying which auxiliary buffers to clear
1836
1846
  * @param color The color to clear the color buffer too if specified in `buffers`.
1847
+ * @since 1.8
1837
1848
  */
1838
1849
  clear(buffers: bigint | number, color: Color): void;
1839
1850
 
@@ -1845,6 +1856,7 @@ export namespace Cogl {
1845
1856
  * @param green The green component of color to clear the color buffer too if specified in `buffers`.
1846
1857
  * @param blue The blue component of color to clear the color buffer too if specified in `buffers`.
1847
1858
  * @param alpha The alpha component of color to clear the color buffer too if specified in `buffers`.
1859
+ * @since 1.8
1848
1860
  */
1849
1861
  clear4f(buffers: bigint | number, red: number, green: number, blue: number, alpha: number): void;
1850
1862
 
@@ -1866,6 +1878,7 @@ export namespace Cogl {
1866
1878
  * framebuffer, and it's not meaningful to try and discard the color buffer of
1867
1879
  * a {@link Cogl.Offscreen} framebuffer since they are single-buffered.
1868
1880
  * @param buffers A {@link Cogl.BufferBit} mask of which ancillary buffers you want to discard.
1881
+ * @since 1.8
1869
1882
  */
1870
1883
  discard_buffers(buffers: bigint | number): void;
1871
1884
 
@@ -1915,6 +1928,7 @@ export namespace Cogl {
1915
1928
  * @param y_2 y coordinate lower right on screen.
1916
1929
  * @param tex_coords An array containing groups of 4 float values: [s_1, t_1, s_2, t_2] that are interpreted as two texture coordinates; one for the top left texel, and one for the bottom right texel. Each value should be between 0.0 and 1.0, where the coordinate (0.0, 0.0) represents the top left of the texture, and (1.0, 1.0) the bottom right.
1917
1930
  * @param tex_coords_len The length of the `tex_coords` array. (For one layer and one group of texture coordinates, this would be 4)
1931
+ * @since 1.10
1918
1932
  */
1919
1933
  draw_multitextured_rectangle(pipeline: Pipeline, x_1: number, y_1: number, x_2: number, y_2: number, tex_coords: number[], tex_coords_len: number): void;
1920
1934
 
@@ -1935,6 +1949,7 @@ export namespace Cogl {
1935
1949
  * @param y_1 Y coordinate of the top-left corner
1936
1950
  * @param x_2 X coordinate of the bottom-right corner
1937
1951
  * @param y_2 Y coordinate of the bottom-right corner
1952
+ * @since 1.10
1938
1953
  */
1939
1954
  draw_rectangle(pipeline: Pipeline, x_1: number, y_1: number, x_2: number, y_2: number): void;
1940
1955
 
@@ -1961,6 +1976,7 @@ export namespace Cogl {
1961
1976
  * @param pipeline A {@link Cogl.Pipeline} state object
1962
1977
  * @param coordinates an array of coordinates containing groups of 4 float values: [x_1, y_1, x_2, y_2] that are interpreted as two position coordinates; one for the top left of the rectangle (x1, y1), and one for the bottom right of the rectangle (x2, y2).
1963
1978
  * @param n_rectangles number of rectangles defined in `coordinates`.
1979
+ * @since 1.10
1964
1980
  */
1965
1981
  draw_rectangles(pipeline: Pipeline, coordinates: number[], n_rectangles: number): void;
1966
1982
 
@@ -2000,6 +2016,7 @@ export namespace Cogl {
2000
2016
  * @param t_1 T texture coordinate of the top-left coorner
2001
2017
  * @param s_2 S texture coordinate of the bottom-right coorner
2002
2018
  * @param t_2 T texture coordinate of the bottom-right coorner
2019
+ * @since 1.10
2003
2020
  */
2004
2021
  draw_textured_rectangle(pipeline: Pipeline, x_1: number, y_1: number, x_2: number, y_2: number, s_1: number, t_1: number, s_2: number, t_2: number): void;
2005
2022
 
@@ -2041,6 +2058,7 @@ export namespace Cogl {
2041
2058
  * @param pipeline A {@link Cogl.Pipeline} state object
2042
2059
  * @param coordinates an array containing groups of 8 float values: [x_1, y_1, x_2, y_2, s_1, t_1, s_2, t_2] that have the same meaning as the arguments for `cogl_framebuffer_draw_textured_rectangle()`.
2043
2060
  * @param n_rectangles number of rectangles to `coordinates` to draw
2061
+ * @since 1.10
2044
2062
  */
2045
2063
  draw_textured_rectangles(pipeline: Pipeline, coordinates: number[], n_rectangles: number): void;
2046
2064
 
@@ -2054,6 +2072,7 @@ export namespace Cogl {
2054
2072
  * One example might be for benchmarking purposes to be sure timing
2055
2073
  * measurements reflect the time that the GPU is busy for not just the time it
2056
2074
  * takes to queue rendering commands.
2075
+ * @since 1.10
2057
2076
  */
2058
2077
  finish(): void;
2059
2078
 
@@ -2075,18 +2094,21 @@ export namespace Cogl {
2075
2094
  * @param top Y position of the top clipping plane where it intersects the near clipping plane
2076
2095
  * @param z_near The distance to the near clipping plane (Must be positive)
2077
2096
  * @param z_far The distance to the far clipping plane (Must be positive)
2097
+ * @since 1.10
2078
2098
  */
2079
2099
  frustum(left: number, right: number, bottom: number, top: number, z_near: number, z_far: number): void;
2080
2100
 
2081
2101
  /**
2082
2102
  * Retrieves the number of alpha bits of `framebuffer`
2083
2103
  * @returns the number of bits
2104
+ * @since 1.8
2084
2105
  */
2085
2106
  get_alpha_bits(): number;
2086
2107
 
2087
2108
  /**
2088
2109
  * Retrieves the number of blue bits of `framebuffer`
2089
2110
  * @returns the number of bits
2111
+ * @since 1.8
2090
2112
  */
2091
2113
  get_blue_bits(): number;
2092
2114
 
@@ -2095,12 +2117,14 @@ export namespace Cogl {
2095
2117
  * instantiated within. This is the {@link Cogl.Context} that was passed to
2096
2118
  * `cogl_onscreen_new()` for example.
2097
2119
  * @returns The {@link Cogl.Context} that the given `framebuffer` was instantiated within.
2120
+ * @since 1.8
2098
2121
  */
2099
2122
  get_context(): Context;
2100
2123
 
2101
2124
  /**
2102
2125
  * Retrieves the number of depth bits of `framebuffer`
2103
2126
  * @returns the number of bits
2127
+ * @since 2.0
2104
2128
  */
2105
2129
  get_depth_bits(): number;
2106
2130
 
@@ -2108,6 +2132,7 @@ export namespace Cogl {
2108
2132
  * Queries whether depth buffer writing is enabled for `framebuffer`. This
2109
2133
  * can be controlled via `cogl_framebuffer_set_depth_write_enabled()`.
2110
2134
  * @returns `true` if depth writing is enabled or `false` if not.
2135
+ * @since 1.18
2111
2136
  */
2112
2137
  get_depth_write_enabled(): boolean;
2113
2138
 
@@ -2119,18 +2144,21 @@ export namespace Cogl {
2119
2144
  * display pipeline does not support dithering. This value only represents
2120
2145
  * the user's request for dithering.</note>
2121
2146
  * @returns `true` if dithering has been requested or `false` if not.
2147
+ * @since 1.8
2122
2148
  */
2123
2149
  get_dither_enabled(): boolean;
2124
2150
 
2125
2151
  /**
2126
2152
  * Retrieves the number of green bits of `framebuffer`
2127
2153
  * @returns the number of bits
2154
+ * @since 1.8
2128
2155
  */
2129
2156
  get_green_bits(): number;
2130
2157
 
2131
2158
  /**
2132
2159
  * Queries the current height of the given `framebuffer`.
2133
2160
  * @returns The height of `framebuffer`.
2161
+ * @since 1.8
2134
2162
  */
2135
2163
  get_height(): number;
2136
2164
 
@@ -2138,17 +2166,20 @@ export namespace Cogl {
2138
2166
 
2139
2167
  /**
2140
2168
  * Stores the current model-view matrix in `matrix`.
2169
+ * @since 1.10
2141
2170
  */
2142
2171
  get_modelview_matrix(): Graphene.Matrix;
2143
2172
 
2144
2173
  /**
2145
2174
  * Stores the current projection matrix in `matrix`.
2175
+ * @since 1.10
2146
2176
  */
2147
2177
  get_projection_matrix(): Graphene.Matrix;
2148
2178
 
2149
2179
  /**
2150
2180
  * Retrieves the number of red bits of `framebuffer`
2151
2181
  * @returns the number of bits
2182
+ * @since 1.8
2152
2183
  */
2153
2184
  get_red_bits(): number;
2154
2185
 
@@ -2166,6 +2197,7 @@ export namespace Cogl {
2166
2197
  * framebuffer has been allocated the value will reflect the actual
2167
2198
  * number of samples that will be made by the GPU.
2168
2199
  * @returns The number of point samples made per pixel when rasterizing geometry or 0 if single-sample rendering has been chosen.
2200
+ * @since 1.10
2169
2201
  */
2170
2202
  get_samples_per_pixel(): number;
2171
2203
 
@@ -2173,6 +2205,7 @@ export namespace Cogl {
2173
2205
  * Gets the current {@link Cogl.StereoMode}, which defines which stereo buffers
2174
2206
  * should be drawn to. See `cogl_framebuffer_set_stereo_mode()`.
2175
2207
  * @returns A {@link Cogl.StereoMode}
2208
+ * @since 1.20
2176
2209
  */
2177
2210
  get_stereo_mode(): StereoMode;
2178
2211
 
@@ -2181,6 +2214,7 @@ export namespace Cogl {
2181
2214
  * using `cogl_framebuffer_set_viewport()` or the default values which are 0, 0,
2182
2215
  * framebuffer_width and framebuffer_height. The values are written into the
2183
2216
  * given `viewport` array.
2217
+ * @since 1.8
2184
2218
  */
2185
2219
  get_viewport4fv(): number[];
2186
2220
 
@@ -2188,6 +2222,7 @@ export namespace Cogl {
2188
2222
  * Queries the height of the viewport as set using `cogl_framebuffer_set_viewport()`
2189
2223
  * or the default value which is the height of the framebuffer.
2190
2224
  * @returns The height of the viewport.
2225
+ * @since 1.8
2191
2226
  */
2192
2227
  get_viewport_height(): number;
2193
2228
 
@@ -2195,6 +2230,7 @@ export namespace Cogl {
2195
2230
  * Queries the width of the viewport as set using `cogl_framebuffer_set_viewport()`
2196
2231
  * or the default value which is the width of the framebuffer.
2197
2232
  * @returns The width of the viewport.
2233
+ * @since 1.8
2198
2234
  */
2199
2235
  get_viewport_width(): number;
2200
2236
 
@@ -2202,6 +2238,7 @@ export namespace Cogl {
2202
2238
  * Queries the x coordinate of the viewport origin as set using `cogl_framebuffer_set_viewport()`
2203
2239
  * or the default value which is 0.
2204
2240
  * @returns The x coordinate of the viewport origin.
2241
+ * @since 1.8
2205
2242
  */
2206
2243
  get_viewport_x(): number;
2207
2244
 
@@ -2209,17 +2246,20 @@ export namespace Cogl {
2209
2246
  * Queries the y coordinate of the viewport origin as set using `cogl_framebuffer_set_viewport()`
2210
2247
  * or the default value which is 0.
2211
2248
  * @returns The y coordinate of the viewport origin.
2249
+ * @since 1.8
2212
2250
  */
2213
2251
  get_viewport_y(): number;
2214
2252
 
2215
2253
  /**
2216
2254
  * Queries the current width of the given `framebuffer`.
2217
2255
  * @returns The width of `framebuffer`.
2256
+ * @since 1.8
2218
2257
  */
2219
2258
  get_width(): number;
2220
2259
 
2221
2260
  /**
2222
2261
  * Resets the current model-view matrix to the identity matrix.
2262
+ * @since 1.10
2223
2263
  */
2224
2264
  identity_matrix(): void;
2225
2265
 
@@ -2232,6 +2272,7 @@ export namespace Cogl {
2232
2272
  * @param y_2 The y coordinate for the second horizontal clipping plane
2233
2273
  * @param near The <emphasis>distance</emphasis> to the near clipping plane (will be <emphasis>negative</emphasis> if the plane is behind the viewer)
2234
2274
  * @param far The <emphasis>distance</emphasis> to the far clipping plane (will be <emphasis>negative</emphasis> if the plane is behind the viewer)
2275
+ * @since 1.10
2235
2276
  */
2236
2277
  orthographic(x_1: number, y_1: number, x_2: number, y_2: number, near: number, far: number): void;
2237
2278
 
@@ -2247,6 +2288,7 @@ export namespace Cogl {
2247
2288
  * @param aspect The (width over height) aspect ratio for display
2248
2289
  * @param z_near The distance to the near clipping plane (Must be positive, and must not be 0)
2249
2290
  * @param z_far The distance to the far clipping plane (Must be positive)
2291
+ * @since 1.10
2250
2292
  */
2251
2293
  perspective(fov_y: number, aspect: number, z_near: number, z_far: number): void;
2252
2294
 
@@ -2254,17 +2296,20 @@ export namespace Cogl {
2254
2296
  * Reverts the clipping region to the state before the last call to
2255
2297
  * `cogl_framebuffer_push_scissor_clip()`, `cogl_framebuffer_push_rectangle_clip()`
2256
2298
  * `cogl_framebuffer_push_path_clip()`, or `cogl_framebuffer_push_primitive_clip()`.
2299
+ * @since 1.10
2257
2300
  */
2258
2301
  pop_clip(): void;
2259
2302
 
2260
2303
  /**
2261
2304
  * Restores the model-view matrix on the top of the matrix stack.
2305
+ * @since 1.10
2262
2306
  */
2263
2307
  pop_matrix(): void;
2264
2308
 
2265
2309
  /**
2266
2310
  * Copies the current model-view matrix onto the matrix stack. The matrix
2267
2311
  * can later be restored with `cogl_framebuffer_pop_matrix()`.
2312
+ * @since 1.10
2268
2313
  */
2269
2314
  push_matrix(): void;
2270
2315
 
@@ -2281,6 +2326,7 @@ export namespace Cogl {
2281
2326
  * @param y_1 y coordinate for top left corner of the clip rectangle
2282
2327
  * @param x_2 x coordinate for bottom right corner of the clip rectangle
2283
2328
  * @param y_2 y coordinate for bottom right corner of the clip rectangle
2329
+ * @since 1.10
2284
2330
  */
2285
2331
  push_rectangle_clip(x_1: number, y_1: number, x_2: number, y_2: number): void;
2286
2332
 
@@ -2302,6 +2348,7 @@ export namespace Cogl {
2302
2348
  * @param y top edge of the clip rectangle in window coordinates
2303
2349
  * @param width width of the clip rectangle
2304
2350
  * @param height height of the clip rectangle
2351
+ * @since 1.10
2305
2352
  */
2306
2353
  push_scissor_clip(x: number, y: number, width: number, height: number): void;
2307
2354
 
@@ -2339,6 +2386,7 @@ export namespace Cogl {
2339
2386
  * @param format The pixel format to store the data in
2340
2387
  * @param pixels The address of the buffer to store the data in
2341
2388
  * @returns `true` if the read succeeded or `false` otherwise.
2389
+ * @since 1.10
2342
2390
  */
2343
2391
  read_pixels(x: number, y: number, width: number, height: number, format: PixelFormat, pixels: number): boolean;
2344
2392
 
@@ -2358,6 +2406,7 @@ export namespace Cogl {
2358
2406
  * @param source Identifies which auxiliary buffer you want to read (only COGL_READ_PIXELS_COLOR_BUFFER supported currently)
2359
2407
  * @param bitmap The bitmap to store the results in.
2360
2408
  * @returns `true` if the read succeeded or `false` otherwise. The function is only likely to fail if the bitmap points to a pixel buffer and it could not be mapped.
2409
+ * @since 1.10
2361
2410
  */
2362
2411
  read_pixels_into_bitmap(x: number, y: number, source: ReadPixelsFlags, bitmap: Bitmap): boolean;
2363
2412
 
@@ -2382,6 +2431,7 @@ export namespace Cogl {
2382
2431
  * If you are performing incremental updates to a framebuffer you
2383
2432
  * should consider using `cogl_framebuffer_resolve_samples_region()`
2384
2433
  * instead to avoid resolving redundant pixels.
2434
+ * @since 1.8
2385
2435
  */
2386
2436
  resolve_samples(): void;
2387
2437
 
@@ -2411,6 +2461,7 @@ export namespace Cogl {
2411
2461
  * @param y top-left y coordinate of region to resolve
2412
2462
  * @param width width of region to resolve
2413
2463
  * @param height height of region to resolve
2464
+ * @since 1.8
2414
2465
  */
2415
2466
  resolve_samples_region(x: number, y: number, width: number, height: number): void;
2416
2467
 
@@ -2424,6 +2475,7 @@ export namespace Cogl {
2424
2475
  * @param x X-component of vertex to rotate around.
2425
2476
  * @param y Y-component of vertex to rotate around.
2426
2477
  * @param z Z-component of vertex to rotate around.
2478
+ * @since 1.10
2427
2479
  */
2428
2480
  rotate(angle: number, x: number, y: number, z: number): void;
2429
2481
 
@@ -2431,6 +2483,7 @@ export namespace Cogl {
2431
2483
  * Multiplies the current model-view matrix by one that rotates
2432
2484
  * according to the rotation described by `euler`.
2433
2485
  * @param euler A {@link Graphene.Euler}
2486
+ * @since 2.0
2434
2487
  */
2435
2488
  rotate_euler(euler: Graphene.Euler): void;
2436
2489
 
@@ -2440,6 +2493,7 @@ export namespace Cogl {
2440
2493
  * @param x Amount to scale along the x-axis
2441
2494
  * @param y Amount to scale along the y-axis
2442
2495
  * @param z Amount to scale along the z-axis
2496
+ * @since 1.10
2443
2497
  */
2444
2498
  scale(x: number, y: number, z: number): void;
2445
2499
 
@@ -2451,6 +2505,7 @@ export namespace Cogl {
2451
2505
  *
2452
2506
  * Depth buffer writing is enabled by default.
2453
2507
  * @param depth_write_enabled `true` to enable depth writing or `false` to disable
2508
+ * @since 1.18
2454
2509
  */
2455
2510
  set_depth_write_enabled(depth_write_enabled: boolean): void;
2456
2511
 
@@ -2469,18 +2524,21 @@ export namespace Cogl {
2469
2524
  *
2470
2525
  * Dithering is enabled by default.
2471
2526
  * @param dither_enabled `true` to enable dithering or `false` to disable
2527
+ * @since 1.8
2472
2528
  */
2473
2529
  set_dither_enabled(dither_enabled: boolean): void;
2474
2530
 
2475
2531
  /**
2476
2532
  * Sets `matrix` as the new model-view matrix.
2477
2533
  * @param matrix the new model-view matrix
2534
+ * @since 1.10
2478
2535
  */
2479
2536
  set_modelview_matrix(matrix: Graphene.Matrix): void;
2480
2537
 
2481
2538
  /**
2482
2539
  * Sets `matrix` as the new projection matrix.
2483
2540
  * @param matrix the new projection matrix
2541
+ * @since 1.10
2484
2542
  */
2485
2543
  set_projection_matrix(matrix: Graphene.Matrix): void;
2486
2544
 
@@ -2518,6 +2576,7 @@ export namespace Cogl {
2518
2576
  * framebuffer has changed this can lead to redundant work being
2519
2577
  * done.</note>
2520
2578
  * @param samples_per_pixel The minimum number of samples per pixel
2579
+ * @since 1.8
2521
2580
  */
2522
2581
  set_samples_per_pixel(samples_per_pixel: number): void;
2523
2582
 
@@ -2530,6 +2589,7 @@ export namespace Cogl {
2530
2589
  * enabled. (See `cogl_onscreen_template_set_stereo_enabled()`,
2531
2590
  * `cogl_framebuffer_get_is_stereo()`.)
2532
2591
  * @param stereo_mode A {@link Cogl.StereoMode} specifying which stereo buffers should be drawn tow.
2592
+ * @since 1.20
2533
2593
  */
2534
2594
  set_stereo_mode(stereo_mode: StereoMode): void;
2535
2595
 
@@ -2553,12 +2613,14 @@ export namespace Cogl {
2553
2613
  * @param y The top-left y coordinate of the viewport origin (only integers supported currently)
2554
2614
  * @param width The width of the viewport (only integers supported currently)
2555
2615
  * @param height The height of the viewport (only integers supported currently)
2616
+ * @since 1.8
2556
2617
  */
2557
2618
  set_viewport(x: number, y: number, width: number, height: number): void;
2558
2619
 
2559
2620
  /**
2560
2621
  * Multiplies the current model-view matrix by the given matrix.
2561
2622
  * @param matrix the matrix to multiply with the current model-view
2623
+ * @since 1.10
2562
2624
  */
2563
2625
  transform(matrix: Graphene.Matrix): void;
2564
2626
 
@@ -2568,6 +2630,7 @@ export namespace Cogl {
2568
2630
  * @param x Distance to translate along the x-axis
2569
2631
  * @param y Distance to translate along the y-axis
2570
2632
  * @param z Distance to translate along the z-axis
2633
+ * @since 1.10
2571
2634
  */
2572
2635
  translate(x: number, y: number, z: number): void;
2573
2636
  }
@@ -2741,6 +2804,7 @@ export namespace Cogl {
2741
2804
  * explicitly checked to determine if Cogl is currently tracking the
2742
2805
  * age of {@link Cogl.Onscreen} back buffer contents. If this feature is
2743
2806
  * missing then this function will always return 0.</note>
2807
+ * @since 1.14
2744
2808
  * @virtual
2745
2809
  */
2746
2810
  vfunc_get_buffer_age(): number;
@@ -2797,6 +2861,7 @@ export namespace Cogl {
2797
2861
  * @param rectangles An array of integer 4-tuples representing damaged rectangles as (x, y, width, height) tuples.
2798
2862
  * @param n_rectangles The number of 4-tuples to be read from `rectangles`
2799
2863
  * @param info
2864
+ * @since 1.16
2800
2865
  * @virtual
2801
2866
  */
2802
2867
  vfunc_swap_buffers_with_damage(rectangles: number, n_rectangles: number, info: FrameInfo): void;
@@ -2814,6 +2879,7 @@ export namespace Cogl {
2814
2879
  * @param rectangles An array of integer 4-tuples representing rectangles as (x, y, width, height) tuples.
2815
2880
  * @param n_rectangles The number of 4-tuples to be read from `rectangles`
2816
2881
  * @param info
2882
+ * @since 1.10
2817
2883
  * @virtual
2818
2884
  */
2819
2885
  vfunc_swap_region(rectangles: number, n_rectangles: number, info: FrameInfo): void;
@@ -2839,6 +2905,7 @@ export namespace Cogl {
2839
2905
  * @param callback A callback function to call for dirty events
2840
2906
  * @param destroy An optional callback to destroy `user_data` when the `callback` is removed or `onscreen` is freed.
2841
2907
  * @returns a {@link Cogl.OnscreenDirtyClosure} pointer that can be used to remove the callback and associated `user_data` later.
2908
+ * @since 1.16
2842
2909
  */
2843
2910
  add_dirty_callback(callback: OnscreenDirtyCallback, destroy: UserDataDestroyCallback | null): OnscreenDirtyClosure;
2844
2911
 
@@ -2869,6 +2936,7 @@ export namespace Cogl {
2869
2936
  * @param callback A callback function to call for frame events
2870
2937
  * @param destroy An optional callback to destroy `user_data` when the `callback` is removed or `onscreen` is freed.
2871
2938
  * @returns a {@link Cogl.FrameClosure} pointer that can be used to remove the callback and associated `user_data` later.
2939
+ * @since 1.14
2872
2940
  */
2873
2941
  add_frame_callback(callback: FrameCallback, destroy: UserDataDestroyCallback | null): FrameClosure;
2874
2942
 
@@ -2912,6 +2980,7 @@ export namespace Cogl {
2912
2980
  * age of {@link Cogl.Onscreen} back buffer contents. If this feature is
2913
2981
  * missing then this function will always return 0.</note>
2914
2982
  * @returns The age of the buffer contents or 0 when the buffer contents are undefined.
2983
+ * @since 1.14
2915
2984
  */
2916
2985
  get_buffer_age(): number;
2917
2986
 
@@ -2921,6 +2990,7 @@ export namespace Cogl {
2921
2990
  * `cogl_onscreen_swap_buffers()` or `cogl_onscreen_swap_region()`
2922
2991
  * is called.
2923
2992
  * @returns the current frame counter value
2993
+ * @since 1.14
2924
2994
  */
2925
2995
  get_frame_counter(): number;
2926
2996
 
@@ -2939,6 +3009,7 @@ export namespace Cogl {
2939
3009
  * requests e.g. to show an already visible window. This also means
2940
3010
  * that it's acceptable to alternatively use native APIs to show and
2941
3011
  * hide windows without confusing Cogl.</note>
3012
+ * @since 2.0
2942
3013
  */
2943
3014
  hide(): void;
2944
3015
 
@@ -2960,6 +3031,7 @@ export namespace Cogl {
2960
3031
  * `cogl_onscreen_add_dirty_callback()` to destroy the user data then
2961
3032
  * this will also get called.
2962
3033
  * @param closure A {@link Cogl.OnscreenDirtyClosure} returned from `cogl_onscreen_add_dirty_callback()`
3034
+ * @since 1.16
2963
3035
  */
2964
3036
  remove_dirty_callback(closure: OnscreenDirtyClosure): void;
2965
3037
 
@@ -2971,6 +3043,7 @@ export namespace Cogl {
2971
3043
  * `cogl_onscreen_add_frame_callback()` to destroy the user data then
2972
3044
  * this will get called.
2973
3045
  * @param closure A {@link Cogl.FrameClosure} returned from `cogl_onscreen_add_frame_callback()`
3046
+ * @since 1.14
2974
3047
  */
2975
3048
  remove_frame_callback(closure: FrameClosure): void;
2976
3049
 
@@ -2995,6 +3068,7 @@ export namespace Cogl {
2995
3068
  * requests e.g. to show an already visible window. This also means
2996
3069
  * that it's acceptable to alternatively use native APIs to show and
2997
3070
  * hide windows without confusing Cogl.</note>
3071
+ * @since 2.0
2998
3072
  */
2999
3073
  show(): void;
3000
3074
 
@@ -3014,6 +3088,7 @@ export namespace Cogl {
3014
3088
  * render a full buffer for every frame.</note>
3015
3089
  * @param frame_info
3016
3090
  * @param user_data
3091
+ * @since 1.10
3017
3092
  */
3018
3093
  swap_buffers(frame_info: FrameInfo, user_data: null): void;
3019
3094
 
@@ -3059,6 +3134,7 @@ export namespace Cogl {
3059
3134
  * @param n_rectangles The number of 4-tuples to be read from `rectangles`
3060
3135
  * @param info
3061
3136
  * @param user_data
3137
+ * @since 1.16
3062
3138
  */
3063
3139
  swap_buffers_with_damage(rectangles: number, n_rectangles: number, info: FrameInfo, user_data: null): void;
3064
3140
 
@@ -3076,6 +3152,7 @@ export namespace Cogl {
3076
3152
  * @param n_rectangles The number of 4-tuples to be read from `rectangles`
3077
3153
  * @param info
3078
3154
  * @param user_data
3155
+ * @since 1.10
3079
3156
  */
3080
3157
  swap_region(rectangles: number, n_rectangles: number, info: FrameInfo, user_data: null): void;
3081
3158
  }
@@ -3121,32 +3198,38 @@ export namespace Cogl {
3121
3198
  * keep track of a pipelines ancestry which we may use to help minimize GPU
3122
3199
  * state changes.
3123
3200
  * @returns a pointer to the newly allocated {@link Cogl.Pipeline}
3201
+ * @since 2.0
3124
3202
  */
3125
3203
  copy(): Pipeline;
3126
3204
 
3127
3205
  /**
3128
3206
  * Iterates all the layer indices of the given `pipeline`.
3129
3207
  * @param callback A {@link Cogl.PipelineLayerCallback} to be called for each layer index
3208
+ * @since 2.0
3130
3209
  */
3131
3210
  foreach_layer(callback: PipelineLayerCallback): void;
3132
3211
 
3133
3212
  /**
3134
3213
  * @returns The alpha test function of `pipeline`.
3214
+ * @since 2.0
3135
3215
  */
3136
3216
  get_alpha_test_function(): PipelineAlphaFunc;
3137
3217
 
3138
3218
  /**
3139
3219
  * @returns The alpha test reference value of `pipeline`.
3220
+ * @since 2.0
3140
3221
  */
3141
3222
  get_alpha_test_reference(): number;
3142
3223
 
3143
3224
  /**
3144
3225
  * Retrieves the current pipeline color.
3226
+ * @since 2.0
3145
3227
  */
3146
3228
  get_color(): Color;
3147
3229
 
3148
3230
  /**
3149
3231
  * @returns the cull face mode that was previously set with `cogl_pipeline_set_cull_face_mode()`. Status: Unstable
3232
+ * @since 2.0
3150
3233
  */
3151
3234
  get_cull_face_mode(): PipelineCullFaceMode;
3152
3235
 
@@ -3159,6 +3242,7 @@ export namespace Cogl {
3159
3242
  * {@link Cogl.Winding.CLOCKWISE} sets them to be clockwise. The default is
3160
3243
  * {@link Cogl.Winding.COUNTER_CLOCKWISE}.
3161
3244
  * @returns The `pipeline` front face winding Status: Unstable
3245
+ * @since 2.0
3162
3246
  */
3163
3247
  get_front_face_winding(): Winding;
3164
3248
 
@@ -3171,6 +3255,7 @@ export namespace Cogl {
3171
3255
  * changed using `cogl_pipeline_set_layer_filters()`.
3172
3256
  * @param layer_index the layer number to change.
3173
3257
  * @returns The magnification {@link Cogl.PipelineFilter} for the specified layer.
3258
+ * @since 1.10
3174
3259
  */
3175
3260
  get_layer_mag_filter(layer_index: number): PipelineFilter;
3176
3261
 
@@ -3183,6 +3268,7 @@ export namespace Cogl {
3183
3268
  * changed using `cogl_pipeline_set_layer_filters()`.
3184
3269
  * @param layer_index the layer number to change.
3185
3270
  * @returns The minification {@link Cogl.PipelineFilter} for the specified layer.
3271
+ * @since 1.10
3186
3272
  */
3187
3273
  get_layer_min_filter(layer_index: number): PipelineFilter;
3188
3274
 
@@ -3191,12 +3277,14 @@ export namespace Cogl {
3191
3277
  * texture layer.
3192
3278
  * @param layer_index the layer number to check.
3193
3279
  * @returns whether the texture coordinates will be replaced with point sprite coordinates.
3280
+ * @since 2.0
3194
3281
  */
3195
3282
  get_layer_point_sprite_coords_enabled(layer_index: number): boolean;
3196
3283
 
3197
3284
  /**
3198
3285
  * @param layer_index the index of the layer
3199
3286
  * @returns the texture that was set for the given layer of the pipeline or `null` if no texture was set.
3287
+ * @since 1.10
3200
3288
  */
3201
3289
  get_layer_texture(layer_index: number): Texture;
3202
3290
 
@@ -3205,6 +3293,7 @@ export namespace Cogl {
3205
3293
  * layer.
3206
3294
  * @param layer_index the layer number to change.
3207
3295
  * @returns the wrap mode for the 's' coordinate of texture lookups on this layer.
3296
+ * @since 1.6
3208
3297
  */
3209
3298
  get_layer_wrap_mode_s(layer_index: number): PipelineWrapMode;
3210
3299
 
@@ -3213,17 +3302,20 @@ export namespace Cogl {
3213
3302
  * layer.
3214
3303
  * @param layer_index the layer number to change.
3215
3304
  * @returns the wrap mode for the 't' coordinate of texture lookups on this layer.
3305
+ * @since 1.6
3216
3306
  */
3217
3307
  get_layer_wrap_mode_t(layer_index: number): PipelineWrapMode;
3218
3308
 
3219
3309
  /**
3220
3310
  * Retrieves the number of layers defined for the given `pipeline`
3221
3311
  * @returns the number of layers
3312
+ * @since 2.0
3222
3313
  */
3223
3314
  get_n_layers(): number;
3224
3315
 
3225
3316
  /**
3226
3317
  * @returns `true` if the pipeline has per-vertex point size enabled or `false` otherwise. The per-vertex point size can be enabled with `cogl_pipeline_set_per_vertex_point_size()`.
3318
+ * @since 2.0
3227
3319
  */
3228
3320
  get_per_vertex_point_size(): boolean;
3229
3321
 
@@ -3231,6 +3323,7 @@ export namespace Cogl {
3231
3323
  * Get the size of points drawn when {@link Cogl.VerticesMode.POINTS} is
3232
3324
  * used with the vertex buffer API.
3233
3325
  * @returns the point size of the `pipeline`.
3326
+ * @since 2.0
3234
3327
  */
3235
3328
  get_point_size(): number;
3236
3329
 
@@ -3246,6 +3339,7 @@ export namespace Cogl {
3246
3339
  * before calling this function.
3247
3340
  * @param uniform_name The name of a uniform
3248
3341
  * @returns A integer representing the location of the given uniform.
3342
+ * @since 2.0
3249
3343
  */
3250
3344
  get_uniform_location(uniform_name: string): number;
3251
3345
 
@@ -3253,12 +3347,14 @@ export namespace Cogl {
3253
3347
  * Queries what user program has been associated with the given
3254
3348
  * `pipeline` using `cogl_pipeline_set_user_program()`.
3255
3349
  * @returns The current user program or `null`.
3350
+ * @since 2.0
3256
3351
  */
3257
3352
  get_user_program(): Handle;
3258
3353
 
3259
3354
  /**
3260
3355
  * This function removes a layer from your pipeline
3261
3356
  * @param layer_index Specifies the layer you want to remove
3357
+ * @since 1.10
3262
3358
  */
3263
3359
  remove_layer(layer_index: number): void;
3264
3360
 
@@ -3272,6 +3368,7 @@ export namespace Cogl {
3272
3368
  * The default is {@link Cogl.PipelineAlphaFunc.ALWAYS}
3273
3369
  * @param alpha_func A `CoglPipelineAlphaFunc` constant
3274
3370
  * @param alpha_reference A reference point that the chosen alpha function uses to compare incoming fragments to.
3371
+ * @since 2.0
3275
3372
  */
3276
3373
  set_alpha_test_function(alpha_func: PipelineAlphaFunc, alpha_reference: number): void;
3277
3374
 
@@ -3343,6 +3440,7 @@ export namespace Cogl {
3343
3440
  * is in premultiplied form.
3344
3441
  * @param blend_string A <link linkend="cogl-Blend-Strings">Cogl blend string</link> describing the desired blend function.
3345
3442
  * @returns `true` if the blend string was successfully parsed, and the described blending is supported by the underlying driver/hardware. If there was an error, `false` is returned and `error` is set accordingly (if present).
3443
+ * @since 2.0
3346
3444
  */
3347
3445
  set_blend(blend_string: string): boolean;
3348
3446
 
@@ -3350,6 +3448,7 @@ export namespace Cogl {
3350
3448
  * When blending is setup to reference a CONSTANT blend factor then
3351
3449
  * blending will depend on the constant set with this function.
3352
3450
  * @param constant_color The constant color you want
3451
+ * @since 2.0
3353
3452
  */
3354
3453
  set_blend_constant(constant_color: Color): void;
3355
3454
 
@@ -3363,6 +3462,7 @@ export namespace Cogl {
3363
3462
  *
3364
3463
  * The default value is (1.0, 1.0, 1.0, 1.0)
3365
3464
  * @param color The components of the color
3465
+ * @since 2.0
3366
3466
  */
3367
3467
  set_color(color: Color): void;
3368
3468
 
@@ -3374,6 +3474,7 @@ export namespace Cogl {
3374
3474
  * @param green The green component
3375
3475
  * @param blue The blue component
3376
3476
  * @param alpha The alpha component
3477
+ * @since 2.0
3377
3478
  */
3378
3479
  set_color4f(red: number, green: number, blue: number, alpha: number): void;
3379
3480
 
@@ -3385,6 +3486,7 @@ export namespace Cogl {
3385
3486
  * @param green The green component
3386
3487
  * @param blue The blue component
3387
3488
  * @param alpha The alpha component
3489
+ * @since 2.0
3388
3490
  */
3389
3491
  set_color4ub(red: number, green: number, blue: number, alpha: number): void;
3390
3492
 
@@ -3404,6 +3506,7 @@ export namespace Cogl {
3404
3506
  *
3405
3507
  * Status: Unstable
3406
3508
  * @param cull_face_mode The new mode to set
3509
+ * @since 2.0
3407
3510
  */
3408
3511
  set_cull_face_mode(cull_face_mode: PipelineCullFaceMode): void;
3409
3512
 
@@ -3418,6 +3521,7 @@ export namespace Cogl {
3418
3521
  *
3419
3522
  * Status: Unstable
3420
3523
  * @param front_winding the winding order
3524
+ * @since 2.0
3421
3525
  */
3422
3526
  set_front_face_winding(front_winding: Winding): void;
3423
3527
 
@@ -3501,6 +3605,7 @@ export namespace Cogl {
3501
3605
  * @param layer_index Specifies the layer you want define a combine function for
3502
3606
  * @param blend_string A <link linkend="cogl-Blend-Strings">Cogl blend string</link> describing the desired texture combine function.
3503
3607
  * @returns `true` if the blend string was successfully parsed, and the described texture combining is supported by the underlying driver and or hardware. On failure, `false` is returned and `error` is set
3608
+ * @since 2.0
3504
3609
  */
3505
3610
  set_layer_combine(layer_index: number, blend_string: string): boolean;
3506
3611
 
@@ -3509,6 +3614,7 @@ export namespace Cogl {
3509
3614
  * description then you can use this function to define its value.
3510
3615
  * @param layer_index Specifies the layer you want to specify a constant used for texture combining
3511
3616
  * @param constant The constant color you want
3617
+ * @since 2.0
3512
3618
  */
3513
3619
  set_layer_combine_constant(layer_index: number, constant: Color): void;
3514
3620
 
@@ -3523,6 +3629,7 @@ export namespace Cogl {
3523
3629
  * @param layer_index the layer number to change.
3524
3630
  * @param min_filter the filter used when scaling a texture down.
3525
3631
  * @param mag_filter the filter used when magnifying a texture.
3632
+ * @since 1.10
3526
3633
  */
3527
3634
  set_layer_filters(layer_index: number, min_filter: PipelineFilter, mag_filter: PipelineFilter): void;
3528
3635
 
@@ -3531,6 +3638,7 @@ export namespace Cogl {
3531
3638
  * and rotate a single layer of a pipeline used to fill your geometry.
3532
3639
  * @param layer_index the index for the layer inside `pipeline`
3533
3640
  * @param matrix the transformation matrix for the layer
3641
+ * @since 1.10
3534
3642
  */
3535
3643
  set_layer_matrix(layer_index: number, matrix: Graphene.Matrix): void;
3536
3644
 
@@ -3550,6 +3658,7 @@ export namespace Cogl {
3550
3658
  * specify the texture type so that any pipeline copies can share the
3551
3659
  * internal texture type state for efficiency.
3552
3660
  * @param layer_index The layer number to modify
3661
+ * @since 1.10
3553
3662
  */
3554
3663
  set_layer_null_texture(layer_index: number): void;
3555
3664
 
@@ -3563,6 +3672,7 @@ export namespace Cogl {
3563
3672
  * @param layer_index the layer number to change.
3564
3673
  * @param enable whether to enable point sprite coord generation.
3565
3674
  * @returns `true` if the function succeeds, `false` otherwise.
3675
+ * @since 2.0
3566
3676
  */
3567
3677
  set_layer_point_sprite_coords_enabled(layer_index: number, enable: boolean): boolean;
3568
3678
 
@@ -3579,6 +3689,7 @@ export namespace Cogl {
3579
3689
  * `cogl_pipeline_set_layer_wrap_mode_t()` separately.
3580
3690
  * @param layer_index the layer number to change.
3581
3691
  * @param mode the new wrap mode
3692
+ * @since 2.0
3582
3693
  */
3583
3694
  set_layer_wrap_mode(layer_index: number, mode: PipelineWrapMode): void;
3584
3695
 
@@ -3586,6 +3697,7 @@ export namespace Cogl {
3586
3697
  * Sets the wrap mode for the 's' coordinate of texture lookups on this layer.
3587
3698
  * @param layer_index the layer number to change.
3588
3699
  * @param mode the new wrap mode
3700
+ * @since 2.0
3589
3701
  */
3590
3702
  set_layer_wrap_mode_s(layer_index: number, mode: PipelineWrapMode): void;
3591
3703
 
@@ -3593,6 +3705,7 @@ export namespace Cogl {
3593
3705
  * Sets the wrap mode for the 't' coordinate of texture lookups on this layer.
3594
3706
  * @param layer_index the layer number to change.
3595
3707
  * @param mode the new wrap mode
3708
+ * @since 2.0
3596
3709
  */
3597
3710
  set_layer_wrap_mode_t(layer_index: number, mode: PipelineWrapMode): void;
3598
3711
 
@@ -3609,6 +3722,7 @@ export namespace Cogl {
3609
3722
  * undefined.
3610
3723
  * @param enable whether to enable per-vertex point size
3611
3724
  * @returns `true` if the change succeeded or `false` otherwise
3725
+ * @since 2.0
3612
3726
  */
3613
3727
  set_per_vertex_point_size(enable: boolean): boolean;
3614
3728
 
@@ -3626,6 +3740,7 @@ export namespace Cogl {
3626
3740
  * if an application wants to draw points it must make sure to use a
3627
3741
  * pipeline that has an explicit point size set on it.
3628
3742
  * @param point_size the new point size.
3743
+ * @since 2.0
3629
3744
  */
3630
3745
  set_point_size(point_size: number): void;
3631
3746
 
@@ -3642,6 +3757,7 @@ export namespace Cogl {
3642
3757
  * uniform.
3643
3758
  * @param uniform_location The uniform's location identifier
3644
3759
  * @param value The new value for the uniform
3760
+ * @since 2.0
3645
3761
  */
3646
3762
  set_uniform_1f(uniform_location: number, value: number): void;
3647
3763
 
@@ -3658,6 +3774,7 @@ export namespace Cogl {
3658
3774
  * uniform or a sampler uniform.
3659
3775
  * @param uniform_location The uniform's location identifier
3660
3776
  * @param value The new value for the uniform
3777
+ * @since 2.0
3661
3778
  */
3662
3779
  set_uniform_1i(uniform_location: number, value: number): void;
3663
3780
 
@@ -3678,6 +3795,7 @@ export namespace Cogl {
3678
3795
  * @param n_components The number of components in the corresponding uniform's type
3679
3796
  * @param count The number of values to set
3680
3797
  * @param value Pointer to the new values to set
3798
+ * @since 2.0
3681
3799
  */
3682
3800
  set_uniform_float(uniform_location: number, n_components: number, count: number, value: number): void;
3683
3801
 
@@ -3698,6 +3816,7 @@ export namespace Cogl {
3698
3816
  * @param n_components The number of components in the corresponding uniform's type
3699
3817
  * @param count The number of values to set
3700
3818
  * @param value Pointer to the new values to set
3819
+ * @since 2.0
3701
3820
  */
3702
3821
  set_uniform_int(uniform_location: number, n_components: number, count: number, value: number): void;
3703
3822
 
@@ -3724,6 +3843,7 @@ export namespace Cogl {
3724
3843
  * @param count The number of values to set
3725
3844
  * @param transpose Whether to transpose the matrix
3726
3845
  * @param value Pointer to the new values to set
3846
+ * @since 2.0
3727
3847
  */
3728
3848
  set_uniform_matrix(uniform_location: number, dimensions: number, count: number, transpose: boolean, value: number): void;
3729
3849
 
@@ -3764,6 +3884,7 @@ export namespace Cogl {
3764
3884
  * meantime we hope this will handle most practical GLSL and ARBfp
3765
3885
  * requirements.
3766
3886
  * @param program A {@link Cogl.Handle} to a linked CoglProgram
3887
+ * @since 2.0
3767
3888
  */
3768
3889
  set_user_program(program: Handle): void;
3769
3890
  }
@@ -3830,6 +3951,7 @@ export namespace Cogl {
3830
3951
  * is {@link Cogl.TextureComponents.RGBA}. The other constructors which take
3831
3952
  * a %CoglBitmap or a data pointer default to the same components as
3832
3953
  * the pixel format of the data.
3954
+ * @since 1.18
3833
3955
  */
3834
3956
  get_components(): TextureComponents;
3835
3957
 
@@ -3876,6 +3998,7 @@ export namespace Cogl {
3876
3998
  *
3877
3999
  * By default the pre-multipled state is `TRUE`.
3878
4000
  * @returns `true` if red, green and blue components are internally stored pre-multiplied by the alpha value or `false` if not.
4001
+ * @since 1.18
3879
4002
  */
3880
4003
  get_premultiplied(): boolean;
3881
4004
 
@@ -3913,6 +4036,7 @@ export namespace Cogl {
3913
4036
  * an image format as long as {@link Cogl.TextureComponents.RG} isn't used
3914
4037
  * as the texture's components.
3915
4038
  * @param components
4039
+ * @since 1.18
3916
4040
  */
3917
4041
  set_components(components: TextureComponents): void;
3918
4042
 
@@ -3990,6 +4114,7 @@ export namespace Cogl {
3990
4114
  *
3991
4115
  * By default the `premultipled` state is `TRUE`.
3992
4116
  * @param premultiplied Whether any internally stored red, green or blue components are pre-multiplied by an alpha component.
4117
+ * @since 1.18
3993
4118
  */
3994
4119
  set_premultiplied(premultiplied: boolean): void;
3995
4120
 
@@ -4027,6 +4152,7 @@ export namespace Cogl {
4027
4152
  * @param dst_height height of destination region to write. (Must be less than or equal to the bitmap height)
4028
4153
  * @param bitmap The source bitmap to read from
4029
4154
  * @returns `true` if the subregion upload was successful, and `false` otherwise
4155
+ * @since 1.8
4030
4156
  */
4031
4157
  set_region_from_bitmap(src_x: number, src_y: number, dst_x: number, dst_y: number, dst_width: number, dst_height: number, bitmap: Bitmap): boolean;
4032
4158
  }
@@ -4085,6 +4211,7 @@ export namespace Cogl {
4085
4211
  * is {@link Cogl.TextureComponents.RGBA}. The other constructors which take
4086
4212
  * a %CoglBitmap or a data pointer default to the same components as
4087
4213
  * the pixel format of the data.
4214
+ * @since 1.18
4088
4215
  */
4089
4216
  get_components(): TextureComponents;
4090
4217
 
@@ -4131,6 +4258,7 @@ export namespace Cogl {
4131
4258
  *
4132
4259
  * By default the pre-multipled state is `TRUE`.
4133
4260
  * @returns `true` if red, green and blue components are internally stored pre-multiplied by the alpha value or `false` if not.
4261
+ * @since 1.18
4134
4262
  */
4135
4263
  get_premultiplied(): boolean;
4136
4264
 
@@ -4168,6 +4296,7 @@ export namespace Cogl {
4168
4296
  * an image format as long as {@link Cogl.TextureComponents.RG} isn't used
4169
4297
  * as the texture's components.
4170
4298
  * @param components
4299
+ * @since 1.18
4171
4300
  */
4172
4301
  set_components(components: TextureComponents): void;
4173
4302
 
@@ -4245,6 +4374,7 @@ export namespace Cogl {
4245
4374
  *
4246
4375
  * By default the `premultipled` state is `TRUE`.
4247
4376
  * @param premultiplied Whether any internally stored red, green or blue components are pre-multiplied by an alpha component.
4377
+ * @since 1.18
4248
4378
  */
4249
4379
  set_premultiplied(premultiplied: boolean): void;
4250
4380
 
@@ -4282,6 +4412,7 @@ export namespace Cogl {
4282
4412
  * @param dst_height height of destination region to write. (Must be less than or equal to the bitmap height)
4283
4413
  * @param bitmap The source bitmap to read from
4284
4414
  * @returns `true` if the subregion upload was successful, and `false` otherwise
4415
+ * @since 1.8
4285
4416
  */
4286
4417
  set_region_from_bitmap(src_x: number, src_y: number, dst_x: number, dst_y: number, dst_width: number, dst_height: number, bitmap: Bitmap): boolean;
4287
4418
  }
@@ -4310,6 +4441,7 @@ export namespace Cogl {
4310
4441
  * parameter, when using {@link Cogl.Color}<!-- -->s as keys in a {@link GLib.HashTable}.
4311
4442
  * @param v1 a {@link Cogl.Color}
4312
4443
  * @param v2 a {@link Cogl.Color}
4444
+ * @since 1.0
4313
4445
  */
4314
4446
  static equal(v1: null, v2: null): boolean;
4315
4447
 
@@ -4319,6 +4451,7 @@ export namespace Cogl {
4319
4451
  * @param hue hue value, in the 0 .. 360 range
4320
4452
  * @param saturation saturation value, in the 0 .. 1 range
4321
4453
  * @param luminance luminance value, in the 0 .. 1 range
4454
+ * @since 1.16
4322
4455
  */
4323
4456
  static init_from_hsl(hue: number, saturation: number, luminance: number): Color;
4324
4457
 
@@ -4326,11 +4459,13 @@ export namespace Cogl {
4326
4459
  /**
4327
4460
  * Creates a copy of `color`
4328
4461
  * @returns a newly-allocated {@link Cogl.Color}. Use `cogl_color_free()` to free the allocate resources
4462
+ * @since 1.0
4329
4463
  */
4330
4464
  copy(): Color;
4331
4465
 
4332
4466
  /**
4333
4467
  * Frees the resources allocated by `cogl_color_new()` and `cogl_color_copy()`
4468
+ * @since 1.0
4334
4469
  */
4335
4470
  free(): void;
4336
4471
 
@@ -4338,6 +4473,7 @@ export namespace Cogl {
4338
4473
  * Retrieves the alpha channel of `color` as a fixed point
4339
4474
  * value between 0 and 1.0.
4340
4475
  * @returns the alpha channel of the passed color
4476
+ * @since 1.0
4341
4477
  */
4342
4478
  get_alpha(): number;
4343
4479
 
@@ -4345,6 +4481,7 @@ export namespace Cogl {
4345
4481
  * Retrieves the alpha channel of `color` as a byte value
4346
4482
  * between 0 and 255
4347
4483
  * @returns the alpha channel of the passed color
4484
+ * @since 1.0
4348
4485
  */
4349
4486
  get_alpha_byte(): number;
4350
4487
 
@@ -4352,6 +4489,7 @@ export namespace Cogl {
4352
4489
  * Retrieves the alpha channel of `color` as a floating point
4353
4490
  * value between 0.0 and 1.0
4354
4491
  * @returns the alpha channel of the passed color
4492
+ * @since 1.0
4355
4493
  */
4356
4494
  get_alpha_float(): number;
4357
4495
 
@@ -4359,6 +4497,7 @@ export namespace Cogl {
4359
4497
  * Retrieves the blue channel of `color` as a fixed point
4360
4498
  * value between 0 and 1.0.
4361
4499
  * @returns the blue channel of the passed color
4500
+ * @since 1.0
4362
4501
  */
4363
4502
  get_blue(): number;
4364
4503
 
@@ -4366,6 +4505,7 @@ export namespace Cogl {
4366
4505
  * Retrieves the blue channel of `color` as a byte value
4367
4506
  * between 0 and 255
4368
4507
  * @returns the blue channel of the passed color
4508
+ * @since 1.0
4369
4509
  */
4370
4510
  get_blue_byte(): number;
4371
4511
 
@@ -4373,6 +4513,7 @@ export namespace Cogl {
4373
4513
  * Retrieves the blue channel of `color` as a floating point
4374
4514
  * value between 0.0 and 1.0
4375
4515
  * @returns the blue channel of the passed color
4516
+ * @since 1.0
4376
4517
  */
4377
4518
  get_blue_float(): number;
4378
4519
 
@@ -4380,6 +4521,7 @@ export namespace Cogl {
4380
4521
  * Retrieves the green channel of `color` as a fixed point
4381
4522
  * value between 0 and 1.0.
4382
4523
  * @returns the green channel of the passed color
4524
+ * @since 1.0
4383
4525
  */
4384
4526
  get_green(): number;
4385
4527
 
@@ -4387,6 +4529,7 @@ export namespace Cogl {
4387
4529
  * Retrieves the green channel of `color` as a byte value
4388
4530
  * between 0 and 255
4389
4531
  * @returns the green channel of the passed color
4532
+ * @since 1.0
4390
4533
  */
4391
4534
  get_green_byte(): number;
4392
4535
 
@@ -4394,6 +4537,7 @@ export namespace Cogl {
4394
4537
  * Retrieves the green channel of `color` as a floating point
4395
4538
  * value between 0.0 and 1.0
4396
4539
  * @returns the green channel of the passed color
4540
+ * @since 1.0
4397
4541
  */
4398
4542
  get_green_float(): number;
4399
4543
 
@@ -4401,6 +4545,7 @@ export namespace Cogl {
4401
4545
  * Retrieves the red channel of `color` as a fixed point
4402
4546
  * value between 0 and 1.0.
4403
4547
  * @returns the red channel of the passed color
4548
+ * @since 1.0
4404
4549
  */
4405
4550
  get_red(): number;
4406
4551
 
@@ -4408,6 +4553,7 @@ export namespace Cogl {
4408
4553
  * Retrieves the red channel of `color` as a byte value
4409
4554
  * between 0 and 255
4410
4555
  * @returns the red channel of the passed color
4556
+ * @since 1.0
4411
4557
  */
4412
4558
  get_red_byte(): number;
4413
4559
 
@@ -4415,6 +4561,7 @@ export namespace Cogl {
4415
4561
  * Retrieves the red channel of `color` as a floating point
4416
4562
  * value between 0.0 and 1.0
4417
4563
  * @returns the red channel of the passed color
4564
+ * @since 1.0
4418
4565
  */
4419
4566
  get_red_float(): number;
4420
4567
 
@@ -4424,12 +4571,14 @@ export namespace Cogl {
4424
4571
  * @param green value of the green channel, between 0 and 1.0
4425
4572
  * @param blue value of the blue channel, between 0 and 1.0
4426
4573
  * @param alpha value of the alpha channel, between 0 and 1.0
4574
+ * @since 1.4
4427
4575
  */
4428
4576
  init_from_4f(red: number, green: number, blue: number, alpha: number): void;
4429
4577
 
4430
4578
  /**
4431
4579
  * Sets the values of the passed channels into a {@link Cogl.Color}
4432
4580
  * @param color_array a pointer to an array of 4 float color components
4581
+ * @since 1.4
4433
4582
  */
4434
4583
  init_from_4fv(color_array: number): void;
4435
4584
 
@@ -4439,6 +4588,7 @@ export namespace Cogl {
4439
4588
  * @param green value of the green channel, between 0 and 255
4440
4589
  * @param blue value of the blue channel, between 0 and 255
4441
4590
  * @param alpha value of the alpha channel, between 0 and 255
4591
+ * @since 1.4
4442
4592
  */
4443
4593
  init_from_4ub(red: number, green: number, blue: number, alpha: number): void;
4444
4594
 
@@ -4446,78 +4596,91 @@ export namespace Cogl {
4446
4596
  * Converts a non-premultiplied color to a pre-multiplied color. For
4447
4597
  * example, semi-transparent red is (1.0, 0, 0, 0.5) when non-premultiplied
4448
4598
  * and (0.5, 0, 0, 0.5) when premultiplied.
4599
+ * @since 1.0
4449
4600
  */
4450
4601
  premultiply(): void;
4451
4602
 
4452
4603
  /**
4453
4604
  * Sets the alpha channel of `color` to `alpha`.
4454
4605
  * @param alpha a float value between 0.0f and 1.0f
4606
+ * @since 1.4
4455
4607
  */
4456
4608
  set_alpha(alpha: number): void;
4457
4609
 
4458
4610
  /**
4459
4611
  * Sets the alpha channel of `color` to `alpha`.
4460
4612
  * @param alpha a byte value between 0 and 255
4613
+ * @since 1.4
4461
4614
  */
4462
4615
  set_alpha_byte(alpha: number): void;
4463
4616
 
4464
4617
  /**
4465
4618
  * Sets the alpha channel of `color` to `alpha`.
4466
4619
  * @param alpha a float value between 0.0f and 1.0f
4620
+ * @since 1.4
4467
4621
  */
4468
4622
  set_alpha_float(alpha: number): void;
4469
4623
 
4470
4624
  /**
4471
4625
  * Sets the blue channel of `color` to `blue`.
4472
4626
  * @param blue a float value between 0.0f and 1.0f
4627
+ * @since 1.4
4473
4628
  */
4474
4629
  set_blue(blue: number): void;
4475
4630
 
4476
4631
  /**
4477
4632
  * Sets the blue channel of `color` to `blue`.
4478
4633
  * @param blue a byte value between 0 and 255
4634
+ * @since 1.4
4479
4635
  */
4480
4636
  set_blue_byte(blue: number): void;
4481
4637
 
4482
4638
  /**
4483
4639
  * Sets the blue channel of `color` to `blue`.
4484
4640
  * @param blue a float value between 0.0f and 1.0f
4641
+ * @since 1.4
4485
4642
  */
4486
4643
  set_blue_float(blue: number): void;
4487
4644
 
4488
4645
  /**
4489
4646
  * Sets the green channel of `color` to `green`.
4490
4647
  * @param green a float value between 0.0f and 1.0f
4648
+ * @since 1.4
4491
4649
  */
4492
4650
  set_green(green: number): void;
4493
4651
 
4494
4652
  /**
4495
4653
  * Sets the green channel of `color` to `green`.
4496
4654
  * @param green a byte value between 0 and 255
4655
+ * @since 1.4
4497
4656
  */
4498
4657
  set_green_byte(green: number): void;
4499
4658
 
4500
4659
  /**
4501
4660
  * Sets the green channel of `color` to `green`.
4502
4661
  * @param green a float value between 0.0f and 1.0f
4662
+ * @since 1.4
4503
4663
  */
4504
4664
  set_green_float(green: number): void;
4505
4665
 
4506
4666
  /**
4507
4667
  * Sets the red channel of `color` to `red`.
4508
4668
  * @param red a float value between 0.0f and 1.0f
4669
+ * @since 1.4
4509
4670
  */
4510
4671
  set_red(red: number): void;
4511
4672
 
4512
4673
  /**
4513
4674
  * Sets the red channel of `color` to `red`.
4514
4675
  * @param red a byte value between 0 and 255
4676
+ * @since 1.4
4515
4677
  */
4516
4678
  set_red_byte(red: number): void;
4517
4679
 
4518
4680
  /**
4519
4681
  * Sets the red channel of `color` to `red`.
4520
4682
  * @param red a float value between 0.0f and 1.0f
4683
+ * @since 1.4
4521
4684
  */
4522
4685
  set_red_float(red: number): void;
4523
4686
 
@@ -4526,6 +4689,7 @@ export namespace Cogl {
4526
4689
  *
4527
4690
  * The `hue` value is in the 0 .. 360 range. The `luminance` and
4528
4691
  * `saturation` values are in the 0 .. 1 range.
4692
+ * @since 1.16
4529
4693
  */
4530
4694
  to_hsl(): [number, number, number];
4531
4695
 
@@ -4533,6 +4697,7 @@ export namespace Cogl {
4533
4697
  * Converts a pre-multiplied color to a non-premultiplied color. For
4534
4698
  * example, semi-transparent red is (0.5, 0, 0, 0.5) when premultiplied
4535
4699
  * and (1.0, 0, 0, 0.5) when non-premultiplied.
4700
+ * @since 1.4
4536
4701
  */
4537
4702
  unpremultiply(): void;
4538
4703
  }
@@ -4831,6 +4996,7 @@ export namespace Cogl {
4831
4996
  * is {@link Cogl.TextureComponents.RGBA}. The other constructors which take
4832
4997
  * a %CoglBitmap or a data pointer default to the same components as
4833
4998
  * the pixel format of the data.
4999
+ * @since 1.18
4834
5000
  */
4835
5001
  get_components(): TextureComponents;
4836
5002
 
@@ -4877,6 +5043,7 @@ export namespace Cogl {
4877
5043
  *
4878
5044
  * By default the pre-multipled state is `TRUE`.
4879
5045
  * @returns `true` if red, green and blue components are internally stored pre-multiplied by the alpha value or `false` if not.
5046
+ * @since 1.18
4880
5047
  */
4881
5048
  get_premultiplied(): boolean;
4882
5049
 
@@ -4914,6 +5081,7 @@ export namespace Cogl {
4914
5081
  * an image format as long as {@link Cogl.TextureComponents.RG} isn't used
4915
5082
  * as the texture's components.
4916
5083
  * @param components
5084
+ * @since 1.18
4917
5085
  */
4918
5086
  set_components(components: TextureComponents): void;
4919
5087
 
@@ -4991,6 +5159,7 @@ export namespace Cogl {
4991
5159
  *
4992
5160
  * By default the `premultipled` state is `TRUE`.
4993
5161
  * @param premultiplied Whether any internally stored red, green or blue components are pre-multiplied by an alpha component.
5162
+ * @since 1.18
4994
5163
  */
4995
5164
  set_premultiplied(premultiplied: boolean): void;
4996
5165
 
@@ -5028,6 +5197,7 @@ export namespace Cogl {
5028
5197
  * @param dst_height height of destination region to write. (Must be less than or equal to the bitmap height)
5029
5198
  * @param bitmap The source bitmap to read from
5030
5199
  * @returns `true` if the subregion upload was successful, and `false` otherwise
5200
+ * @since 1.8
5031
5201
  */
5032
5202
  set_region_from_bitmap(src_x: number, src_y: number, dst_x: number, dst_y: number, dst_width: number, dst_height: number, bitmap: Bitmap): boolean;
5033
5203
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@girs/cogl-10",
3
- "version": "4.3.0",
3
+ "version": "4.4.0",
4
4
  "description": "GJS TypeScript type definitions for Cogl-10",
5
5
  "type": "module",
6
6
  "module": "cogl-10.js",
@@ -31,12 +31,12 @@
31
31
  "test": "tsc --project tsconfig.json"
32
32
  },
33
33
  "dependencies": {
34
- "@girs/gjs": "^4.3.0",
35
- "@girs/cairo-1.0": "^4.3.0",
36
- "@girs/gobject-2.0": "^4.3.0",
37
- "@girs/glib-2.0": "^4.3.0",
38
- "@girs/graphene-1.0": "^4.3.0",
39
- "@girs/gl-1.0": "^4.3.0" },
34
+ "@girs/gjs": "^4.4.0",
35
+ "@girs/cairo-1.0": "^4.4.0",
36
+ "@girs/gobject-2.0": "^4.4.0",
37
+ "@girs/glib-2.0": "^4.4.0",
38
+ "@girs/graphene-1.0": "^4.4.0",
39
+ "@girs/gl-1.0": "^4.4.0" },
40
40
  "devDependencies": {
41
41
  "typescript": "*"
42
42
  },