lovr-indeck/lovr-api/graphics/newFont.lua

return {
  tag = 'graphicsObjects',
  summary = 'Create a new Font.',
  description = [[
    Creates a new Font.  It can be used to render text with `lovr.graphics.print`.

    Currently, the only supported font format is TTF.
  ]],
  arguments = {
    filename = {
      type = 'string',
      description = 'The filename of the font file.'
    },
    size = {
      type = 'number',
      default = '32',
      description = 'The size of the font, in pixels.'
    },
    padding = {
      type = 'number',
      default = '2',
      description = 'The number of pixels of padding around each glyph.'
    },
    spread = {
      type = 'number',
      default = '4.0',
      description = 'The range of the distance field, in pixels.'
    },
    rasterizer = {
      type = 'Rasterizer',
      description = 'The existing Rasterizer object used to render the glyphs.'
    }
  },
  returns = {
    font = {
      type = 'Font',
      description = 'The new Font.'
    }
  },
  variants = {
    {
      arguments = { 'filename', 'size', 'padding', 'spread' },
      returns = { 'font' }
    },
    {
      description = 'Creates a new Font from the default font included with LÖVR (Varela Round).',
      arguments = { 'size', 'padding', 'spread' },
      returns = { 'font' }
    },
    {
      arguments = { 'rasterizer', 'padding', 'spread' },
      returns = { 'font' }
    }
  },
  notes = 'Larger font sizes will lead to more detailed curves at the cost of performance.'
}