lovr-indeck/lovr-api/data/TextureData/getPixel.lua

return {
  summary = 'Get the value of a pixel of the TextureData.',
  description = 'Returns the value of a pixel of the TextureData.',
  arguments = {
    {
      name = 'x',
      type = 'number',
      description = 'The x coordinate of the pixel to get (0-indexed).'
    },
    {
      name = 'y',
      type = 'number',
      description = 'The y coordinate of the pixel to get (0-indexed).'
    }
  },
  returns = {
    {
      name = 'r',
      type = 'number',
      description = 'The red component of the pixel, from 0.0 to 1.0.'
    },
    {
      name = 'g',
      type = 'number',
      description = 'The green component of the pixel, from 0.0 to 1.0.'
    },
    {
      name = 'b',
      type = 'number',
      description = 'The blue component of the pixel, from 0.0 to 1.0.'
    },
    {
      name = 'a',
      type = 'number',
      description = 'The alpha component of the pixel, from 0.0 to 1.0.'
    }
  },
  notes = [[
    The following texture formats are supported: `rgba`, `rgb`, `r32f`, `rg32f`, and `rgba32f`.
  ]],
  related = {
    'TextureData:setPixel',
    'Texture:replacePixels',
    'TextureFormat'
  }
}