lovr-indeck/lovr-api/graphics/Pass/setStencilWrite.lua

return {
  tag = 'pipeline',
  summary = 'Set whether draws write to the stencil buffer.',
  description = [[
    Sets or disables stencil writes.  When stencil writes are enabled, any pixels drawn will update
    the values in the stencil buffer using the `StencilAction` set.
  ]],
  arguments = {
    action = {
      type = 'StencilAction',
      description = 'How pixels drawn will update the stencil buffer.'
    },
    actions = {
      type = 'table',
      description = [[
        A list of 3 stencil actions, used when a pixel fails the stencil test, fails
        the depth test, or passes the stencil test, respectively.
      ]]
    },
    value = {
      type = 'number',
      default = '1',
      description = 'When using the \'replace\' action, this is the value to replace with.'
    },
    mask = {
      type = 'number',
      default = '0xff',
      description = 'An optional mask to apply to stencil values before writing.'
    }
  },
  returns = {},
  variants = {
    {
      arguments = { 'action', 'value', 'mask' },
      returns = {}
    },
    {
      arguments = { 'actions', 'value', 'mask' },
      returns = {}
    },
    {
      description = 'Disables stencil writing.',
      arguments = {},
      returns = {}
    }
  },
  notes = [[
    By default, stencil writes are disabled.

    Setting the stencil test requires the `Pass` to have a depth texture with the `d24s8` or
    `d32fs8` format (the `s` means "stencil").  The `t.graphics.stencil` and `t.headset.stencil`
    flags in `lovr.conf` can be used to request a stencil format for the default window and headset
    passes, respectively.
  ]],
  related = {
    'Pass:setStencilTest',
    'Pass:setDepthTest'
  }
}