Difference between revisions of "Shape:setFillStyle"

From GiderosMobile
m (Text replacement - "</source>" to "</syntaxhighlight>")
 
(14 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 />
 
−
<br />
 
−
See the following example for more detailed usage of this function.<br />
 
−
<br />
 
−
<source lang="lua">
 
−
Shape:setFillStyle(type,...)
 
−
</source>
 
 
=== Parameters ===
 
=== Parameters ===
−
'''type''': (string) The type of the fill. Can be one of the Shape.NONE, Shape.SOLID or Shape.TEXTURE. <br/>
+
'''fillstyle''': (string) the fill style type<br/>
−
'''...''': (any) Parameters of the fill style. <br/>
+
'''...''': (any) parameters of the fill style<br/>
 +
 
 
=== Examples ===
 
=== Examples ===
−
'''Example'''<br/>
+
<syntaxhighlight lang="lua">
−
<source lang="lua">setFillStyle(Shape.NONE) -- clears the fill style<br />
+
setFillStyle(Shape.NONE) -- clears the fill style
−
<br />
+
setFillStyle(Shape.SOLID, 0xff0000) -- sets the fill style as solid red color
−
setFillStyle(Shape.SOLID, 0xff0000) -- sets the fill style as solid red color<br />
+
setFillStyle(Shape.SOLID, 0xff0000, 0.5) -- sets the fill style as solid red color with 0.5 transparency
−
<br />
+
 
−
setFillStyle(Shape.SOLID, 0xff0000, 0.5) -- sets the fill style as solid red color with 0.5 transparency<br />
+
local texture = Texture.new("image.png")
−
<br />
+
setFillStyle(Shape.TEXTURE, texture) -- sets the fill style as texture with "image.png"
−
local texture = Texture.new(&quot;image.png&quot;)<br />
+
 
−
setFillStyle(Shape.TEXTURE, texture) -- sets the fill style as texture with &quot;image.png&quot;<br />
+
local matrix = Matrix.new(0.5, 0, 0, 0.5, 0, 0)
−
<br />
+
setFillStyle(Shape.TEXTURE, texture, matrix) -- sets the fill style as texture with "image.png" with a transformation matrix
−
local matrix = Matrix.new(0.5, 0, 0, 0.5, 0, 0)<br />
+
 
−
setFillStyle(Shape.TEXTURE, texture, matrix) -- sets the fill style as texture with &quot;image.png&quot; with a transformation matrix<br />
+
--[[
−
&lt;/code&gt;&lt;/pre&gt;<br />
+
setFillStyle(Shape.LINEAR_GRADIENT, {}, {}, {}, (optional) matrix) -- not supported yet
−
&lt;!--<br />
+
setFillStyle(Shape.RADIAL_GRADIENT, {}, {}, {}, (optional) matrix) -- not supported yet
−
&lt;pre&gt;&lt;code&gt;<br />
+
]]
−
setFillStyle(Shape.LINEAR_GRADIENT, {}, {}, {}, (optional) matrix) -- not supported yet<br />
+
</syntaxhighlight>
−
setFillStyle(Shape.RADIAL_GRADIENT, {}, {}, {}, (optional) matrix) -- not supported yet<br />
+
 
−
&lt;/code&gt;&lt;/pre&gt;<br />
+
{{Shape}}
−
--&gt;<br />
 
−
<br /></source>
 

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
]]



Retrieved from ‘https://wiki.gideros.rocks/index.php?title=Shape:setFillStyle&oldid=21916’