djkato/luadocs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Updated dt_lua_image_t.generate_cache to match the way the code works.

Browse source
This commit is contained in:
Bill Ferguson 2022-02-17 17:08:01 -05:00
parent fee1e00da6
commit 7782b810cc
1 changed files with 5 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
content/lua.api.manual/types/dt_lua_image_t.md
View file

@ -442,14 +442,14 @@ darktable will regenerate the thumbnail by itself when it is needed.
``` ```
self.function( self.function(
check_dirs : boolean check_dirs : boolean
start_size : integer min_size : integer
end_size : integer max_size : integer
) )
``` ```
* **self** - _[types.dt_lua_image_t](../types/dt_lua_image_t)_ - The image whose cache is to be generated. * **self** - _[types.dt_lua_image_t](../types/dt_lua_image_t)_ - The image whose cache is to be generated.
* **check_dirs** - _boolean_ - check if the mipmap cache directories exist. Create them if necessary. * **check_dirs** - _boolean_ - check if the mipmap cache directories exist. Create them if necessary.
* **start_size** - _integer_ - mipmap size to generate first * **min_size** - _integer_ - minimum mipmap size to generate
* **end_size** - _integer_ - mipmap size to generate last * **max_size** - _integer_ - maximum mipmap size to generate
**NOTES:** **NOTES:**
* mipmap cache image sizes * mipmap cache image sizes
@ -464,6 +464,5 @@ self.function(
- 8 - full resolution - 8 - full resolution
* To generate a single size mipmap image set start_size and end_size to the same value * To generate a single size mipmap image set start_size and end_size to the same value
* When generating multiple sizes put the largest size as the start size and the smallest as the end. * When different min_size and max_size sizes are specified, every size mipmap from min_size to max_size is generated.
* When different start and end sizes are specified, every size mipmap from start to end is generated.
* When looping over a set of images and generating just one size, check for directories on the first image only. * When looping over a set of images and generating just one size, check for directories on the first image only.