Skip to content

Commit ce8c9fc

Browse files
authored
Merge pull request #14 from darktable-org/development
Update to API 9.4.0 for dartkable 5.0
2 parents d23426c + 5aa134a commit ce8c9fc

23 files changed

+464
-34
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
resources/*
22
public/*
3+
.hugo_build.lock

content/lua.api.manual/darktable/darktable.database.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Creates a duplicate of an image and returns it.
3030
* **image** - _[types.dt_lua_image_t](../../types/dt_lua_image_t)_ - the image to duplicate
3131
* **return** - _[types.dt_lua_image_t](../../types/dt_lua_image_t)_ - The new image object.
3232

33-
# darktable.database.duplicate_image_with_history
33+
# darktable.database.duplicate_with_history
3434

3535
```
3636
function(

content/lua.api.manual/darktable/darktable.new_format.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,18 @@ type : string
1515
Creates a new format object to export images
1616

1717
* **type** - _string_ - The type of format object to create, one of :
18+
* avif
1819
* copy
1920
* exr
2021
* j2k
2122
* jpeg
23+
* jpegxl
2224
* pdf
2325
* pfm
2426
* png
2527
* ppm
2628
* tiff
2729
* webp
30+
* xcf
2831

2932
* **return** - _[types.dt_imageio_module_format_t](types.dt_imageio_module_format_t)_ - The newly created object. Exact type depends on the type passed
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
title: darktable.util
3+
id: darktable.util
4+
weight: 240
5+
draft: false
6+
author: "people"
7+
---
8+
9+
darktable utility functions
10+
11+
# darktable.util.message
12+
13+
```
14+
function(
15+
sender : string,
16+
receiver : string,
17+
message : string
18+
)
19+
```
20+
21+
Sends a message from sender to receiver using the [inter-script-communication](../events/inter-script-communication) event.
22+
23+
* **sender** - _string_ - The module that is sending the message.
24+
* **receiver** - _string_ - The module that the message is intended for or _**broadcast**_ to send to all modules.
25+
* **message** - _string_ - The message for the receiver.
26+
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
title: inter-script-communication
3+
id: inter-script-communication
4+
weight: 45
5+
draft: false
6+
author: "people"
7+
---
8+
9+
`event`
10+
11+
This event is called to send messages back and forth between scripts.
12+
13+
# inter-script-communication.callback
14+
15+
```
16+
function(
17+
event : string,
18+
sender : string,
19+
receiver : string,
20+
message : string
21+
)
22+
```
23+
24+
* **event** - _string_ - The name of the event that triggered the callback.
25+
* **sender** - _string_ - The name of the module sending the event.
26+
* **receiver** - _string_ - The name of the module that the event is being sent to or _**broadcast**_ for all modules.
27+
* **message** - _string_ - The message intended for the receiving module
28+
29+
# inter-script-communication.extra registration parameters
30+
31+
This event has no extra registration parameters.
32+
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: avif_color_mode_e
3+
id: avif_color_mode_e
4+
weight: 22
5+
draft: false
6+
author: "people"
7+
---
8+
9+
`enum`
10+
11+
Color mode for AVIF
12+
13+
Values:
14+
* AVIF_COLOR_MODE_RGB
15+
* AVIF_COLOR_MODE_GRAYSCALE
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: avif_compression_type_e
3+
id: avif_compression_type_e
4+
weight: 23
5+
draft: false
6+
author: "people"
7+
---
8+
9+
`enum`
10+
11+
AVIF compression mode
12+
13+
Values:
14+
* AVIF_COMP_LOSSLESS
15+
* AVIF_COMP_LOSSY
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: avif_tiling_e
3+
id: avif_tiling_e
4+
weight: 24
5+
draft: false
6+
author: "people"
7+
---
8+
9+
`enum`
10+
11+
AVIF tiling
12+
13+
Values:
14+
* AVIF_TILING_ON
15+
* AVIF_TILING_OFF
Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
---
2+
title: dt_imageio_module_format_data_avif
3+
id: dt_imageio_module_format_data_avif
4+
weight: 115
5+
draft: false
6+
author: "people"
7+
---
8+
9+
`dt_type`
10+
11+
Type object describing parameters to export to avif.
12+
13+
Attributes:
14+
15+
* [parent](../attributes#parent) : [types.dt_imageio_module_format_t](../types/dt_imageio_module_format_t)
16+
17+
# dt_imageio_module_format_data_avif.bit_depth
18+
19+
`number`
20+
21+
The number of bits per sample to use at export time (8, 10, or 12).
22+
23+
Attributes:
24+
25+
* [write](../attributes#write)
26+
27+
# dt_imageio_module_format_data_avif.quality
28+
29+
`number`
30+
31+
The quality to use at export time.
32+
33+
Attributes:
34+
35+
* [write](../attributes#write)
36+
37+
# dt_imageio_module_format_data_avif.compression_type
38+
39+
[types.avif_compression_type_e](../types/avif_compression_type_e)
40+
41+
The image compression type.
42+
43+
Attributes:
44+
45+
* [write](../attributes#write)
46+
47+
# dt_imageio_module_format_data_avif.color_mode
48+
49+
[types.avif_color_mode_e](../types/avif_color_mode_e)
50+
51+
The color mode to use for the image.
52+
53+
Attributes:
54+
55+
* [write](../attributes#write)
56+
57+
# dt_imageio_module_format_data_avif.tiling
58+
59+
[types.avif_tiling_e](../types/avif_tiling_e)
60+
61+
The tiling mode to use for the image.
62+
63+
Attributes:
64+
65+
* [write](../attributes#write)
Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
---
2+
title: dt_imageio_module_format_data_jpegxl
3+
id: dt_imageio_module_format_data_jpegxl
4+
weight: 155
5+
draft: false
6+
author: "people"
7+
---
8+
9+
`dt_type`
10+
11+
Type object describing parameters to export to jpegxl.
12+
13+
Attributes:
14+
15+
* [parent](../attributes#parent) : [types.dt_imageio_module_format_t](../types/dt_imageio_module_format_t)
16+
17+
# dt_imageio_module_format_data_jpegxl.bpp
18+
19+
`number`
20+
21+
The bits per pixel to use at export time (10, 12, 16, 32).
22+
23+
Attributes:
24+
25+
* [write](../attributes#write)
26+
27+
# dt_imageio_module_format_data_jpegxl.pixel_type
28+
29+
`number`
30+
31+
Type of format for pixels, 0 for integer or 1 for floating point.
32+
33+
Attributes:
34+
35+
* [write](../attributes#write)
36+
37+
# dt_imageio_module_format_data_jpegxl.quality
38+
39+
`number`
40+
41+
The quality to use at export time.
42+
43+
Attributes:
44+
45+
* [write](../attributes#write)
46+
47+
# dt_imageio_module_format_data_jpegxl.original
48+
49+
`number`
50+
51+
The color profile used by the encoder.
52+
53+
* 0 - permit internal XYB color space conversion for more efficient lossy compression
54+
* 1 - ensure no conversion to keep original image color space (implied for lossless)
55+
56+
Attributes:
57+
58+
* [write](../attributes#write)
59+
60+
# dt_imageio_module_format_data_jpegxl.effort
61+
62+
`number`
63+
64+
Encoding effort. The effort used to encode the image, higher efforts will have better results at the expense of longer encoding times.
65+
66+
Attributes:
67+
68+
* [write](../attributes#write)
69+
70+
# dt_imageio_module_format_data_jpegxl.tier
71+
72+
`number`
73+
74+
Decoding speed. The preferred decoding speed with some sacrifice of quality.
75+
76+
Attributes:
77+
78+
* [write](../attributes#write)
79+

0 commit comments

Comments
 (0)