lovr-indeck/lovr-api/graphics/Font/getWidth.lua

return {
  summary = 'Get the width of rendered text.',
  description = [[
    Returns the maximum width of a piece of text.  This function does not perform wrapping but does
    respect newlines in the text.
  ]],
  arguments = {
    string = {
      type = 'string',
      description = 'The text to measure.'
    },
    strings = {
      type = 'table',
      description = [[
        A table of colored strings, each given as a `{ color, string }` pair.  The color can be a
        `Vec3`, `Vec4`, table, or hexcode.
      ]]
    },
  },
  returns = {
    width = {
      type = 'number',
      description = 'The maximum width of the text.'
    }
  },
  variants = {
    {
      arguments = { 'string' },
      returns = { 'width' }
    },
    {
      arguments = { 'strings' },
      returns = { 'width' }
    }
  },
  related = {
    'Font:getAscent',
    'Font:getDescent',
    'Font:getHeight',
    'Font:getKerning',
    'Font:getLines'
  }
}