getAlphaSampling.lua 872 B

1234567891011121314151617181920212223
  1. return {
  2. tag = 'graphicsState',
  3. summary = 'Get whether alpha sampling is enabled.',
  4. description = [[
  5. Returns whether or not alpha sampling is enabled. Alpha sampling is also known as
  6. alpha-to-coverage. When it is enabled, the alpha channel of a pixel is factored into how
  7. antialiasing is computed, so the edges of a transparent texture will be correctly antialiased.
  8. ]],
  9. arguments = {},
  10. returns = {
  11. {
  12. name = 'enabled',
  13. type = 'boolean',
  14. description = 'Whether or not alpha sampling is enabled.'
  15. }
  16. },
  17. notes = [[
  18. - Alpha sampling is disabled by default.
  19. - This feature can be used for a simple transparency effect, pixels with an alpha of zero will
  20. have their depth value discarded, allowing things behind them to show through (normally you
  21. have to sort objects or write a shader for this).
  22. ]]
  23. }