Difference between revisions of "Shape:setFillStyle"

From GiderosMobile
m (Text replacement - "</source>" to "</syntaxhighlight>")
 
(16 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 
'''Available since:''' Gideros 2011.6<br/>
 
'''Available since:''' Gideros 2011.6<br/>
 +
'''Class:''' [[Shape]]<br/>
 +
 
=== Description ===
 
=== Description ===
<br />
+
Sets the fill style that '''Shape''' object uses for subsequent drawings. The fill style remains in effect until you call ''setFillStyle()'' function with different parameters.
Sets the fill style that `Shape` object uses for subsequent drawings. The fill style remains in effect until you call `setFillStyle()` function with different<br />
+
<syntaxhighlight lang="lua">
parameters.<br />
+
Shape:setFillStyle(fillstyle,...)
<br />
+
</syntaxhighlight>
`type` parameter can be one of the following values:<br />
+
 
<br />
+
''fillstyle'' parameter can be one of the following values:
&lt;ul&gt;<br />
+
* '''Shape.NONE''': clears the fill style
&lt;li&gt;**Shape.NONE:** Clears the fill style.&lt;/li&gt;<br />
+
* '''Shape.SOLID''': sets the fill style as a solid color. In this mode, the parameters are color (in hexadecimal value) and an optional alpha value
&lt;li&gt;**Shape.SOLID:** Sets the fill style as a solid color. In this mode, the parameters are color (in hexedecial value) and an optional alpha value.&lt;/li&gt;<br />
+
* '''Shape.TEXTURE''': sets the fill style as textured. In this mode, the parameters are texture and an optional transformation matrix
&lt;li&gt;**Shape.TEXTURE:** Sets the fill style as a textured. In this mode, the parameters are texture and an optional transformation matrix.&lt;/li&gt;<br />
+
 
&lt;/ul&gt;<br />
+
=== Parameters ===
<br />
+
'''fillstyle''': (string) the fill style type<br/>
See the following example for more detailed usage of this function.<br />
+
'''...''': (any) parameters of the fill style<br/>
<br />
+
 
<source lang="lua">
+
=== Examples ===
Shape:setFillStyle(type,...)
+
<syntaxhighlight lang="lua">
</source>
+
setFillStyle(Shape.NONE) -- clears the fill style
'''type:''' (string) The type of the fill. Can be one of the Shape.NONE, Shape.SOLID or Shape.TEXTURE. ''''''<br/>
+
setFillStyle(Shape.SOLID, 0xff0000) -- sets the fill style as solid red color
'''...:''' (any) Parameters of the fill style. ''''''<br/>
+
setFillStyle(Shape.SOLID, 0xff0000, 0.5) -- sets the fill style as solid red color with 0.5 transparency
 +
 
 +
local texture = Texture.new("image.png")
 +
setFillStyle(Shape.TEXTURE, texture) -- sets the fill style as texture with "image.png"
 +
 
 +
local matrix = Matrix.new(0.5, 0, 0, 0.5, 0, 0)
 +
setFillStyle(Shape.TEXTURE, texture, matrix) -- sets the fill style as texture with "image.png" with a transformation matrix
 +
 
 +
--[[
 +
setFillStyle(Shape.LINEAR_GRADIENT, {}, {}, {}, (optional) matrix) -- not supported yet
 +
setFillStyle(Shape.RADIAL_GRADIENT, {}, {}, {}, (optional) matrix) -- not supported yet
 +
]]
 +
</syntaxhighlight>
 +
 
 +
{{Shape}}

Latest revision as of 14:31, 13 July 2023

Available since: Gideros 2011.6
Class: Shape

Description

Sets the fill style that Shape object uses for subsequent drawings. The fill style remains in effect until you call setFillStyle() function with different parameters.

Shape:setFillStyle(fillstyle,...)

fillstyle parameter can be one of the following values:

  • Shape.NONE: clears the fill style
  • Shape.SOLID: sets the fill style as a solid color. In this mode, the parameters are color (in hexadecimal value) and an optional alpha value
  • Shape.TEXTURE: sets the fill style as textured. In this mode, the parameters are texture and an optional transformation matrix

Parameters

fillstyle: (string) the fill style type
...: (any) parameters of the fill style

Examples

setFillStyle(Shape.NONE) -- clears the fill style
setFillStyle(Shape.SOLID, 0xff0000) -- sets the fill style as solid red color
setFillStyle(Shape.SOLID, 0xff0000, 0.5) -- sets the fill style as solid red color with 0.5 transparency

local texture = Texture.new("image.png")
setFillStyle(Shape.TEXTURE, texture) -- sets the fill style as texture with "image.png"

local matrix = Matrix.new(0.5, 0, 0, 0.5, 0, 0)
setFillStyle(Shape.TEXTURE, texture, matrix) -- sets the fill style as texture with "image.png" with a transformation matrix

--[[
setFillStyle(Shape.LINEAR_GRADIENT, {}, {}, {}, (optional) matrix) -- not supported yet
setFillStyle(Shape.RADIAL_GRADIENT, {}, {}, {}, (optional) matrix) -- not supported yet
]]