<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
  <channel>
    <title>dtutils on darktable lua documentation</title>
    <link>https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils/</link>
    <description>Recent content in dtutils on darktable lua documentation</description>
    <generator>Hugo -- gohugo.io</generator>
    <language>en-us</language><atom:link href="https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils/index.xml" rel="self" type="application/rss+xml" />
    <item>
      <title>details</title>
      <link>https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils/details/</link>
      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
      
      <guid>https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils/details/</guid>
      <description>🔗NAME dtutils
🔗SYNOPSIS A Darktable lua utilities library
🔗USAGE local du = require &amp;quot;lib/dtutils&amp;quot; 🔗DESCRIPTION dtutils provides a common library of functions used to build lua scripts.
🔗RETURN VALUE du- library - the library of functions
🔗FUNCTIONS 🔗check_min_api_version check the minimum required api version against the current api version
🔗check_os check that the operating system is supported
🔗join join a table of strings with a specified separator
🔗prequire a protected lua require</description>
    </item>
    
    <item>
      <title>check_min_api_version</title>
      <link>https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils/check_min_api_version/</link>
      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
      
      <guid>https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils/check_min_api_version/</guid>
      <description>🔗NAME check_min_api_version
🔗SYNOPSIS check the minimum required application programming interface (API) version against the current API version
🔗USAGE local du = require &amp;quot;lib/dtutils&amp;quot; local result = du.check_min_api_version(min_api, script_name) min_api - string - the API version that the application was written for (example: &amp;ldquo;5.0.0&amp;rdquo;)
script_name - string - the name of the script
🔗DESCRIPTION check_min_api_version compares the minimum API required for the application to run against the current API version. The minimum API version is typically the API version that was current when the application was created.</description>
    </item>
    
    <item>
      <title>check_os</title>
      <link>https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils/check_os/</link>
      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
      
      <guid>https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils/check_os/</guid>
      <description>🔗NAME check_os
🔗SYNOPSIS check that the operating system is supported
🔗USAGE local du = require &amp;quot;lib/dtutils&amp;quot; local result = du.check_os(operating_systems) operating_systems - table - a table of operating system names such as {&amp;ldquo;windows&amp;rdquo;,&amp;ldquo;linux&amp;rdquo;,&amp;ldquo;macos&amp;rdquo;,&amp;ldquo;unix&amp;rdquo;}
🔗DESCRIPTION check_os checks a supplied table of operating systems against the operating system the script is running on and returns true if the OS is in the list, otherwise false
🔗RETURN VALUE result - boolean - true if the operating system is supported, false if not.</description>
    </item>
    
    <item>
      <title>find_image_by_id</title>
      <link>https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils/find_image_by_id/</link>
      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
      
      <guid>https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils/find_image_by_id/</guid>
      <description>🔗NAME find_image_by_id
🔗SYNOPSIS look up an image by ID in the database
🔗USAGE local du = require &amp;quot;lib/dtutils&amp;quot; local img = du.find_image_by_id(imgid) imgid - int - the image ID to retrieve
🔗DESCRIPTION find_image_by_id looks up an image by ID in the database.
🔗RETURN VALUE img - dt_lua_image_t - image with the given ID if found, nil if not</description>
    </item>
    
    <item>
      <title>join</title>
      <link>https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils/join/</link>
      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
      
      <guid>https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils/join/</guid>
      <description>🔗NAME join
🔗SYNOPSIS join a table of strings with a specified separator
🔗USAGE local du = require &amp;quot;lib/dtutils&amp;quot; local result = du.join(tabl, pat) tabl - table - a table of strings
pat - string - a separator
🔗DESCRIPTION join assembles a table of strings into a string with the specified pattern in between each string
🔗RETURN VALUE result - string - the joined string on success, or an empty string on failure</description>
    </item>
    
    <item>
      <title>prequire</title>
      <link>https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils/prequire/</link>
      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
      
      <guid>https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils/prequire/</guid>
      <description>🔗NAME prequire
🔗SYNOPSIS a protected lua require
🔗USAGE local du = require &amp;quot;lib/dtutils&amp;quot; local status, lib = du.prequire(req_name) req_name - string - the filename of the lua code to load without the &amp;ldquo;.lua&amp;rdquo; filetype
🔗DESCRIPTION prequire is a protected require that can survive an error in the code being loaded without bringing down the calling routine.
🔗RETURN VALUE status - boolean - true on success lib - if status is true, then the code, otherwise an error message</description>
    </item>
    
    <item>
      <title>spairs</title>
      <link>https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils/spairs/</link>
      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
      
      <guid>https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils/spairs/</guid>
      <description>🔗NAME spairs
🔗SYNOPSIS an iterator that provides sorted pairs from a table
🔗USAGE local du = require &amp;quot;lib/dtutils&amp;quot; for key, value in du.spairs(t, order) do -- do something end t - table - table of key, value pairs order - function - an optional function to sort the pairs, if none is supplied, table.sort() is used
🔗DESCRIPTION spairs is an iterator that returns key, value pairs from a table in sorted order.</description>
    </item>
    
    <item>
      <title>split</title>
      <link>https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils/split/</link>
      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
      
      <guid>https://darktable-org.github.io/luadocs/lua.scripts.api.manual/dtutils/split/</guid>
      <description>🔗NAME split
🔗SYNOPSIS split a string on a specified separator
🔗USAGE local du = require &amp;quot;lib/dtutils&amp;quot; local result = du.split(str, pat) str - string - the string to split
pat - string - the pattern to split on
🔗DESCRIPTION split separates a string into a table of strings. The strings are separated at each occurrence of the supplied pattern. The pattern may be any pattern as described in the lua docs.</description>
    </item>
    
  </channel>
</rss>
