Sprite:setStencilOperation

From GiderosMobile
Revision as of 11:03, 23 August 2018 by Hgy29 (talk | contribs) (Created page with "__NOTOC__ '''Available since:''' Gideros 2017.6<br/> === Description === Allows to set a stencil operation to be used when drawing this sprite.<br /> The table can contain...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Available since: Gideros 2017.6

Description

Allows to set a stencil operation to be used when drawing this sprite.

   The table can contain the following fields:
  • stencilClear: (boolean) whether the stencil should be cleared beforehand.
  • stencilMask: (integer) the mask value used in stencil operations.
  • stencilWriteMask: (integer) the mask value used when writing to stencil.
  • stencilRef: (integer) the reference value used in stencil operations.
  • stencilFunc: (integer) the stencil function to use.
  • stencilFail: (integer) the stencil operation when stencil test failed.
  • depthFail: (integer) the stencil operation when depth test failed.
  • depthPass: (integer) the stencil operation when depth test has passed.


   Stencil function and operations code are defined in Sprite.STENCIL_xxx fields and correspond to the GL_xxx relevant values in OpenGL stencil documentation.
= Sprite:setStencilOperation(op,)

'op: (table) A table containing the stencil operation settings, or nil to disable stencil '