Difference between revisions of "Sprite:setEffectStack"
From GiderosMobile
(Created page with "__NOTOC__ <languages /> '''<translate>Available since</translate>:''' Gideros 2021.1<br/> '''<translate>Class</translate>:''' Sprite<br/> === <tr...") |
(remove language stuff) |
||
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
− | + | '''Available since:''' Gideros 2021.1<br/> | |
− | ''' | + | '''Class:''' [[Sprite]]<br/> |
− | ''' | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
+ | === Description === | ||
+ | Sets or removes post processing effects for this sprite. | ||
<source lang="lua"> | <source lang="lua"> | ||
− | + | Sprite:setEffectStack(effectStack,mode) | |
</source> | </source> | ||
− | === | + | |
− | '''effectStack''': (table) | + | |
− | '''mode''': (number) | + | The effect stack is an array of tables, each one describing a post processing stage. Each table can have the following fields: |
+ | * '''buffer''': a [[RenderTarget]] that will hold the input of this post processing stage | ||
+ | * '''shader''': a [[Shader]] that will be used to draw the buffer above onto the next stage, or on screen '''optional''' | ||
+ | * '''transform''': a [[Matrix]] to transform the input buffer before processing '''optional''' | ||
+ | * '''postTransform''': a [[Matrix]] to transform the final stage output before displaying '''optional''' | ||
+ | * '''textures''': an array of [[TextureBase]] to be used by the shader. By default the buffer is used. '''optional''' | ||
+ | |||
+ | === Parameters === | ||
+ | '''effectStack''': (table) a table describing the post processing phases to be applied<br/> | ||
+ | '''mode''': (number) one of the Sprite.EFFECT_MODE_* constants '''optional'''<br/> | ||
{{Sprite}} | {{Sprite}} |
Revision as of 23:19, 2 February 2021
Available since: Gideros 2021.1
Class: Sprite
Description
Sets or removes post processing effects for this sprite.
Sprite:setEffectStack(effectStack,mode)
The effect stack is an array of tables, each one describing a post processing stage. Each table can have the following fields:
- buffer: a RenderTarget that will hold the input of this post processing stage
- shader: a Shader that will be used to draw the buffer above onto the next stage, or on screen optional
- transform: a Matrix to transform the input buffer before processing optional
- postTransform: a Matrix to transform the final stage output before displaying optional
- textures: an array of TextureBase to be used by the shader. By default the buffer is used. optional
Parameters
effectStack: (table) a table describing the post processing phases to be applied
mode: (number) one of the Sprite.EFFECT_MODE_* constants optional
- Sprite:addChild
- Sprite:addChildAt
- Sprite:clearBlendMode
- Sprite:clone
- Sprite:contains
- Sprite:get
- Sprite:getAlpha
- Sprite:getAnchorPoint
- Sprite:getAnchorPosition
- Sprite:getBounds
- Sprite:getChildAt
- Sprite:getChildIndex
- Sprite:getChildrenAtPoint
- Sprite:getClip
- Sprite:getColorTransform
- Sprite:getDrawCount
- Sprite:getHeight
- Sprite:getLayoutConstraints
- Sprite:getLayoutInfo
- Sprite:getLayoutParameters
- Sprite:getMatrix
- Sprite:getNumChildren
- Sprite:getParent
- Sprite:getPosition
- Sprite:getRotation
- Sprite:getRotationX
- Sprite:getRotationY
- Sprite:getScale
- Sprite:getScaleX
- Sprite:getScaleY
- Sprite:getScaleZ
- Sprite:getSize
- Sprite:getSkew
- Sprite:getSkewX
- Sprite:getSkewY
- Sprite:getWidth
- Sprite:getX
- Sprite:getY
- Sprite:getZ
- Sprite:globalToLocal
- Sprite:hitTestPoint
- Sprite:isVisible
- Sprite:localToGlobal
- Sprite:redrawEffects
- Sprite:removeChild
- Sprite:removeChildAt
- Sprite:removeFromParent
- Sprite:set
- Sprite:setAlpha
- Sprite:setAnchorPoint
- Sprite:setAnchorPosition
- Sprite:setBlendMode
- Sprite:setClip
- Sprite:setColorTransform
- Sprite:setEffectConstant
- Sprite:setEffectStack
- Sprite:setGhosts
- Sprite:setLayoutConstraints
- Sprite:setLayoutParameters
- Sprite:setMatrix
- Sprite:setPosition
- Sprite:setRotation
- Sprite:setRotationX
- Sprite:setRotationY
- Sprite:setScale
- Sprite:setScaleX
- Sprite:setScaleY
- Sprite:setScaleZ
- Sprite:setShader
- Sprite:setShaderConstant
- Sprite:setSkew
- Sprite:setSkewX
- Sprite:setSkewY
- Sprite:setStencilOperation
- Sprite:setStopEventPropagation
- Sprite:setVisible
- Sprite:setX
- Sprite:setY
- Sprite:setZ
- Sprite:spriteToLocal
- Sprite:swapChildren
- Sprite:swapChildrenAt
- Sprite.ADD
- Sprite.ALPHA
- Sprite.EFFECT MODE AUTOMATIC
- Sprite.EFFECT MODE CONTINUOUS
- Sprite.EFFECT MODE TRIGGERED
- Sprite.LAYOUT ANCHOR CENTER
- Sprite.LAYOUT ANCHOR EAST
- Sprite.LAYOUT ANCHOR NORTH
- Sprite.LAYOUT ANCHOR NORTHEAST
- Sprite.LAYOUT ANCHOR NORTHWEST
- Sprite.LAYOUT ANCHOR SOUTH
- Sprite.LAYOUT ANCHOR SOUTHEAST
- Sprite.LAYOUT ANCHOR SOUTHWEST
- Sprite.LAYOUT ANCHOR WEST
- Sprite.LAYOUT FILL BOTH
- Sprite.LAYOUT FILL HORIZONTAL
- Sprite.LAYOUT FILL NONE
- Sprite.LAYOUT FILL VERTICAL
- Sprite.MULTIPLY
- Sprite.NO ALPHA
- Sprite.SCREEN
- Sprite.new
- Event.ADDED_TO_STAGE
- Event.ENTER_FRAME
- Event.KEY_CHAR
- Event.KEY_DOWN
- Event.KEY_UP
- Event.LAYOUT_RESIZED
- Event.MOUSE_DOWN
- Event.MOUSE_ENTER
- Event.MOUSE_HOVER
- Event.MOUSE_LEAVE
- Event.MOUSE_MOVE
- Event.MOUSE_UP
- Event.MOUSE_WHEEL
- Event.REMOVED_FROM_STAGE
- Event.TOUCHES_BEGIN
- Event.TOUCHES_CANCEL
- Event.TOUCHES_END
- Event.TOUCHES_MOVE