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

return {
  tag = 'graphics-objects',
  summary = 'Create a new Font.',
  description = 'Creates a new Font.',
  arguments = {
    filename = {
      type = 'string',
      description = 'A path to a TTF file.'
    },
    blob = {
      type = 'Blob',
      description = 'A Blob containing TTF file data.'
    },
    rasterizer = {
      type = 'Rasterizer',
      description = 'An existing Rasterizer to use to load glyph images.'
    },
    size = {
      type = 'number',
      default = '32',
      description = [[
        The size of the Font in pixels.  Larger sizes are slower to initialize and use more memory,
        but have better quality.
      ]]
    },
    spread = {
      type = 'number',
      default = '4',
      description = [[
        For signed distance field fonts (currently all fonts), the width of the SDF, in pixels.  The
        greater the distance the font is viewed from, the larger this value needs to be for the font
        to remain properly antialiased.  Increasing this will have a performance penalty similar to
        increasing the size of the font.
      ]]
    }
  },
  returns = {
    font = {
      type = 'Font',
      description = 'The new Font.'
    }
  },
  variants = {
    {
      description = 'Creates a new Font from a TTF file.',
      arguments = { 'filename', 'size', 'spread' },
      returns = { 'font' }
    },
    {
      description = 'Creates a new Font from TTF data.',
      arguments = { 'blob', 'size', 'spread' },
      returns = { 'font' }
    },
    {
      description = 'Creates a new Font using the default typeface (Varela Round).',
      arguments = { 'size', 'spread' },
      returns = { 'font' }
    },
    {
      description = 'Creates a new Font from an existing Rasterizer.',
      arguments = { 'rasterizer', 'spread' },
      returns = { 'font' }
    }
  },
  related = {
    'lovr.graphics.getDefaultFont',
    'lovr.data.newRasterizer',
    'Pass:text'
  }
}