@girs/cogl-9 4.2.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.
- package/README.md +8 -8
- package/cogl-9.d.ts +200 -0
- package/package.json +7 -7
package/cogl-9.d.ts
CHANGED
|
@@ -1728,27 +1728,32 @@ export namespace Cogl {
|
|
|
1728
1728
|
* Parses an image file enough to extract the width and height
|
|
1729
1729
|
* of the bitmap.
|
|
1730
1730
|
* @param filename the file to check
|
|
1731
|
+
* @since 1.0
|
|
1731
1732
|
*/
|
|
1732
1733
|
static get_size_from_file(filename: string): [boolean, number, number];
|
|
1733
1734
|
|
|
1734
1735
|
// Methods
|
|
1735
1736
|
/**
|
|
1736
1737
|
* @returns the {@link Cogl.PixelFormat} that the data for the bitmap is in.
|
|
1738
|
+
* @since 1.10
|
|
1737
1739
|
*/
|
|
1738
1740
|
get_format(): PixelFormat;
|
|
1739
1741
|
|
|
1740
1742
|
/**
|
|
1741
1743
|
* @returns the height of the bitmap
|
|
1744
|
+
* @since 1.10
|
|
1742
1745
|
*/
|
|
1743
1746
|
get_height(): number;
|
|
1744
1747
|
|
|
1745
1748
|
/**
|
|
1746
1749
|
* @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.
|
|
1750
|
+
* @since 1.10
|
|
1747
1751
|
*/
|
|
1748
1752
|
get_rowstride(): number;
|
|
1749
1753
|
|
|
1750
1754
|
/**
|
|
1751
1755
|
* @returns the width of the bitmap
|
|
1756
|
+
* @since 1.10
|
|
1752
1757
|
*/
|
|
1753
1758
|
get_width(): number;
|
|
1754
1759
|
}
|
|
@@ -1855,6 +1860,7 @@ export namespace Cogl {
|
|
|
1855
1860
|
* Gets the frame counter for the {@link Cogl.Onscreen} that corresponds
|
|
1856
1861
|
* to this frame.
|
|
1857
1862
|
* @returns The frame counter value
|
|
1863
|
+
* @since 1.14
|
|
1858
1864
|
*/
|
|
1859
1865
|
get_frame_counter(): number;
|
|
1860
1866
|
|
|
@@ -1870,6 +1876,7 @@ export namespace Cogl {
|
|
|
1870
1876
|
* <note>Some buggy Mesa drivers up to 9.0.1 may
|
|
1871
1877
|
* incorrectly report non-monotonic timestamps.</note>
|
|
1872
1878
|
* @returns the presentation time for the frame
|
|
1879
|
+
* @since 1.14
|
|
1873
1880
|
*/
|
|
1874
1881
|
get_presentation_time_us(): number;
|
|
1875
1882
|
|
|
@@ -1883,6 +1890,7 @@ export namespace Cogl {
|
|
|
1883
1890
|
* more reliable than using `cogl_frame_info_get_output()` followed by
|
|
1884
1891
|
* `cogl_output_get_refresh_rate()`.</note>
|
|
1885
1892
|
* @returns the refresh rate in Hertz
|
|
1893
|
+
* @since 1.14
|
|
1886
1894
|
*/
|
|
1887
1895
|
get_refresh_rate(): number;
|
|
1888
1896
|
|
|
@@ -1987,6 +1995,7 @@ export namespace Cogl {
|
|
|
1987
1995
|
* used. The disadvantage of relying on automatic allocation is that the
|
|
1988
1996
|
* program will abort with an error message if there is an error during
|
|
1989
1997
|
* automatic allocation.</note>
|
|
1998
|
+
* @since 1.8
|
|
1990
1999
|
* @virtual
|
|
1991
2000
|
*/
|
|
1992
2001
|
vfunc_allocate(): boolean;
|
|
@@ -2009,6 +2018,7 @@ export namespace Cogl {
|
|
|
2009
2018
|
* program will abort with an error message if there is an error during
|
|
2010
2019
|
* automatic allocation.</note>
|
|
2011
2020
|
* @returns `true` if there were no error allocating the framebuffer, else `false`.
|
|
2021
|
+
* @since 1.8
|
|
2012
2022
|
*/
|
|
2013
2023
|
allocate(): boolean;
|
|
2014
2024
|
|
|
@@ -2017,6 +2027,7 @@ export namespace Cogl {
|
|
|
2017
2027
|
* that includes the color buffer then the specified `color` is used.
|
|
2018
2028
|
* @param buffers A mask of {@link Cogl.BufferBit}<!-- -->'s identifying which auxiliary buffers to clear
|
|
2019
2029
|
* @param color The color to clear the color buffer too if specified in `buffers`.
|
|
2030
|
+
* @since 1.8
|
|
2020
2031
|
*/
|
|
2021
2032
|
clear(buffers: bigint | number, color: Color): void;
|
|
2022
2033
|
|
|
@@ -2028,6 +2039,7 @@ export namespace Cogl {
|
|
|
2028
2039
|
* @param green The green component of color to clear the color buffer too if specified in `buffers`.
|
|
2029
2040
|
* @param blue The blue component of color to clear the color buffer too if specified in `buffers`.
|
|
2030
2041
|
* @param alpha The alpha component of color to clear the color buffer too if specified in `buffers`.
|
|
2042
|
+
* @since 1.8
|
|
2031
2043
|
*/
|
|
2032
2044
|
clear4f(buffers: bigint | number, red: number, green: number, blue: number, alpha: number): void;
|
|
2033
2045
|
|
|
@@ -2049,6 +2061,7 @@ export namespace Cogl {
|
|
|
2049
2061
|
* framebuffer, and it's not meaningful to try and discard the color buffer of
|
|
2050
2062
|
* a {@link Cogl.Offscreen} framebuffer since they are single-buffered.
|
|
2051
2063
|
* @param buffers A {@link Cogl.BufferBit} mask of which ancillary buffers you want to discard.
|
|
2064
|
+
* @since 1.8
|
|
2052
2065
|
*/
|
|
2053
2066
|
discard_buffers(buffers: bigint | number): void;
|
|
2054
2067
|
|
|
@@ -2098,6 +2111,7 @@ export namespace Cogl {
|
|
|
2098
2111
|
* @param y_2 y coordinate lower right on screen.
|
|
2099
2112
|
* @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.
|
|
2100
2113
|
* @param tex_coords_len The length of the `tex_coords` array. (For one layer and one group of texture coordinates, this would be 4)
|
|
2114
|
+
* @since 1.10
|
|
2101
2115
|
*/
|
|
2102
2116
|
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;
|
|
2103
2117
|
|
|
@@ -2118,6 +2132,7 @@ export namespace Cogl {
|
|
|
2118
2132
|
* @param y_1 Y coordinate of the top-left corner
|
|
2119
2133
|
* @param x_2 X coordinate of the bottom-right corner
|
|
2120
2134
|
* @param y_2 Y coordinate of the bottom-right corner
|
|
2135
|
+
* @since 1.10
|
|
2121
2136
|
*/
|
|
2122
2137
|
draw_rectangle(pipeline: Pipeline, x_1: number, y_1: number, x_2: number, y_2: number): void;
|
|
2123
2138
|
|
|
@@ -2144,6 +2159,7 @@ export namespace Cogl {
|
|
|
2144
2159
|
* @param pipeline A {@link Cogl.Pipeline} state object
|
|
2145
2160
|
* @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).
|
|
2146
2161
|
* @param n_rectangles number of rectangles defined in `coordinates`.
|
|
2162
|
+
* @since 1.10
|
|
2147
2163
|
*/
|
|
2148
2164
|
draw_rectangles(pipeline: Pipeline, coordinates: number[], n_rectangles: number): void;
|
|
2149
2165
|
|
|
@@ -2183,6 +2199,7 @@ export namespace Cogl {
|
|
|
2183
2199
|
* @param t_1 T texture coordinate of the top-left coorner
|
|
2184
2200
|
* @param s_2 S texture coordinate of the bottom-right coorner
|
|
2185
2201
|
* @param t_2 T texture coordinate of the bottom-right coorner
|
|
2202
|
+
* @since 1.10
|
|
2186
2203
|
*/
|
|
2187
2204
|
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;
|
|
2188
2205
|
|
|
@@ -2224,6 +2241,7 @@ export namespace Cogl {
|
|
|
2224
2241
|
* @param pipeline A {@link Cogl.Pipeline} state object
|
|
2225
2242
|
* @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()`.
|
|
2226
2243
|
* @param n_rectangles number of rectangles to `coordinates` to draw
|
|
2244
|
+
* @since 1.10
|
|
2227
2245
|
*/
|
|
2228
2246
|
draw_textured_rectangles(pipeline: Pipeline, coordinates: number[], n_rectangles: number): void;
|
|
2229
2247
|
|
|
@@ -2237,6 +2255,7 @@ export namespace Cogl {
|
|
|
2237
2255
|
* One example might be for benchmarking purposes to be sure timing
|
|
2238
2256
|
* measurements reflect the time that the GPU is busy for not just the time it
|
|
2239
2257
|
* takes to queue rendering commands.
|
|
2258
|
+
* @since 1.10
|
|
2240
2259
|
*/
|
|
2241
2260
|
finish(): void;
|
|
2242
2261
|
|
|
@@ -2258,18 +2277,21 @@ export namespace Cogl {
|
|
|
2258
2277
|
* @param top Y position of the top clipping plane where it intersects the near clipping plane
|
|
2259
2278
|
* @param z_near The distance to the near clipping plane (Must be positive)
|
|
2260
2279
|
* @param z_far The distance to the far clipping plane (Must be positive)
|
|
2280
|
+
* @since 1.10
|
|
2261
2281
|
*/
|
|
2262
2282
|
frustum(left: number, right: number, bottom: number, top: number, z_near: number, z_far: number): void;
|
|
2263
2283
|
|
|
2264
2284
|
/**
|
|
2265
2285
|
* Retrieves the number of alpha bits of `framebuffer`
|
|
2266
2286
|
* @returns the number of bits
|
|
2287
|
+
* @since 1.8
|
|
2267
2288
|
*/
|
|
2268
2289
|
get_alpha_bits(): number;
|
|
2269
2290
|
|
|
2270
2291
|
/**
|
|
2271
2292
|
* Retrieves the number of blue bits of `framebuffer`
|
|
2272
2293
|
* @returns the number of bits
|
|
2294
|
+
* @since 1.8
|
|
2273
2295
|
*/
|
|
2274
2296
|
get_blue_bits(): number;
|
|
2275
2297
|
|
|
@@ -2278,12 +2300,14 @@ export namespace Cogl {
|
|
|
2278
2300
|
* instantiated within. This is the {@link Cogl.Context} that was passed to
|
|
2279
2301
|
* `cogl_onscreen_new()` for example.
|
|
2280
2302
|
* @returns The {@link Cogl.Context} that the given `framebuffer` was instantiated within.
|
|
2303
|
+
* @since 1.8
|
|
2281
2304
|
*/
|
|
2282
2305
|
get_context(): Context;
|
|
2283
2306
|
|
|
2284
2307
|
/**
|
|
2285
2308
|
* Retrieves the number of depth bits of `framebuffer`
|
|
2286
2309
|
* @returns the number of bits
|
|
2310
|
+
* @since 2.0
|
|
2287
2311
|
*/
|
|
2288
2312
|
get_depth_bits(): number;
|
|
2289
2313
|
|
|
@@ -2291,6 +2315,7 @@ export namespace Cogl {
|
|
|
2291
2315
|
* Queries whether depth buffer writing is enabled for `framebuffer`. This
|
|
2292
2316
|
* can be controlled via `cogl_framebuffer_set_depth_write_enabled()`.
|
|
2293
2317
|
* @returns `true` if depth writing is enabled or `false` if not.
|
|
2318
|
+
* @since 1.18
|
|
2294
2319
|
*/
|
|
2295
2320
|
get_depth_write_enabled(): boolean;
|
|
2296
2321
|
|
|
@@ -2302,18 +2327,21 @@ export namespace Cogl {
|
|
|
2302
2327
|
* display pipeline does not support dithering. This value only represents
|
|
2303
2328
|
* the user's request for dithering.</note>
|
|
2304
2329
|
* @returns `true` if dithering has been requested or `false` if not.
|
|
2330
|
+
* @since 1.8
|
|
2305
2331
|
*/
|
|
2306
2332
|
get_dither_enabled(): boolean;
|
|
2307
2333
|
|
|
2308
2334
|
/**
|
|
2309
2335
|
* Retrieves the number of green bits of `framebuffer`
|
|
2310
2336
|
* @returns the number of bits
|
|
2337
|
+
* @since 1.8
|
|
2311
2338
|
*/
|
|
2312
2339
|
get_green_bits(): number;
|
|
2313
2340
|
|
|
2314
2341
|
/**
|
|
2315
2342
|
* Queries the current height of the given `framebuffer`.
|
|
2316
2343
|
* @returns The height of `framebuffer`.
|
|
2344
|
+
* @since 1.8
|
|
2317
2345
|
*/
|
|
2318
2346
|
get_height(): number;
|
|
2319
2347
|
|
|
@@ -2321,17 +2349,20 @@ export namespace Cogl {
|
|
|
2321
2349
|
|
|
2322
2350
|
/**
|
|
2323
2351
|
* Stores the current model-view matrix in `matrix`.
|
|
2352
|
+
* @since 1.10
|
|
2324
2353
|
*/
|
|
2325
2354
|
get_modelview_matrix(): Graphene.Matrix;
|
|
2326
2355
|
|
|
2327
2356
|
/**
|
|
2328
2357
|
* Stores the current projection matrix in `matrix`.
|
|
2358
|
+
* @since 1.10
|
|
2329
2359
|
*/
|
|
2330
2360
|
get_projection_matrix(): Graphene.Matrix;
|
|
2331
2361
|
|
|
2332
2362
|
/**
|
|
2333
2363
|
* Retrieves the number of red bits of `framebuffer`
|
|
2334
2364
|
* @returns the number of bits
|
|
2365
|
+
* @since 1.8
|
|
2335
2366
|
*/
|
|
2336
2367
|
get_red_bits(): number;
|
|
2337
2368
|
|
|
@@ -2349,6 +2380,7 @@ export namespace Cogl {
|
|
|
2349
2380
|
* framebuffer has been allocated the value will reflect the actual
|
|
2350
2381
|
* number of samples that will be made by the GPU.
|
|
2351
2382
|
* @returns The number of point samples made per pixel when rasterizing geometry or 0 if single-sample rendering has been chosen.
|
|
2383
|
+
* @since 1.10
|
|
2352
2384
|
*/
|
|
2353
2385
|
get_samples_per_pixel(): number;
|
|
2354
2386
|
|
|
@@ -2356,6 +2388,7 @@ export namespace Cogl {
|
|
|
2356
2388
|
* Gets the current {@link Cogl.StereoMode}, which defines which stereo buffers
|
|
2357
2389
|
* should be drawn to. See `cogl_framebuffer_set_stereo_mode()`.
|
|
2358
2390
|
* @returns A {@link Cogl.StereoMode}
|
|
2391
|
+
* @since 1.20
|
|
2359
2392
|
*/
|
|
2360
2393
|
get_stereo_mode(): StereoMode;
|
|
2361
2394
|
|
|
@@ -2364,6 +2397,7 @@ export namespace Cogl {
|
|
|
2364
2397
|
* using `cogl_framebuffer_set_viewport()` or the default values which are 0, 0,
|
|
2365
2398
|
* framebuffer_width and framebuffer_height. The values are written into the
|
|
2366
2399
|
* given `viewport` array.
|
|
2400
|
+
* @since 1.8
|
|
2367
2401
|
*/
|
|
2368
2402
|
get_viewport4fv(): number[];
|
|
2369
2403
|
|
|
@@ -2371,6 +2405,7 @@ export namespace Cogl {
|
|
|
2371
2405
|
* Queries the height of the viewport as set using `cogl_framebuffer_set_viewport()`
|
|
2372
2406
|
* or the default value which is the height of the framebuffer.
|
|
2373
2407
|
* @returns The height of the viewport.
|
|
2408
|
+
* @since 1.8
|
|
2374
2409
|
*/
|
|
2375
2410
|
get_viewport_height(): number;
|
|
2376
2411
|
|
|
@@ -2378,6 +2413,7 @@ export namespace Cogl {
|
|
|
2378
2413
|
* Queries the width of the viewport as set using `cogl_framebuffer_set_viewport()`
|
|
2379
2414
|
* or the default value which is the width of the framebuffer.
|
|
2380
2415
|
* @returns The width of the viewport.
|
|
2416
|
+
* @since 1.8
|
|
2381
2417
|
*/
|
|
2382
2418
|
get_viewport_width(): number;
|
|
2383
2419
|
|
|
@@ -2385,6 +2421,7 @@ export namespace Cogl {
|
|
|
2385
2421
|
* Queries the x coordinate of the viewport origin as set using `cogl_framebuffer_set_viewport()`
|
|
2386
2422
|
* or the default value which is 0.
|
|
2387
2423
|
* @returns The x coordinate of the viewport origin.
|
|
2424
|
+
* @since 1.8
|
|
2388
2425
|
*/
|
|
2389
2426
|
get_viewport_x(): number;
|
|
2390
2427
|
|
|
@@ -2392,17 +2429,20 @@ export namespace Cogl {
|
|
|
2392
2429
|
* Queries the y coordinate of the viewport origin as set using `cogl_framebuffer_set_viewport()`
|
|
2393
2430
|
* or the default value which is 0.
|
|
2394
2431
|
* @returns The y coordinate of the viewport origin.
|
|
2432
|
+
* @since 1.8
|
|
2395
2433
|
*/
|
|
2396
2434
|
get_viewport_y(): number;
|
|
2397
2435
|
|
|
2398
2436
|
/**
|
|
2399
2437
|
* Queries the current width of the given `framebuffer`.
|
|
2400
2438
|
* @returns The width of `framebuffer`.
|
|
2439
|
+
* @since 1.8
|
|
2401
2440
|
*/
|
|
2402
2441
|
get_width(): number;
|
|
2403
2442
|
|
|
2404
2443
|
/**
|
|
2405
2444
|
* Resets the current model-view matrix to the identity matrix.
|
|
2445
|
+
* @since 1.10
|
|
2406
2446
|
*/
|
|
2407
2447
|
identity_matrix(): void;
|
|
2408
2448
|
|
|
@@ -2415,6 +2455,7 @@ export namespace Cogl {
|
|
|
2415
2455
|
* @param y_2 The y coordinate for the second horizontal clipping plane
|
|
2416
2456
|
* @param near The <emphasis>distance</emphasis> to the near clipping plane (will be <emphasis>negative</emphasis> if the plane is behind the viewer)
|
|
2417
2457
|
* @param far The <emphasis>distance</emphasis> to the far clipping plane (will be <emphasis>negative</emphasis> if the plane is behind the viewer)
|
|
2458
|
+
* @since 1.10
|
|
2418
2459
|
*/
|
|
2419
2460
|
orthographic(x_1: number, y_1: number, x_2: number, y_2: number, near: number, far: number): void;
|
|
2420
2461
|
|
|
@@ -2430,6 +2471,7 @@ export namespace Cogl {
|
|
|
2430
2471
|
* @param aspect The (width over height) aspect ratio for display
|
|
2431
2472
|
* @param z_near The distance to the near clipping plane (Must be positive, and must not be 0)
|
|
2432
2473
|
* @param z_far The distance to the far clipping plane (Must be positive)
|
|
2474
|
+
* @since 1.10
|
|
2433
2475
|
*/
|
|
2434
2476
|
perspective(fov_y: number, aspect: number, z_near: number, z_far: number): void;
|
|
2435
2477
|
|
|
@@ -2437,17 +2479,20 @@ export namespace Cogl {
|
|
|
2437
2479
|
* Reverts the clipping region to the state before the last call to
|
|
2438
2480
|
* `cogl_framebuffer_push_scissor_clip()`, `cogl_framebuffer_push_rectangle_clip()`
|
|
2439
2481
|
* `cogl_framebuffer_push_path_clip()`, or `cogl_framebuffer_push_primitive_clip()`.
|
|
2482
|
+
* @since 1.10
|
|
2440
2483
|
*/
|
|
2441
2484
|
pop_clip(): void;
|
|
2442
2485
|
|
|
2443
2486
|
/**
|
|
2444
2487
|
* Restores the model-view matrix on the top of the matrix stack.
|
|
2488
|
+
* @since 1.10
|
|
2445
2489
|
*/
|
|
2446
2490
|
pop_matrix(): void;
|
|
2447
2491
|
|
|
2448
2492
|
/**
|
|
2449
2493
|
* Copies the current model-view matrix onto the matrix stack. The matrix
|
|
2450
2494
|
* can later be restored with `cogl_framebuffer_pop_matrix()`.
|
|
2495
|
+
* @since 1.10
|
|
2451
2496
|
*/
|
|
2452
2497
|
push_matrix(): void;
|
|
2453
2498
|
|
|
@@ -2464,6 +2509,7 @@ export namespace Cogl {
|
|
|
2464
2509
|
* @param y_1 y coordinate for top left corner of the clip rectangle
|
|
2465
2510
|
* @param x_2 x coordinate for bottom right corner of the clip rectangle
|
|
2466
2511
|
* @param y_2 y coordinate for bottom right corner of the clip rectangle
|
|
2512
|
+
* @since 1.10
|
|
2467
2513
|
*/
|
|
2468
2514
|
push_rectangle_clip(x_1: number, y_1: number, x_2: number, y_2: number): void;
|
|
2469
2515
|
|
|
@@ -2485,6 +2531,7 @@ export namespace Cogl {
|
|
|
2485
2531
|
* @param y top edge of the clip rectangle in window coordinates
|
|
2486
2532
|
* @param width width of the clip rectangle
|
|
2487
2533
|
* @param height height of the clip rectangle
|
|
2534
|
+
* @since 1.10
|
|
2488
2535
|
*/
|
|
2489
2536
|
push_scissor_clip(x: number, y: number, width: number, height: number): void;
|
|
2490
2537
|
|
|
@@ -2522,6 +2569,7 @@ export namespace Cogl {
|
|
|
2522
2569
|
* @param format The pixel format to store the data in
|
|
2523
2570
|
* @param pixels The address of the buffer to store the data in
|
|
2524
2571
|
* @returns `true` if the read succeeded or `false` otherwise.
|
|
2572
|
+
* @since 1.10
|
|
2525
2573
|
*/
|
|
2526
2574
|
read_pixels(x: number, y: number, width: number, height: number, format: PixelFormat, pixels: number): boolean;
|
|
2527
2575
|
|
|
@@ -2541,6 +2589,7 @@ export namespace Cogl {
|
|
|
2541
2589
|
* @param source Identifies which auxiliary buffer you want to read (only COGL_READ_PIXELS_COLOR_BUFFER supported currently)
|
|
2542
2590
|
* @param bitmap The bitmap to store the results in.
|
|
2543
2591
|
* @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.
|
|
2592
|
+
* @since 1.10
|
|
2544
2593
|
*/
|
|
2545
2594
|
read_pixels_into_bitmap(x: number, y: number, source: ReadPixelsFlags, bitmap: Bitmap): boolean;
|
|
2546
2595
|
|
|
@@ -2565,6 +2614,7 @@ export namespace Cogl {
|
|
|
2565
2614
|
* If you are performing incremental updates to a framebuffer you
|
|
2566
2615
|
* should consider using `cogl_framebuffer_resolve_samples_region()`
|
|
2567
2616
|
* instead to avoid resolving redundant pixels.
|
|
2617
|
+
* @since 1.8
|
|
2568
2618
|
*/
|
|
2569
2619
|
resolve_samples(): void;
|
|
2570
2620
|
|
|
@@ -2594,6 +2644,7 @@ export namespace Cogl {
|
|
|
2594
2644
|
* @param y top-left y coordinate of region to resolve
|
|
2595
2645
|
* @param width width of region to resolve
|
|
2596
2646
|
* @param height height of region to resolve
|
|
2647
|
+
* @since 1.8
|
|
2597
2648
|
*/
|
|
2598
2649
|
resolve_samples_region(x: number, y: number, width: number, height: number): void;
|
|
2599
2650
|
|
|
@@ -2607,6 +2658,7 @@ export namespace Cogl {
|
|
|
2607
2658
|
* @param x X-component of vertex to rotate around.
|
|
2608
2659
|
* @param y Y-component of vertex to rotate around.
|
|
2609
2660
|
* @param z Z-component of vertex to rotate around.
|
|
2661
|
+
* @since 1.10
|
|
2610
2662
|
*/
|
|
2611
2663
|
rotate(angle: number, x: number, y: number, z: number): void;
|
|
2612
2664
|
|
|
@@ -2614,6 +2666,7 @@ export namespace Cogl {
|
|
|
2614
2666
|
* Multiplies the current model-view matrix by one that rotates
|
|
2615
2667
|
* according to the rotation described by `euler`.
|
|
2616
2668
|
* @param euler A {@link Graphene.Euler}
|
|
2669
|
+
* @since 2.0
|
|
2617
2670
|
*/
|
|
2618
2671
|
rotate_euler(euler: Graphene.Euler): void;
|
|
2619
2672
|
|
|
@@ -2623,6 +2676,7 @@ export namespace Cogl {
|
|
|
2623
2676
|
* @param x Amount to scale along the x-axis
|
|
2624
2677
|
* @param y Amount to scale along the y-axis
|
|
2625
2678
|
* @param z Amount to scale along the z-axis
|
|
2679
|
+
* @since 1.10
|
|
2626
2680
|
*/
|
|
2627
2681
|
scale(x: number, y: number, z: number): void;
|
|
2628
2682
|
|
|
@@ -2634,6 +2688,7 @@ export namespace Cogl {
|
|
|
2634
2688
|
*
|
|
2635
2689
|
* Depth buffer writing is enabled by default.
|
|
2636
2690
|
* @param depth_write_enabled `true` to enable depth writing or `false` to disable
|
|
2691
|
+
* @since 1.18
|
|
2637
2692
|
*/
|
|
2638
2693
|
set_depth_write_enabled(depth_write_enabled: boolean): void;
|
|
2639
2694
|
|
|
@@ -2652,18 +2707,21 @@ export namespace Cogl {
|
|
|
2652
2707
|
*
|
|
2653
2708
|
* Dithering is enabled by default.
|
|
2654
2709
|
* @param dither_enabled `true` to enable dithering or `false` to disable
|
|
2710
|
+
* @since 1.8
|
|
2655
2711
|
*/
|
|
2656
2712
|
set_dither_enabled(dither_enabled: boolean): void;
|
|
2657
2713
|
|
|
2658
2714
|
/**
|
|
2659
2715
|
* Sets `matrix` as the new model-view matrix.
|
|
2660
2716
|
* @param matrix the new model-view matrix
|
|
2717
|
+
* @since 1.10
|
|
2661
2718
|
*/
|
|
2662
2719
|
set_modelview_matrix(matrix: Graphene.Matrix): void;
|
|
2663
2720
|
|
|
2664
2721
|
/**
|
|
2665
2722
|
* Sets `matrix` as the new projection matrix.
|
|
2666
2723
|
* @param matrix the new projection matrix
|
|
2724
|
+
* @since 1.10
|
|
2667
2725
|
*/
|
|
2668
2726
|
set_projection_matrix(matrix: Graphene.Matrix): void;
|
|
2669
2727
|
|
|
@@ -2701,6 +2759,7 @@ export namespace Cogl {
|
|
|
2701
2759
|
* framebuffer has changed this can lead to redundant work being
|
|
2702
2760
|
* done.</note>
|
|
2703
2761
|
* @param samples_per_pixel The minimum number of samples per pixel
|
|
2762
|
+
* @since 1.8
|
|
2704
2763
|
*/
|
|
2705
2764
|
set_samples_per_pixel(samples_per_pixel: number): void;
|
|
2706
2765
|
|
|
@@ -2713,6 +2772,7 @@ export namespace Cogl {
|
|
|
2713
2772
|
* enabled. (See `cogl_onscreen_template_set_stereo_enabled()`,
|
|
2714
2773
|
* `cogl_framebuffer_get_is_stereo()`.)
|
|
2715
2774
|
* @param stereo_mode A {@link Cogl.StereoMode} specifying which stereo buffers should be drawn tow.
|
|
2775
|
+
* @since 1.20
|
|
2716
2776
|
*/
|
|
2717
2777
|
set_stereo_mode(stereo_mode: StereoMode): void;
|
|
2718
2778
|
|
|
@@ -2736,12 +2796,14 @@ export namespace Cogl {
|
|
|
2736
2796
|
* @param y The top-left y coordinate of the viewport origin (only integers supported currently)
|
|
2737
2797
|
* @param width The width of the viewport (only integers supported currently)
|
|
2738
2798
|
* @param height The height of the viewport (only integers supported currently)
|
|
2799
|
+
* @since 1.8
|
|
2739
2800
|
*/
|
|
2740
2801
|
set_viewport(x: number, y: number, width: number, height: number): void;
|
|
2741
2802
|
|
|
2742
2803
|
/**
|
|
2743
2804
|
* Multiplies the current model-view matrix by the given matrix.
|
|
2744
2805
|
* @param matrix the matrix to multiply with the current model-view
|
|
2806
|
+
* @since 1.10
|
|
2745
2807
|
*/
|
|
2746
2808
|
transform(matrix: Graphene.Matrix): void;
|
|
2747
2809
|
|
|
@@ -2751,6 +2813,7 @@ export namespace Cogl {
|
|
|
2751
2813
|
* @param x Distance to translate along the x-axis
|
|
2752
2814
|
* @param y Distance to translate along the y-axis
|
|
2753
2815
|
* @param z Distance to translate along the z-axis
|
|
2816
|
+
* @since 1.10
|
|
2754
2817
|
*/
|
|
2755
2818
|
translate(x: number, y: number, z: number): void;
|
|
2756
2819
|
}
|
|
@@ -2924,6 +2987,7 @@ export namespace Cogl {
|
|
|
2924
2987
|
* explicitly checked to determine if Cogl is currently tracking the
|
|
2925
2988
|
* age of {@link Cogl.Onscreen} back buffer contents. If this feature is
|
|
2926
2989
|
* missing then this function will always return 0.</note>
|
|
2990
|
+
* @since 1.14
|
|
2927
2991
|
* @virtual
|
|
2928
2992
|
*/
|
|
2929
2993
|
vfunc_get_buffer_age(): number;
|
|
@@ -2969,6 +3033,7 @@ export namespace Cogl {
|
|
|
2969
3033
|
* @param rectangles An array of integer 4-tuples representing damaged rectangles as (x, y, width, height) tuples.
|
|
2970
3034
|
* @param n_rectangles The number of 4-tuples to be read from `rectangles`
|
|
2971
3035
|
* @param info
|
|
3036
|
+
* @since 1.16
|
|
2972
3037
|
* @virtual
|
|
2973
3038
|
*/
|
|
2974
3039
|
vfunc_swap_buffers_with_damage(rectangles: number, n_rectangles: number, info: FrameInfo): void;
|
|
@@ -2986,6 +3051,7 @@ export namespace Cogl {
|
|
|
2986
3051
|
* @param rectangles An array of integer 4-tuples representing rectangles as (x, y, width, height) tuples.
|
|
2987
3052
|
* @param n_rectangles The number of 4-tuples to be read from `rectangles`
|
|
2988
3053
|
* @param info
|
|
3054
|
+
* @since 1.10
|
|
2989
3055
|
* @virtual
|
|
2990
3056
|
*/
|
|
2991
3057
|
vfunc_swap_region(rectangles: number, n_rectangles: number, info: FrameInfo): void;
|
|
@@ -3011,6 +3077,7 @@ export namespace Cogl {
|
|
|
3011
3077
|
* @param callback A callback function to call for dirty events
|
|
3012
3078
|
* @param destroy An optional callback to destroy `user_data` when the `callback` is removed or `onscreen` is freed.
|
|
3013
3079
|
* @returns a {@link Cogl.OnscreenDirtyClosure} pointer that can be used to remove the callback and associated `user_data` later.
|
|
3080
|
+
* @since 1.16
|
|
3014
3081
|
*/
|
|
3015
3082
|
add_dirty_callback(callback: OnscreenDirtyCallback, destroy: UserDataDestroyCallback | null): OnscreenDirtyClosure;
|
|
3016
3083
|
|
|
@@ -3041,6 +3108,7 @@ export namespace Cogl {
|
|
|
3041
3108
|
* @param callback A callback function to call for frame events
|
|
3042
3109
|
* @param destroy An optional callback to destroy `user_data` when the `callback` is removed or `onscreen` is freed.
|
|
3043
3110
|
* @returns a {@link Cogl.FrameClosure} pointer that can be used to remove the callback and associated `user_data` later.
|
|
3111
|
+
* @since 1.14
|
|
3044
3112
|
*/
|
|
3045
3113
|
add_frame_callback(callback: FrameCallback, destroy: UserDataDestroyCallback | null): FrameClosure;
|
|
3046
3114
|
|
|
@@ -3084,6 +3152,7 @@ export namespace Cogl {
|
|
|
3084
3152
|
* age of {@link Cogl.Onscreen} back buffer contents. If this feature is
|
|
3085
3153
|
* missing then this function will always return 0.</note>
|
|
3086
3154
|
* @returns The age of the buffer contents or 0 when the buffer contents are undefined.
|
|
3155
|
+
* @since 1.14
|
|
3087
3156
|
*/
|
|
3088
3157
|
get_buffer_age(): number;
|
|
3089
3158
|
|
|
@@ -3093,6 +3162,7 @@ export namespace Cogl {
|
|
|
3093
3162
|
* `cogl_onscreen_swap_buffers()` or `cogl_onscreen_swap_region()`
|
|
3094
3163
|
* is called.
|
|
3095
3164
|
* @returns the current frame counter value
|
|
3165
|
+
* @since 1.14
|
|
3096
3166
|
*/
|
|
3097
3167
|
get_frame_counter(): number;
|
|
3098
3168
|
|
|
@@ -3111,6 +3181,7 @@ export namespace Cogl {
|
|
|
3111
3181
|
* requests e.g. to show an already visible window. This also means
|
|
3112
3182
|
* that it's acceptable to alternatively use native APIs to show and
|
|
3113
3183
|
* hide windows without confusing Cogl.</note>
|
|
3184
|
+
* @since 2.0
|
|
3114
3185
|
*/
|
|
3115
3186
|
hide(): void;
|
|
3116
3187
|
|
|
@@ -3122,6 +3193,7 @@ export namespace Cogl {
|
|
|
3122
3193
|
* `cogl_onscreen_add_dirty_callback()` to destroy the user data then
|
|
3123
3194
|
* this will also get called.
|
|
3124
3195
|
* @param closure A {@link Cogl.OnscreenDirtyClosure} returned from `cogl_onscreen_add_dirty_callback()`
|
|
3196
|
+
* @since 1.16
|
|
3125
3197
|
*/
|
|
3126
3198
|
remove_dirty_callback(closure: OnscreenDirtyClosure): void;
|
|
3127
3199
|
|
|
@@ -3133,6 +3205,7 @@ export namespace Cogl {
|
|
|
3133
3205
|
* `cogl_onscreen_add_frame_callback()` to destroy the user data then
|
|
3134
3206
|
* this will get called.
|
|
3135
3207
|
* @param closure A {@link Cogl.FrameClosure} returned from `cogl_onscreen_add_frame_callback()`
|
|
3208
|
+
* @since 1.14
|
|
3136
3209
|
*/
|
|
3137
3210
|
remove_frame_callback(closure: FrameClosure): void;
|
|
3138
3211
|
|
|
@@ -3157,6 +3230,7 @@ export namespace Cogl {
|
|
|
3157
3230
|
* requests e.g. to show an already visible window. This also means
|
|
3158
3231
|
* that it's acceptable to alternatively use native APIs to show and
|
|
3159
3232
|
* hide windows without confusing Cogl.</note>
|
|
3233
|
+
* @since 2.0
|
|
3160
3234
|
*/
|
|
3161
3235
|
show(): void;
|
|
3162
3236
|
|
|
@@ -3176,6 +3250,7 @@ export namespace Cogl {
|
|
|
3176
3250
|
* render a full buffer for every frame.</note>
|
|
3177
3251
|
* @param frame_info
|
|
3178
3252
|
* @param user_data
|
|
3253
|
+
* @since 1.10
|
|
3179
3254
|
*/
|
|
3180
3255
|
swap_buffers(frame_info: FrameInfo, user_data: null): void;
|
|
3181
3256
|
|
|
@@ -3221,6 +3296,7 @@ export namespace Cogl {
|
|
|
3221
3296
|
* @param n_rectangles The number of 4-tuples to be read from `rectangles`
|
|
3222
3297
|
* @param info
|
|
3223
3298
|
* @param user_data
|
|
3299
|
+
* @since 1.16
|
|
3224
3300
|
*/
|
|
3225
3301
|
swap_buffers_with_damage(rectangles: number, n_rectangles: number, info: FrameInfo, user_data: null): void;
|
|
3226
3302
|
|
|
@@ -3238,6 +3314,7 @@ export namespace Cogl {
|
|
|
3238
3314
|
* @param n_rectangles The number of 4-tuples to be read from `rectangles`
|
|
3239
3315
|
* @param info
|
|
3240
3316
|
* @param user_data
|
|
3317
|
+
* @since 1.10
|
|
3241
3318
|
*/
|
|
3242
3319
|
swap_region(rectangles: number, n_rectangles: number, info: FrameInfo, user_data: null): void;
|
|
3243
3320
|
}
|
|
@@ -3283,32 +3360,38 @@ export namespace Cogl {
|
|
|
3283
3360
|
* keep track of a pipelines ancestry which we may use to help minimize GPU
|
|
3284
3361
|
* state changes.
|
|
3285
3362
|
* @returns a pointer to the newly allocated {@link Cogl.Pipeline}
|
|
3363
|
+
* @since 2.0
|
|
3286
3364
|
*/
|
|
3287
3365
|
copy(): Pipeline;
|
|
3288
3366
|
|
|
3289
3367
|
/**
|
|
3290
3368
|
* Iterates all the layer indices of the given `pipeline`.
|
|
3291
3369
|
* @param callback A {@link Cogl.PipelineLayerCallback} to be called for each layer index
|
|
3370
|
+
* @since 2.0
|
|
3292
3371
|
*/
|
|
3293
3372
|
foreach_layer(callback: PipelineLayerCallback): void;
|
|
3294
3373
|
|
|
3295
3374
|
/**
|
|
3296
3375
|
* @returns The alpha test function of `pipeline`.
|
|
3376
|
+
* @since 2.0
|
|
3297
3377
|
*/
|
|
3298
3378
|
get_alpha_test_function(): PipelineAlphaFunc;
|
|
3299
3379
|
|
|
3300
3380
|
/**
|
|
3301
3381
|
* @returns The alpha test reference value of `pipeline`.
|
|
3382
|
+
* @since 2.0
|
|
3302
3383
|
*/
|
|
3303
3384
|
get_alpha_test_reference(): number;
|
|
3304
3385
|
|
|
3305
3386
|
/**
|
|
3306
3387
|
* Retrieves the current pipeline color.
|
|
3388
|
+
* @since 2.0
|
|
3307
3389
|
*/
|
|
3308
3390
|
get_color(): Color;
|
|
3309
3391
|
|
|
3310
3392
|
/**
|
|
3311
3393
|
* @returns the cull face mode that was previously set with `cogl_pipeline_set_cull_face_mode()`. Status: Unstable
|
|
3394
|
+
* @since 2.0
|
|
3312
3395
|
*/
|
|
3313
3396
|
get_cull_face_mode(): PipelineCullFaceMode;
|
|
3314
3397
|
|
|
@@ -3321,6 +3404,7 @@ export namespace Cogl {
|
|
|
3321
3404
|
* {@link Cogl.Winding.CLOCKWISE} sets them to be clockwise. The default is
|
|
3322
3405
|
* {@link Cogl.Winding.COUNTER_CLOCKWISE}.
|
|
3323
3406
|
* @returns The `pipeline` front face winding Status: Unstable
|
|
3407
|
+
* @since 2.0
|
|
3324
3408
|
*/
|
|
3325
3409
|
get_front_face_winding(): Winding;
|
|
3326
3410
|
|
|
@@ -3333,6 +3417,7 @@ export namespace Cogl {
|
|
|
3333
3417
|
* changed using `cogl_pipeline_set_layer_filters()`.
|
|
3334
3418
|
* @param layer_index the layer number to change.
|
|
3335
3419
|
* @returns The magnification {@link Cogl.PipelineFilter} for the specified layer.
|
|
3420
|
+
* @since 1.10
|
|
3336
3421
|
*/
|
|
3337
3422
|
get_layer_mag_filter(layer_index: number): PipelineFilter;
|
|
3338
3423
|
|
|
@@ -3345,6 +3430,7 @@ export namespace Cogl {
|
|
|
3345
3430
|
* changed using `cogl_pipeline_set_layer_filters()`.
|
|
3346
3431
|
* @param layer_index the layer number to change.
|
|
3347
3432
|
* @returns The minification {@link Cogl.PipelineFilter} for the specified layer.
|
|
3433
|
+
* @since 1.10
|
|
3348
3434
|
*/
|
|
3349
3435
|
get_layer_min_filter(layer_index: number): PipelineFilter;
|
|
3350
3436
|
|
|
@@ -3353,12 +3439,14 @@ export namespace Cogl {
|
|
|
3353
3439
|
* texture layer.
|
|
3354
3440
|
* @param layer_index the layer number to check.
|
|
3355
3441
|
* @returns whether the texture coordinates will be replaced with point sprite coordinates.
|
|
3442
|
+
* @since 2.0
|
|
3356
3443
|
*/
|
|
3357
3444
|
get_layer_point_sprite_coords_enabled(layer_index: number): boolean;
|
|
3358
3445
|
|
|
3359
3446
|
/**
|
|
3360
3447
|
* @param layer_index the index of the layer
|
|
3361
3448
|
* @returns the texture that was set for the given layer of the pipeline or `null` if no texture was set.
|
|
3449
|
+
* @since 1.10
|
|
3362
3450
|
*/
|
|
3363
3451
|
get_layer_texture(layer_index: number): Texture;
|
|
3364
3452
|
|
|
@@ -3367,6 +3455,7 @@ export namespace Cogl {
|
|
|
3367
3455
|
* layer.
|
|
3368
3456
|
* @param layer_index the layer number to change.
|
|
3369
3457
|
* @returns the wrap mode for the 's' coordinate of texture lookups on this layer.
|
|
3458
|
+
* @since 1.6
|
|
3370
3459
|
*/
|
|
3371
3460
|
get_layer_wrap_mode_s(layer_index: number): PipelineWrapMode;
|
|
3372
3461
|
|
|
@@ -3375,17 +3464,20 @@ export namespace Cogl {
|
|
|
3375
3464
|
* layer.
|
|
3376
3465
|
* @param layer_index the layer number to change.
|
|
3377
3466
|
* @returns the wrap mode for the 't' coordinate of texture lookups on this layer.
|
|
3467
|
+
* @since 1.6
|
|
3378
3468
|
*/
|
|
3379
3469
|
get_layer_wrap_mode_t(layer_index: number): PipelineWrapMode;
|
|
3380
3470
|
|
|
3381
3471
|
/**
|
|
3382
3472
|
* Retrieves the number of layers defined for the given `pipeline`
|
|
3383
3473
|
* @returns the number of layers
|
|
3474
|
+
* @since 2.0
|
|
3384
3475
|
*/
|
|
3385
3476
|
get_n_layers(): number;
|
|
3386
3477
|
|
|
3387
3478
|
/**
|
|
3388
3479
|
* @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()`.
|
|
3480
|
+
* @since 2.0
|
|
3389
3481
|
*/
|
|
3390
3482
|
get_per_vertex_point_size(): boolean;
|
|
3391
3483
|
|
|
@@ -3393,6 +3485,7 @@ export namespace Cogl {
|
|
|
3393
3485
|
* Get the size of points drawn when {@link Cogl.VerticesMode.POINTS} is
|
|
3394
3486
|
* used with the vertex buffer API.
|
|
3395
3487
|
* @returns the point size of the `pipeline`.
|
|
3488
|
+
* @since 2.0
|
|
3396
3489
|
*/
|
|
3397
3490
|
get_point_size(): number;
|
|
3398
3491
|
|
|
@@ -3408,6 +3501,7 @@ export namespace Cogl {
|
|
|
3408
3501
|
* before calling this function.
|
|
3409
3502
|
* @param uniform_name The name of a uniform
|
|
3410
3503
|
* @returns A integer representing the location of the given uniform.
|
|
3504
|
+
* @since 2.0
|
|
3411
3505
|
*/
|
|
3412
3506
|
get_uniform_location(uniform_name: string): number;
|
|
3413
3507
|
|
|
@@ -3415,12 +3509,14 @@ export namespace Cogl {
|
|
|
3415
3509
|
* Queries what user program has been associated with the given
|
|
3416
3510
|
* `pipeline` using `cogl_pipeline_set_user_program()`.
|
|
3417
3511
|
* @returns The current user program or `null`.
|
|
3512
|
+
* @since 2.0
|
|
3418
3513
|
*/
|
|
3419
3514
|
get_user_program(): Handle;
|
|
3420
3515
|
|
|
3421
3516
|
/**
|
|
3422
3517
|
* This function removes a layer from your pipeline
|
|
3423
3518
|
* @param layer_index Specifies the layer you want to remove
|
|
3519
|
+
* @since 1.10
|
|
3424
3520
|
*/
|
|
3425
3521
|
remove_layer(layer_index: number): void;
|
|
3426
3522
|
|
|
@@ -3434,6 +3530,7 @@ export namespace Cogl {
|
|
|
3434
3530
|
* The default is {@link Cogl.PipelineAlphaFunc.ALWAYS}
|
|
3435
3531
|
* @param alpha_func A `CoglPipelineAlphaFunc` constant
|
|
3436
3532
|
* @param alpha_reference A reference point that the chosen alpha function uses to compare incoming fragments to.
|
|
3533
|
+
* @since 2.0
|
|
3437
3534
|
*/
|
|
3438
3535
|
set_alpha_test_function(alpha_func: PipelineAlphaFunc, alpha_reference: number): void;
|
|
3439
3536
|
|
|
@@ -3505,6 +3602,7 @@ export namespace Cogl {
|
|
|
3505
3602
|
* is in premultiplied form.
|
|
3506
3603
|
* @param blend_string A <link linkend="cogl-Blend-Strings">Cogl blend string</link> describing the desired blend function.
|
|
3507
3604
|
* @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).
|
|
3605
|
+
* @since 2.0
|
|
3508
3606
|
*/
|
|
3509
3607
|
set_blend(blend_string: string): boolean;
|
|
3510
3608
|
|
|
@@ -3512,6 +3610,7 @@ export namespace Cogl {
|
|
|
3512
3610
|
* When blending is setup to reference a CONSTANT blend factor then
|
|
3513
3611
|
* blending will depend on the constant set with this function.
|
|
3514
3612
|
* @param constant_color The constant color you want
|
|
3613
|
+
* @since 2.0
|
|
3515
3614
|
*/
|
|
3516
3615
|
set_blend_constant(constant_color: Color): void;
|
|
3517
3616
|
|
|
@@ -3525,6 +3624,7 @@ export namespace Cogl {
|
|
|
3525
3624
|
*
|
|
3526
3625
|
* The default value is (1.0, 1.0, 1.0, 1.0)
|
|
3527
3626
|
* @param color The components of the color
|
|
3627
|
+
* @since 2.0
|
|
3528
3628
|
*/
|
|
3529
3629
|
set_color(color: Color): void;
|
|
3530
3630
|
|
|
@@ -3536,6 +3636,7 @@ export namespace Cogl {
|
|
|
3536
3636
|
* @param green The green component
|
|
3537
3637
|
* @param blue The blue component
|
|
3538
3638
|
* @param alpha The alpha component
|
|
3639
|
+
* @since 2.0
|
|
3539
3640
|
*/
|
|
3540
3641
|
set_color4f(red: number, green: number, blue: number, alpha: number): void;
|
|
3541
3642
|
|
|
@@ -3547,6 +3648,7 @@ export namespace Cogl {
|
|
|
3547
3648
|
* @param green The green component
|
|
3548
3649
|
* @param blue The blue component
|
|
3549
3650
|
* @param alpha The alpha component
|
|
3651
|
+
* @since 2.0
|
|
3550
3652
|
*/
|
|
3551
3653
|
set_color4ub(red: number, green: number, blue: number, alpha: number): void;
|
|
3552
3654
|
|
|
@@ -3566,6 +3668,7 @@ export namespace Cogl {
|
|
|
3566
3668
|
*
|
|
3567
3669
|
* Status: Unstable
|
|
3568
3670
|
* @param cull_face_mode The new mode to set
|
|
3671
|
+
* @since 2.0
|
|
3569
3672
|
*/
|
|
3570
3673
|
set_cull_face_mode(cull_face_mode: PipelineCullFaceMode): void;
|
|
3571
3674
|
|
|
@@ -3580,6 +3683,7 @@ export namespace Cogl {
|
|
|
3580
3683
|
*
|
|
3581
3684
|
* Status: Unstable
|
|
3582
3685
|
* @param front_winding the winding order
|
|
3686
|
+
* @since 2.0
|
|
3583
3687
|
*/
|
|
3584
3688
|
set_front_face_winding(front_winding: Winding): void;
|
|
3585
3689
|
|
|
@@ -3663,6 +3767,7 @@ export namespace Cogl {
|
|
|
3663
3767
|
* @param layer_index Specifies the layer you want define a combine function for
|
|
3664
3768
|
* @param blend_string A <link linkend="cogl-Blend-Strings">Cogl blend string</link> describing the desired texture combine function.
|
|
3665
3769
|
* @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
|
|
3770
|
+
* @since 2.0
|
|
3666
3771
|
*/
|
|
3667
3772
|
set_layer_combine(layer_index: number, blend_string: string): boolean;
|
|
3668
3773
|
|
|
@@ -3671,6 +3776,7 @@ export namespace Cogl {
|
|
|
3671
3776
|
* description then you can use this function to define its value.
|
|
3672
3777
|
* @param layer_index Specifies the layer you want to specify a constant used for texture combining
|
|
3673
3778
|
* @param constant The constant color you want
|
|
3779
|
+
* @since 2.0
|
|
3674
3780
|
*/
|
|
3675
3781
|
set_layer_combine_constant(layer_index: number, constant: Color): void;
|
|
3676
3782
|
|
|
@@ -3685,6 +3791,7 @@ export namespace Cogl {
|
|
|
3685
3791
|
* @param layer_index the layer number to change.
|
|
3686
3792
|
* @param min_filter the filter used when scaling a texture down.
|
|
3687
3793
|
* @param mag_filter the filter used when magnifying a texture.
|
|
3794
|
+
* @since 1.10
|
|
3688
3795
|
*/
|
|
3689
3796
|
set_layer_filters(layer_index: number, min_filter: PipelineFilter, mag_filter: PipelineFilter): void;
|
|
3690
3797
|
|
|
@@ -3693,6 +3800,7 @@ export namespace Cogl {
|
|
|
3693
3800
|
* and rotate a single layer of a pipeline used to fill your geometry.
|
|
3694
3801
|
* @param layer_index the index for the layer inside `pipeline`
|
|
3695
3802
|
* @param matrix the transformation matrix for the layer
|
|
3803
|
+
* @since 1.10
|
|
3696
3804
|
*/
|
|
3697
3805
|
set_layer_matrix(layer_index: number, matrix: Graphene.Matrix): void;
|
|
3698
3806
|
|
|
@@ -3712,6 +3820,7 @@ export namespace Cogl {
|
|
|
3712
3820
|
* specify the texture type so that any pipeline copies can share the
|
|
3713
3821
|
* internal texture type state for efficiency.
|
|
3714
3822
|
* @param layer_index The layer number to modify
|
|
3823
|
+
* @since 1.10
|
|
3715
3824
|
*/
|
|
3716
3825
|
set_layer_null_texture(layer_index: number): void;
|
|
3717
3826
|
|
|
@@ -3725,6 +3834,7 @@ export namespace Cogl {
|
|
|
3725
3834
|
* @param layer_index the layer number to change.
|
|
3726
3835
|
* @param enable whether to enable point sprite coord generation.
|
|
3727
3836
|
* @returns `true` if the function succeeds, `false` otherwise.
|
|
3837
|
+
* @since 2.0
|
|
3728
3838
|
*/
|
|
3729
3839
|
set_layer_point_sprite_coords_enabled(layer_index: number, enable: boolean): boolean;
|
|
3730
3840
|
|
|
@@ -3741,6 +3851,7 @@ export namespace Cogl {
|
|
|
3741
3851
|
* `cogl_pipeline_set_layer_wrap_mode_t()` separately.
|
|
3742
3852
|
* @param layer_index the layer number to change.
|
|
3743
3853
|
* @param mode the new wrap mode
|
|
3854
|
+
* @since 2.0
|
|
3744
3855
|
*/
|
|
3745
3856
|
set_layer_wrap_mode(layer_index: number, mode: PipelineWrapMode): void;
|
|
3746
3857
|
|
|
@@ -3748,6 +3859,7 @@ export namespace Cogl {
|
|
|
3748
3859
|
* Sets the wrap mode for the 's' coordinate of texture lookups on this layer.
|
|
3749
3860
|
* @param layer_index the layer number to change.
|
|
3750
3861
|
* @param mode the new wrap mode
|
|
3862
|
+
* @since 2.0
|
|
3751
3863
|
*/
|
|
3752
3864
|
set_layer_wrap_mode_s(layer_index: number, mode: PipelineWrapMode): void;
|
|
3753
3865
|
|
|
@@ -3755,6 +3867,7 @@ export namespace Cogl {
|
|
|
3755
3867
|
* Sets the wrap mode for the 't' coordinate of texture lookups on this layer.
|
|
3756
3868
|
* @param layer_index the layer number to change.
|
|
3757
3869
|
* @param mode the new wrap mode
|
|
3870
|
+
* @since 2.0
|
|
3758
3871
|
*/
|
|
3759
3872
|
set_layer_wrap_mode_t(layer_index: number, mode: PipelineWrapMode): void;
|
|
3760
3873
|
|
|
@@ -3771,6 +3884,7 @@ export namespace Cogl {
|
|
|
3771
3884
|
* undefined.
|
|
3772
3885
|
* @param enable whether to enable per-vertex point size
|
|
3773
3886
|
* @returns `true` if the change succeeded or `false` otherwise
|
|
3887
|
+
* @since 2.0
|
|
3774
3888
|
*/
|
|
3775
3889
|
set_per_vertex_point_size(enable: boolean): boolean;
|
|
3776
3890
|
|
|
@@ -3788,6 +3902,7 @@ export namespace Cogl {
|
|
|
3788
3902
|
* if an application wants to draw points it must make sure to use a
|
|
3789
3903
|
* pipeline that has an explicit point size set on it.
|
|
3790
3904
|
* @param point_size the new point size.
|
|
3905
|
+
* @since 2.0
|
|
3791
3906
|
*/
|
|
3792
3907
|
set_point_size(point_size: number): void;
|
|
3793
3908
|
|
|
@@ -3804,6 +3919,7 @@ export namespace Cogl {
|
|
|
3804
3919
|
* uniform.
|
|
3805
3920
|
* @param uniform_location The uniform's location identifier
|
|
3806
3921
|
* @param value The new value for the uniform
|
|
3922
|
+
* @since 2.0
|
|
3807
3923
|
*/
|
|
3808
3924
|
set_uniform_1f(uniform_location: number, value: number): void;
|
|
3809
3925
|
|
|
@@ -3820,6 +3936,7 @@ export namespace Cogl {
|
|
|
3820
3936
|
* uniform or a sampler uniform.
|
|
3821
3937
|
* @param uniform_location The uniform's location identifier
|
|
3822
3938
|
* @param value The new value for the uniform
|
|
3939
|
+
* @since 2.0
|
|
3823
3940
|
*/
|
|
3824
3941
|
set_uniform_1i(uniform_location: number, value: number): void;
|
|
3825
3942
|
|
|
@@ -3840,6 +3957,7 @@ export namespace Cogl {
|
|
|
3840
3957
|
* @param n_components The number of components in the corresponding uniform's type
|
|
3841
3958
|
* @param count The number of values to set
|
|
3842
3959
|
* @param value Pointer to the new values to set
|
|
3960
|
+
* @since 2.0
|
|
3843
3961
|
*/
|
|
3844
3962
|
set_uniform_float(uniform_location: number, n_components: number, count: number, value: number): void;
|
|
3845
3963
|
|
|
@@ -3860,6 +3978,7 @@ export namespace Cogl {
|
|
|
3860
3978
|
* @param n_components The number of components in the corresponding uniform's type
|
|
3861
3979
|
* @param count The number of values to set
|
|
3862
3980
|
* @param value Pointer to the new values to set
|
|
3981
|
+
* @since 2.0
|
|
3863
3982
|
*/
|
|
3864
3983
|
set_uniform_int(uniform_location: number, n_components: number, count: number, value: number): void;
|
|
3865
3984
|
|
|
@@ -3886,6 +4005,7 @@ export namespace Cogl {
|
|
|
3886
4005
|
* @param count The number of values to set
|
|
3887
4006
|
* @param transpose Whether to transpose the matrix
|
|
3888
4007
|
* @param value Pointer to the new values to set
|
|
4008
|
+
* @since 2.0
|
|
3889
4009
|
*/
|
|
3890
4010
|
set_uniform_matrix(uniform_location: number, dimensions: number, count: number, transpose: boolean, value: number): void;
|
|
3891
4011
|
|
|
@@ -3926,6 +4046,7 @@ export namespace Cogl {
|
|
|
3926
4046
|
* meantime we hope this will handle most practical GLSL and ARBfp
|
|
3927
4047
|
* requirements.
|
|
3928
4048
|
* @param program A {@link Cogl.Handle} to a linked CoglProgram
|
|
4049
|
+
* @since 2.0
|
|
3929
4050
|
*/
|
|
3930
4051
|
set_user_program(program: Handle): void;
|
|
3931
4052
|
}
|
|
@@ -3992,6 +4113,7 @@ export namespace Cogl {
|
|
|
3992
4113
|
* is {@link Cogl.TextureComponents.RGBA}. The other constructors which take
|
|
3993
4114
|
* a %CoglBitmap or a data pointer default to the same components as
|
|
3994
4115
|
* the pixel format of the data.
|
|
4116
|
+
* @since 1.18
|
|
3995
4117
|
*/
|
|
3996
4118
|
get_components(): TextureComponents;
|
|
3997
4119
|
|
|
@@ -4038,6 +4160,7 @@ export namespace Cogl {
|
|
|
4038
4160
|
*
|
|
4039
4161
|
* By default the pre-multipled state is `TRUE`.
|
|
4040
4162
|
* @returns `true` if red, green and blue components are internally stored pre-multiplied by the alpha value or `false` if not.
|
|
4163
|
+
* @since 1.18
|
|
4041
4164
|
*/
|
|
4042
4165
|
get_premultiplied(): boolean;
|
|
4043
4166
|
|
|
@@ -4070,6 +4193,8 @@ export namespace Cogl {
|
|
|
4070
4193
|
* @param sub_width Width in pixels of the subregion
|
|
4071
4194
|
* @param sub_height Height in pixels of the subregion
|
|
4072
4195
|
* @returns A newly created {@link Cogl.Texture} or `null` on failure
|
|
4196
|
+
* @since 1.2
|
|
4197
|
+
* @deprecated since 1.18: Use `cogl_sub_texture_new()`
|
|
4073
4198
|
*/
|
|
4074
4199
|
new_from_sub_texture(sub_x: number, sub_y: number, sub_width: number, sub_height: number): Texture;
|
|
4075
4200
|
|
|
@@ -4094,6 +4219,7 @@ export namespace Cogl {
|
|
|
4094
4219
|
* an image format as long as {@link Cogl.TextureComponents.RG} isn't used
|
|
4095
4220
|
* as the texture's components.
|
|
4096
4221
|
* @param components
|
|
4222
|
+
* @since 1.18
|
|
4097
4223
|
*/
|
|
4098
4224
|
set_components(components: TextureComponents): void;
|
|
4099
4225
|
|
|
@@ -4171,6 +4297,7 @@ export namespace Cogl {
|
|
|
4171
4297
|
*
|
|
4172
4298
|
* By default the `premultipled` state is `TRUE`.
|
|
4173
4299
|
* @param premultiplied Whether any internally stored red, green or blue components are pre-multiplied by an alpha component.
|
|
4300
|
+
* @since 1.18
|
|
4174
4301
|
*/
|
|
4175
4302
|
set_premultiplied(premultiplied: boolean): void;
|
|
4176
4303
|
|
|
@@ -4208,6 +4335,7 @@ export namespace Cogl {
|
|
|
4208
4335
|
* @param dst_height height of destination region to write. (Must be less than or equal to the bitmap height)
|
|
4209
4336
|
* @param bitmap The source bitmap to read from
|
|
4210
4337
|
* @returns `true` if the subregion upload was successful, and `false` otherwise
|
|
4338
|
+
* @since 1.8
|
|
4211
4339
|
*/
|
|
4212
4340
|
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;
|
|
4213
4341
|
}
|
|
@@ -4266,6 +4394,7 @@ export namespace Cogl {
|
|
|
4266
4394
|
* is {@link Cogl.TextureComponents.RGBA}. The other constructors which take
|
|
4267
4395
|
* a %CoglBitmap or a data pointer default to the same components as
|
|
4268
4396
|
* the pixel format of the data.
|
|
4397
|
+
* @since 1.18
|
|
4269
4398
|
*/
|
|
4270
4399
|
get_components(): TextureComponents;
|
|
4271
4400
|
|
|
@@ -4312,6 +4441,7 @@ export namespace Cogl {
|
|
|
4312
4441
|
*
|
|
4313
4442
|
* By default the pre-multipled state is `TRUE`.
|
|
4314
4443
|
* @returns `true` if red, green and blue components are internally stored pre-multiplied by the alpha value or `false` if not.
|
|
4444
|
+
* @since 1.18
|
|
4315
4445
|
*/
|
|
4316
4446
|
get_premultiplied(): boolean;
|
|
4317
4447
|
|
|
@@ -4344,6 +4474,8 @@ export namespace Cogl {
|
|
|
4344
4474
|
* @param sub_width Width in pixels of the subregion
|
|
4345
4475
|
* @param sub_height Height in pixels of the subregion
|
|
4346
4476
|
* @returns A newly created {@link Cogl.Texture} or `null` on failure
|
|
4477
|
+
* @since 1.2
|
|
4478
|
+
* @deprecated since 1.18: Use `cogl_sub_texture_new()`
|
|
4347
4479
|
*/
|
|
4348
4480
|
new_from_sub_texture(sub_x: number, sub_y: number, sub_width: number, sub_height: number): Texture;
|
|
4349
4481
|
|
|
@@ -4368,6 +4500,7 @@ export namespace Cogl {
|
|
|
4368
4500
|
* an image format as long as {@link Cogl.TextureComponents.RG} isn't used
|
|
4369
4501
|
* as the texture's components.
|
|
4370
4502
|
* @param components
|
|
4503
|
+
* @since 1.18
|
|
4371
4504
|
*/
|
|
4372
4505
|
set_components(components: TextureComponents): void;
|
|
4373
4506
|
|
|
@@ -4445,6 +4578,7 @@ export namespace Cogl {
|
|
|
4445
4578
|
*
|
|
4446
4579
|
* By default the `premultipled` state is `TRUE`.
|
|
4447
4580
|
* @param premultiplied Whether any internally stored red, green or blue components are pre-multiplied by an alpha component.
|
|
4581
|
+
* @since 1.18
|
|
4448
4582
|
*/
|
|
4449
4583
|
set_premultiplied(premultiplied: boolean): void;
|
|
4450
4584
|
|
|
@@ -4482,6 +4616,7 @@ export namespace Cogl {
|
|
|
4482
4616
|
* @param dst_height height of destination region to write. (Must be less than or equal to the bitmap height)
|
|
4483
4617
|
* @param bitmap The source bitmap to read from
|
|
4484
4618
|
* @returns `true` if the subregion upload was successful, and `false` otherwise
|
|
4619
|
+
* @since 1.8
|
|
4485
4620
|
*/
|
|
4486
4621
|
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;
|
|
4487
4622
|
}
|
|
@@ -4510,6 +4645,7 @@ export namespace Cogl {
|
|
|
4510
4645
|
* parameter, when using {@link Cogl.Color}<!-- -->s as keys in a {@link GLib.HashTable}.
|
|
4511
4646
|
* @param v1 a {@link Cogl.Color}
|
|
4512
4647
|
* @param v2 a {@link Cogl.Color}
|
|
4648
|
+
* @since 1.0
|
|
4513
4649
|
*/
|
|
4514
4650
|
static equal(v1: null, v2: null): boolean;
|
|
4515
4651
|
|
|
@@ -4519,6 +4655,7 @@ export namespace Cogl {
|
|
|
4519
4655
|
* @param hue hue value, in the 0 .. 360 range
|
|
4520
4656
|
* @param saturation saturation value, in the 0 .. 1 range
|
|
4521
4657
|
* @param luminance luminance value, in the 0 .. 1 range
|
|
4658
|
+
* @since 1.16
|
|
4522
4659
|
*/
|
|
4523
4660
|
static init_from_hsl(hue: number, saturation: number, luminance: number): Color;
|
|
4524
4661
|
|
|
@@ -4526,11 +4663,13 @@ export namespace Cogl {
|
|
|
4526
4663
|
/**
|
|
4527
4664
|
* Creates a copy of `color`
|
|
4528
4665
|
* @returns a newly-allocated {@link Cogl.Color}. Use `cogl_color_free()` to free the allocate resources
|
|
4666
|
+
* @since 1.0
|
|
4529
4667
|
*/
|
|
4530
4668
|
copy(): Color;
|
|
4531
4669
|
|
|
4532
4670
|
/**
|
|
4533
4671
|
* Frees the resources allocated by `cogl_color_new()` and `cogl_color_copy()`
|
|
4672
|
+
* @since 1.0
|
|
4534
4673
|
*/
|
|
4535
4674
|
free(): void;
|
|
4536
4675
|
|
|
@@ -4538,6 +4677,7 @@ export namespace Cogl {
|
|
|
4538
4677
|
* Retrieves the alpha channel of `color` as a fixed point
|
|
4539
4678
|
* value between 0 and 1.0.
|
|
4540
4679
|
* @returns the alpha channel of the passed color
|
|
4680
|
+
* @since 1.0
|
|
4541
4681
|
*/
|
|
4542
4682
|
get_alpha(): number;
|
|
4543
4683
|
|
|
@@ -4545,6 +4685,7 @@ export namespace Cogl {
|
|
|
4545
4685
|
* Retrieves the alpha channel of `color` as a byte value
|
|
4546
4686
|
* between 0 and 255
|
|
4547
4687
|
* @returns the alpha channel of the passed color
|
|
4688
|
+
* @since 1.0
|
|
4548
4689
|
*/
|
|
4549
4690
|
get_alpha_byte(): number;
|
|
4550
4691
|
|
|
@@ -4552,6 +4693,7 @@ export namespace Cogl {
|
|
|
4552
4693
|
* Retrieves the alpha channel of `color` as a floating point
|
|
4553
4694
|
* value between 0.0 and 1.0
|
|
4554
4695
|
* @returns the alpha channel of the passed color
|
|
4696
|
+
* @since 1.0
|
|
4555
4697
|
*/
|
|
4556
4698
|
get_alpha_float(): number;
|
|
4557
4699
|
|
|
@@ -4559,6 +4701,7 @@ export namespace Cogl {
|
|
|
4559
4701
|
* Retrieves the blue channel of `color` as a fixed point
|
|
4560
4702
|
* value between 0 and 1.0.
|
|
4561
4703
|
* @returns the blue channel of the passed color
|
|
4704
|
+
* @since 1.0
|
|
4562
4705
|
*/
|
|
4563
4706
|
get_blue(): number;
|
|
4564
4707
|
|
|
@@ -4566,6 +4709,7 @@ export namespace Cogl {
|
|
|
4566
4709
|
* Retrieves the blue channel of `color` as a byte value
|
|
4567
4710
|
* between 0 and 255
|
|
4568
4711
|
* @returns the blue channel of the passed color
|
|
4712
|
+
* @since 1.0
|
|
4569
4713
|
*/
|
|
4570
4714
|
get_blue_byte(): number;
|
|
4571
4715
|
|
|
@@ -4573,6 +4717,7 @@ export namespace Cogl {
|
|
|
4573
4717
|
* Retrieves the blue channel of `color` as a floating point
|
|
4574
4718
|
* value between 0.0 and 1.0
|
|
4575
4719
|
* @returns the blue channel of the passed color
|
|
4720
|
+
* @since 1.0
|
|
4576
4721
|
*/
|
|
4577
4722
|
get_blue_float(): number;
|
|
4578
4723
|
|
|
@@ -4580,6 +4725,7 @@ export namespace Cogl {
|
|
|
4580
4725
|
* Retrieves the green channel of `color` as a fixed point
|
|
4581
4726
|
* value between 0 and 1.0.
|
|
4582
4727
|
* @returns the green channel of the passed color
|
|
4728
|
+
* @since 1.0
|
|
4583
4729
|
*/
|
|
4584
4730
|
get_green(): number;
|
|
4585
4731
|
|
|
@@ -4587,6 +4733,7 @@ export namespace Cogl {
|
|
|
4587
4733
|
* Retrieves the green channel of `color` as a byte value
|
|
4588
4734
|
* between 0 and 255
|
|
4589
4735
|
* @returns the green channel of the passed color
|
|
4736
|
+
* @since 1.0
|
|
4590
4737
|
*/
|
|
4591
4738
|
get_green_byte(): number;
|
|
4592
4739
|
|
|
@@ -4594,6 +4741,7 @@ export namespace Cogl {
|
|
|
4594
4741
|
* Retrieves the green channel of `color` as a floating point
|
|
4595
4742
|
* value between 0.0 and 1.0
|
|
4596
4743
|
* @returns the green channel of the passed color
|
|
4744
|
+
* @since 1.0
|
|
4597
4745
|
*/
|
|
4598
4746
|
get_green_float(): number;
|
|
4599
4747
|
|
|
@@ -4601,6 +4749,7 @@ export namespace Cogl {
|
|
|
4601
4749
|
* Retrieves the red channel of `color` as a fixed point
|
|
4602
4750
|
* value between 0 and 1.0.
|
|
4603
4751
|
* @returns the red channel of the passed color
|
|
4752
|
+
* @since 1.0
|
|
4604
4753
|
*/
|
|
4605
4754
|
get_red(): number;
|
|
4606
4755
|
|
|
@@ -4608,6 +4757,7 @@ export namespace Cogl {
|
|
|
4608
4757
|
* Retrieves the red channel of `color` as a byte value
|
|
4609
4758
|
* between 0 and 255
|
|
4610
4759
|
* @returns the red channel of the passed color
|
|
4760
|
+
* @since 1.0
|
|
4611
4761
|
*/
|
|
4612
4762
|
get_red_byte(): number;
|
|
4613
4763
|
|
|
@@ -4615,6 +4765,7 @@ export namespace Cogl {
|
|
|
4615
4765
|
* Retrieves the red channel of `color` as a floating point
|
|
4616
4766
|
* value between 0.0 and 1.0
|
|
4617
4767
|
* @returns the red channel of the passed color
|
|
4768
|
+
* @since 1.0
|
|
4618
4769
|
*/
|
|
4619
4770
|
get_red_float(): number;
|
|
4620
4771
|
|
|
@@ -4624,12 +4775,14 @@ export namespace Cogl {
|
|
|
4624
4775
|
* @param green value of the green channel, between 0 and 1.0
|
|
4625
4776
|
* @param blue value of the blue channel, between 0 and 1.0
|
|
4626
4777
|
* @param alpha value of the alpha channel, between 0 and 1.0
|
|
4778
|
+
* @since 1.4
|
|
4627
4779
|
*/
|
|
4628
4780
|
init_from_4f(red: number, green: number, blue: number, alpha: number): void;
|
|
4629
4781
|
|
|
4630
4782
|
/**
|
|
4631
4783
|
* Sets the values of the passed channels into a {@link Cogl.Color}
|
|
4632
4784
|
* @param color_array a pointer to an array of 4 float color components
|
|
4785
|
+
* @since 1.4
|
|
4633
4786
|
*/
|
|
4634
4787
|
init_from_4fv(color_array: number): void;
|
|
4635
4788
|
|
|
@@ -4639,6 +4792,7 @@ export namespace Cogl {
|
|
|
4639
4792
|
* @param green value of the green channel, between 0 and 255
|
|
4640
4793
|
* @param blue value of the blue channel, between 0 and 255
|
|
4641
4794
|
* @param alpha value of the alpha channel, between 0 and 255
|
|
4795
|
+
* @since 1.4
|
|
4642
4796
|
*/
|
|
4643
4797
|
init_from_4ub(red: number, green: number, blue: number, alpha: number): void;
|
|
4644
4798
|
|
|
@@ -4646,78 +4800,91 @@ export namespace Cogl {
|
|
|
4646
4800
|
* Converts a non-premultiplied color to a pre-multiplied color. For
|
|
4647
4801
|
* example, semi-transparent red is (1.0, 0, 0, 0.5) when non-premultiplied
|
|
4648
4802
|
* and (0.5, 0, 0, 0.5) when premultiplied.
|
|
4803
|
+
* @since 1.0
|
|
4649
4804
|
*/
|
|
4650
4805
|
premultiply(): void;
|
|
4651
4806
|
|
|
4652
4807
|
/**
|
|
4653
4808
|
* Sets the alpha channel of `color` to `alpha`.
|
|
4654
4809
|
* @param alpha a float value between 0.0f and 1.0f
|
|
4810
|
+
* @since 1.4
|
|
4655
4811
|
*/
|
|
4656
4812
|
set_alpha(alpha: number): void;
|
|
4657
4813
|
|
|
4658
4814
|
/**
|
|
4659
4815
|
* Sets the alpha channel of `color` to `alpha`.
|
|
4660
4816
|
* @param alpha a byte value between 0 and 255
|
|
4817
|
+
* @since 1.4
|
|
4661
4818
|
*/
|
|
4662
4819
|
set_alpha_byte(alpha: number): void;
|
|
4663
4820
|
|
|
4664
4821
|
/**
|
|
4665
4822
|
* Sets the alpha channel of `color` to `alpha`.
|
|
4666
4823
|
* @param alpha a float value between 0.0f and 1.0f
|
|
4824
|
+
* @since 1.4
|
|
4667
4825
|
*/
|
|
4668
4826
|
set_alpha_float(alpha: number): void;
|
|
4669
4827
|
|
|
4670
4828
|
/**
|
|
4671
4829
|
* Sets the blue channel of `color` to `blue`.
|
|
4672
4830
|
* @param blue a float value between 0.0f and 1.0f
|
|
4831
|
+
* @since 1.4
|
|
4673
4832
|
*/
|
|
4674
4833
|
set_blue(blue: number): void;
|
|
4675
4834
|
|
|
4676
4835
|
/**
|
|
4677
4836
|
* Sets the blue channel of `color` to `blue`.
|
|
4678
4837
|
* @param blue a byte value between 0 and 255
|
|
4838
|
+
* @since 1.4
|
|
4679
4839
|
*/
|
|
4680
4840
|
set_blue_byte(blue: number): void;
|
|
4681
4841
|
|
|
4682
4842
|
/**
|
|
4683
4843
|
* Sets the blue channel of `color` to `blue`.
|
|
4684
4844
|
* @param blue a float value between 0.0f and 1.0f
|
|
4845
|
+
* @since 1.4
|
|
4685
4846
|
*/
|
|
4686
4847
|
set_blue_float(blue: number): void;
|
|
4687
4848
|
|
|
4688
4849
|
/**
|
|
4689
4850
|
* Sets the green channel of `color` to `green`.
|
|
4690
4851
|
* @param green a float value between 0.0f and 1.0f
|
|
4852
|
+
* @since 1.4
|
|
4691
4853
|
*/
|
|
4692
4854
|
set_green(green: number): void;
|
|
4693
4855
|
|
|
4694
4856
|
/**
|
|
4695
4857
|
* Sets the green channel of `color` to `green`.
|
|
4696
4858
|
* @param green a byte value between 0 and 255
|
|
4859
|
+
* @since 1.4
|
|
4697
4860
|
*/
|
|
4698
4861
|
set_green_byte(green: number): void;
|
|
4699
4862
|
|
|
4700
4863
|
/**
|
|
4701
4864
|
* Sets the green channel of `color` to `green`.
|
|
4702
4865
|
* @param green a float value between 0.0f and 1.0f
|
|
4866
|
+
* @since 1.4
|
|
4703
4867
|
*/
|
|
4704
4868
|
set_green_float(green: number): void;
|
|
4705
4869
|
|
|
4706
4870
|
/**
|
|
4707
4871
|
* Sets the red channel of `color` to `red`.
|
|
4708
4872
|
* @param red a float value between 0.0f and 1.0f
|
|
4873
|
+
* @since 1.4
|
|
4709
4874
|
*/
|
|
4710
4875
|
set_red(red: number): void;
|
|
4711
4876
|
|
|
4712
4877
|
/**
|
|
4713
4878
|
* Sets the red channel of `color` to `red`.
|
|
4714
4879
|
* @param red a byte value between 0 and 255
|
|
4880
|
+
* @since 1.4
|
|
4715
4881
|
*/
|
|
4716
4882
|
set_red_byte(red: number): void;
|
|
4717
4883
|
|
|
4718
4884
|
/**
|
|
4719
4885
|
* Sets the red channel of `color` to `red`.
|
|
4720
4886
|
* @param red a float value between 0.0f and 1.0f
|
|
4887
|
+
* @since 1.4
|
|
4721
4888
|
*/
|
|
4722
4889
|
set_red_float(red: number): void;
|
|
4723
4890
|
|
|
@@ -4726,6 +4893,7 @@ export namespace Cogl {
|
|
|
4726
4893
|
*
|
|
4727
4894
|
* The `hue` value is in the 0 .. 360 range. The `luminance` and
|
|
4728
4895
|
* `saturation` values are in the 0 .. 1 range.
|
|
4896
|
+
* @since 1.16
|
|
4729
4897
|
*/
|
|
4730
4898
|
to_hsl(): [number, number, number];
|
|
4731
4899
|
|
|
@@ -4733,6 +4901,7 @@ export namespace Cogl {
|
|
|
4733
4901
|
* Converts a pre-multiplied color to a non-premultiplied color. For
|
|
4734
4902
|
* example, semi-transparent red is (0.5, 0, 0, 0.5) when premultiplied
|
|
4735
4903
|
* and (1.0, 0, 0, 0.5) when non-premultiplied.
|
|
4904
|
+
* @since 1.4
|
|
4736
4905
|
*/
|
|
4737
4906
|
unpremultiply(): void;
|
|
4738
4907
|
}
|
|
@@ -4802,6 +4971,8 @@ export namespace Cogl {
|
|
|
4802
4971
|
* The default is {@link Cogl.MaterialAlphaFunc.ALWAYS}
|
|
4803
4972
|
* @param alpha_func A `CoglMaterialAlphaFunc` constant
|
|
4804
4973
|
* @param alpha_reference A reference point that the chosen alpha function uses to compare incoming fragments to.
|
|
4974
|
+
* @since 1.0
|
|
4975
|
+
* @deprecated since 1.16: Use `cogl_pipeline_set_alpha_test_function()` instead
|
|
4805
4976
|
*/
|
|
4806
4977
|
set_alpha_test_function(alpha_func: MaterialAlphaFunc, alpha_reference: number): void;
|
|
4807
4978
|
|
|
@@ -4876,6 +5047,8 @@ export namespace Cogl {
|
|
|
4876
5047
|
* is in premultiplied form.
|
|
4877
5048
|
* @param blend_string A <link linkend="cogl-Blend-Strings">Cogl blend string</link> describing the desired blend function.
|
|
4878
5049
|
* @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).
|
|
5050
|
+
* @since 1.0
|
|
5051
|
+
* @deprecated since 1.16: Use `cogl_pipeline_set_blend()` instead
|
|
4879
5052
|
*/
|
|
4880
5053
|
set_blend(blend_string: string): boolean;
|
|
4881
5054
|
|
|
@@ -4883,6 +5056,8 @@ export namespace Cogl {
|
|
|
4883
5056
|
* When blending is setup to reference a CONSTANT blend factor then
|
|
4884
5057
|
* blending will depend on the constant set with this function.
|
|
4885
5058
|
* @param constant_color The constant color you want
|
|
5059
|
+
* @since 1.0
|
|
5060
|
+
* @deprecated since 1.16: Use `cogl_pipeline_set_blend_constant()` instead
|
|
4886
5061
|
*/
|
|
4887
5062
|
set_blend_constant(constant_color: Color): void;
|
|
4888
5063
|
|
|
@@ -4896,6 +5071,8 @@ export namespace Cogl {
|
|
|
4896
5071
|
*
|
|
4897
5072
|
* The default value is (1.0, 1.0, 1.0, 1.0)
|
|
4898
5073
|
* @param color The components of the color
|
|
5074
|
+
* @since 1.0
|
|
5075
|
+
* @deprecated since 1.16: Use `cogl_pipeline_set_color()` instead
|
|
4899
5076
|
*/
|
|
4900
5077
|
set_color(color: Color): void;
|
|
4901
5078
|
|
|
@@ -4907,6 +5084,8 @@ export namespace Cogl {
|
|
|
4907
5084
|
* @param green The green component
|
|
4908
5085
|
* @param blue The blue component
|
|
4909
5086
|
* @param alpha The alpha component
|
|
5087
|
+
* @since 1.0
|
|
5088
|
+
* @deprecated since 1.16: Use `cogl_pipeline_set_color4ub()` instead
|
|
4910
5089
|
*/
|
|
4911
5090
|
set_color4ub(red: number, green: number, blue: number, alpha: number): void;
|
|
4912
5091
|
|
|
@@ -4923,6 +5102,8 @@ export namespace Cogl {
|
|
|
4923
5102
|
* as purely GLSL based layers.</note>
|
|
4924
5103
|
* @param layer_index the index of the layer
|
|
4925
5104
|
* @param texture a {@link Cogl.Handle} for the layer object
|
|
5105
|
+
* @since 1.0
|
|
5106
|
+
* @deprecated since 1.16: Use `cogl_pipeline_set_layer()` instead
|
|
4926
5107
|
*/
|
|
4927
5108
|
set_layer(layer_index: number, texture: Handle): void;
|
|
4928
5109
|
|
|
@@ -5005,6 +5186,8 @@ export namespace Cogl {
|
|
|
5005
5186
|
* @param layer_index Specifies the layer you want define a combine function for
|
|
5006
5187
|
* @param blend_string A <link linkend="cogl-Blend-Strings">Cogl blend string</link> describing the desired texture combine function.
|
|
5007
5188
|
* @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
|
|
5189
|
+
* @since 1.0
|
|
5190
|
+
* @deprecated since 1.16: Use `cogl_pipeline_set_layer_combine()` instead
|
|
5008
5191
|
*/
|
|
5009
5192
|
set_layer_combine(layer_index: number, blend_string: string): boolean;
|
|
5010
5193
|
|
|
@@ -5013,6 +5196,8 @@ export namespace Cogl {
|
|
|
5013
5196
|
* description then you can use this function to define its value.
|
|
5014
5197
|
* @param layer_index Specifies the layer you want to specify a constant used for texture combining
|
|
5015
5198
|
* @param constant The constant color you want
|
|
5199
|
+
* @since 1.0
|
|
5200
|
+
* @deprecated since 1.16: Use `cogl_pipeline_set_layer_combine_constant()` instead
|
|
5016
5201
|
*/
|
|
5017
5202
|
set_layer_combine_constant(layer_index: number, constant: Color): void;
|
|
5018
5203
|
|
|
@@ -5022,6 +5207,7 @@ export namespace Cogl {
|
|
|
5022
5207
|
* @param layer_index the layer number to change.
|
|
5023
5208
|
* @param min_filter the filter used when scaling a texture down.
|
|
5024
5209
|
* @param mag_filter the filter used when magnifying a texture.
|
|
5210
|
+
* @deprecated since 1.16: Use `cogl_pipeline_set_layer_filters()` instead
|
|
5025
5211
|
*/
|
|
5026
5212
|
set_layer_filters(layer_index: number, min_filter: MaterialFilter, mag_filter: MaterialFilter): void;
|
|
5027
5213
|
|
|
@@ -5030,6 +5216,7 @@ export namespace Cogl {
|
|
|
5030
5216
|
* and rotate a single layer of a material used to fill your geometry.
|
|
5031
5217
|
* @param layer_index the index for the layer inside `material`
|
|
5032
5218
|
* @param matrix the transformation matrix for the layer
|
|
5219
|
+
* @deprecated since 1.16: Use `cogl_pipeline_set_layer_matrix()` instead
|
|
5033
5220
|
*/
|
|
5034
5221
|
set_layer_matrix(layer_index: number, matrix: Graphene.Matrix): void;
|
|
5035
5222
|
|
|
@@ -5043,6 +5230,8 @@ export namespace Cogl {
|
|
|
5043
5230
|
* @param layer_index the layer number to change.
|
|
5044
5231
|
* @param enable whether to enable point sprite coord generation.
|
|
5045
5232
|
* @returns `true` if the function succeeds, `false` otherwise.
|
|
5233
|
+
* @since 1.4
|
|
5234
|
+
* @deprecated since 1.16: Use `cogl_pipeline_set_layer_point_sprite_coords_enabled()` instead
|
|
5046
5235
|
*/
|
|
5047
5236
|
set_layer_point_sprite_coords_enabled(layer_index: number, enable: boolean): boolean;
|
|
5048
5237
|
|
|
@@ -5055,6 +5244,8 @@ export namespace Cogl {
|
|
|
5055
5244
|
* screen space so it will be the same regardless of any
|
|
5056
5245
|
* transformations. The default point size is 1.0.
|
|
5057
5246
|
* @param point_size the new point size.
|
|
5247
|
+
* @since 1.4
|
|
5248
|
+
* @deprecated since 1.16: Use `cogl_pipeline_set_point_size()` instead
|
|
5058
5249
|
*/
|
|
5059
5250
|
set_point_size(point_size: number): void;
|
|
5060
5251
|
|
|
@@ -5095,6 +5286,8 @@ export namespace Cogl {
|
|
|
5095
5286
|
* meantime we hope this will handle most practical GLSL and ARBfp
|
|
5096
5287
|
* requirements.
|
|
5097
5288
|
* @param program A {@link Cogl.Handle} to a linked CoglProgram
|
|
5289
|
+
* @since 1.4
|
|
5290
|
+
* @deprecated since 1.16: Use `CoglSnippet` api instead instead
|
|
5098
5291
|
*/
|
|
5099
5292
|
set_user_program(program: Handle): void;
|
|
5100
5293
|
}
|
|
@@ -5367,6 +5560,7 @@ export namespace Cogl {
|
|
|
5367
5560
|
* is {@link Cogl.TextureComponents.RGBA}. The other constructors which take
|
|
5368
5561
|
* a %CoglBitmap or a data pointer default to the same components as
|
|
5369
5562
|
* the pixel format of the data.
|
|
5563
|
+
* @since 1.18
|
|
5370
5564
|
*/
|
|
5371
5565
|
get_components(): TextureComponents;
|
|
5372
5566
|
|
|
@@ -5413,6 +5607,7 @@ export namespace Cogl {
|
|
|
5413
5607
|
*
|
|
5414
5608
|
* By default the pre-multipled state is `TRUE`.
|
|
5415
5609
|
* @returns `true` if red, green and blue components are internally stored pre-multiplied by the alpha value or `false` if not.
|
|
5610
|
+
* @since 1.18
|
|
5416
5611
|
*/
|
|
5417
5612
|
get_premultiplied(): boolean;
|
|
5418
5613
|
|
|
@@ -5445,6 +5640,8 @@ export namespace Cogl {
|
|
|
5445
5640
|
* @param sub_width Width in pixels of the subregion
|
|
5446
5641
|
* @param sub_height Height in pixels of the subregion
|
|
5447
5642
|
* @returns A newly created {@link Cogl.Texture} or `null` on failure
|
|
5643
|
+
* @since 1.2
|
|
5644
|
+
* @deprecated since 1.18: Use `cogl_sub_texture_new()`
|
|
5448
5645
|
*/
|
|
5449
5646
|
new_from_sub_texture(sub_x: number, sub_y: number, sub_width: number, sub_height: number): Texture;
|
|
5450
5647
|
|
|
@@ -5469,6 +5666,7 @@ export namespace Cogl {
|
|
|
5469
5666
|
* an image format as long as {@link Cogl.TextureComponents.RG} isn't used
|
|
5470
5667
|
* as the texture's components.
|
|
5471
5668
|
* @param components
|
|
5669
|
+
* @since 1.18
|
|
5472
5670
|
*/
|
|
5473
5671
|
set_components(components: TextureComponents): void;
|
|
5474
5672
|
|
|
@@ -5546,6 +5744,7 @@ export namespace Cogl {
|
|
|
5546
5744
|
*
|
|
5547
5745
|
* By default the `premultipled` state is `TRUE`.
|
|
5548
5746
|
* @param premultiplied Whether any internally stored red, green or blue components are pre-multiplied by an alpha component.
|
|
5747
|
+
* @since 1.18
|
|
5549
5748
|
*/
|
|
5550
5749
|
set_premultiplied(premultiplied: boolean): void;
|
|
5551
5750
|
|
|
@@ -5583,6 +5782,7 @@ export namespace Cogl {
|
|
|
5583
5782
|
* @param dst_height height of destination region to write. (Must be less than or equal to the bitmap height)
|
|
5584
5783
|
* @param bitmap The source bitmap to read from
|
|
5585
5784
|
* @returns `true` if the subregion upload was successful, and `false` otherwise
|
|
5785
|
+
* @since 1.8
|
|
5586
5786
|
*/
|
|
5587
5787
|
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;
|
|
5588
5788
|
}
|