Sprite:setBlendMode: Difference between revisions

From GiderosMobile
formatting
remove language stuff
Line 1: Line 1:
__NOTOC__
__NOTOC__
<languages />
'''Available since:''' Gideros 2011.6<br/>
'''<translate>Available since</translate>:''' Gideros 2011.6<br/>
'''Class:''' [[Sprite]]<br/>
'''<translate>Class</translate>:''' [[Special:MyLanguage/Sprite|Sprite]]<br/>


=== <translate>Description</translate> ===
=== Description ===
Sets the blend mode of the sprite.
Sets the blend mode of the sprite.
<source lang="lua">
Sprite:setBlendMode(blendMode or src,dst)
</source>


This method can be called with 1 or 2 parameters. If one parameter is passed it must be one of the following blending modes:
This method can be called with 1 or 2 parameters.
 
If one parameter is passed it must be one of the following blending modes:
*Sprite.ALPHA = "alpha"
*Sprite.ALPHA = "alpha"
*Sprite.NO_ALPHA = "noAlpha"
*Sprite.NO_ALPHA = "noAlpha"
Line 13: Line 17:
*Sprite.MULTIPLY = "multiply"
*Sprite.MULTIPLY = "multiply"
*Sprite.SCREEN = "screen"
*Sprite.SCREEN = "screen"
If a [[Special:MyLanguage/Sprite|Sprite]] object doesn't set any blending mode, it takes the blending mode from its parent sprite.
If a '''Sprite''' object doesn't set any blending mode, it takes the blending mode from its parent sprite.


'''Note''': the following two lines are completely the same:
'''Note''': the following two lines are completely the same:
Line 20: Line 24:
sprite:setBlendMode(Sprite.ADD)
sprite:setBlendMode(Sprite.ADD)
</source>
</source>
It's a matter of taste which one to choose.


It's a matter of taste which one to choose.


If two parameters are passed to this method, then a source and destination blend can be set (in that order) and each takes the values:
If two parameters are passed to this method, then a source and destination blend can be set (in that order) and each takes the values:
Line 36: Line 40:
*Sprite.SRC_ALPHA_SATURATE = "srcAlphaSaturate"
*Sprite.SRC_ALPHA_SATURATE = "srcAlphaSaturate"


<source lang="lua">
=== Parameters ===
Sprite:setBlendMode(blendMode or src,dst)
'''blendMode or src''': (String) if one parameter is used, this is the blend mode. If two parameters are used this is the source blend specification<br/>
</source>
'''dst''': (String) destination blend mode '''optional'''<br/>
 
=== <translate>Parameters</translate> ===
'''blendMode or src''': (String) <translate>if one parameter is used, this is the blend mode. If two parameters are used this is the source blend specification</translate> <br/>
'''dst''': (string) <translate>destination blend mode</translate> '''optional'''<br/>


{{Sprite}}
{{Sprite}}

Revision as of 02:53, 3 February 2021

Available since: Gideros 2011.6
Class: Sprite

Description

Sets the blend mode of the sprite.

Sprite:setBlendMode(blendMode or src,dst)

This method can be called with 1 or 2 parameters.

If one parameter is passed it must be one of the following blending modes:

  • Sprite.ALPHA = "alpha"
  • Sprite.NO_ALPHA = "noAlpha"
  • Sprite.ADD = "add"
  • Sprite.MULTIPLY = "multiply"
  • Sprite.SCREEN = "screen"

If a Sprite object doesn't set any blending mode, it takes the blending mode from its parent sprite.

Note: the following two lines are completely the same:

sprite:setBlendMode("add")
sprite:setBlendMode(Sprite.ADD)

It's a matter of taste which one to choose.


If two parameters are passed to this method, then a source and destination blend can be set (in that order) and each takes the values:

  • Sprite.ZERO = "zero"
  • Sprite.ONE = "one"
  • Sprite.SRC_COLOR = "srcColor"
  • Sprite.ONE_MINUS_SRC_COLOR = "oneMinusSrcColor"
  • Sprite.DST_COLOR = "dstColor"
  • Sprite.ONE_MINUS_DST_COLOR = "oneMinusDstColor"
  • Sprite.SRC_ALPHA = "srcAlpha"
  • Sprite.ONE_MINUS_SRC_ALPHA = "oneMinusSrcAlpha"
  • Sprite.DST_ALPHA = "dstAlpha"
  • Sprite.ONE_MINUS_DST_ALPHA = "oneMinusDstAlpha"
  • Sprite.SRC_ALPHA_SATURATE = "srcAlphaSaturate"

Parameters

blendMode or src: (String) if one parameter is used, this is the blend mode. If two parameters are used this is the source blend specification
dst: (String) destination blend mode optional