newRasterizer.lua 1.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243
  1. return {
  2. summary = 'Create a new Rasterizer.',
  3. description = 'Creates a new Rasterizer from a TTF file.',
  4. arguments = {
  5. filename = {
  6. type = 'string',
  7. description = 'The filename of the font file to load.'
  8. },
  9. blob = {
  10. type = 'Blob',
  11. description = 'The Blob containing font data.'
  12. },
  13. size = {
  14. type = 'number',
  15. default = '32',
  16. description = [[
  17. The resolution to render the fonts at, in pixels. Higher resolutions use more memory and
  18. processing power but may provide better quality results for some fonts/situations.
  19. ]]
  20. }
  21. },
  22. returns = {
  23. rasterizer = {
  24. type = 'Rasterizer',
  25. description = 'The new Rasterizer.'
  26. }
  27. },
  28. variants = {
  29. {
  30. description = 'Create a Rasterizer for the default font included with LÖVR (Varela Round).',
  31. arguments = { 'size' },
  32. returns = { 'rasterizer' }
  33. },
  34. {
  35. arguments = { 'filename', 'size' },
  36. returns = { 'rasterizer' }
  37. },
  38. {
  39. arguments = { 'blob', 'size' },
  40. returns = { 'rasterizer' }
  41. }
  42. }
  43. }