setDepthWrite.lua 709 B

12345678910111213141516171819202122232425262728
  1. return {
  2. tag = 'pipeline',
  3. summary = 'Set whether draws write to the depth buffer.',
  4. description = [[
  5. Sets whether draws write to the depth buffer. When a pixel is drawn, if depth writes are
  6. enabled and the pixel passes the depth test, the depth buffer will be updated with the pixel's
  7. depth value.
  8. ]],
  9. arguments = {
  10. write = {
  11. type = 'boolean',
  12. description = 'Whether the depth buffer should be affected by draws.'
  13. }
  14. },
  15. returns = {},
  16. variants = {
  17. {
  18. arguments = { 'write' },
  19. returns = {}
  20. }
  21. },
  22. notes = 'The default depth write is `true`.',
  23. related = {
  24. 'Pass:setStencilWrite',
  25. 'Pass:setColorWrite',
  26. 'Pass:setDepthTest'
  27. }
  28. }