Difference between revisions of "RenderTarget:clear"

From GiderosMobile
m (Text replacement - "</source>" to "</syntaxhighlight>")
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 
'''Available since:''' Gideros 2013.06<br/>
 
'''Available since:''' Gideros 2013.06<br/>
 +
'''Class:''' [[RenderTarget]]<br/>
 +
 
=== Description ===
 
=== Description ===
<translate>Clears rendered texture with provided color and opacity</translate>
+
Clears rendered texture with provided color and opacity.
<source lang="lua">
+
<syntaxhighlight lang="lua">
RenderTarget:clear(color,alpha,x,y,width,height)
+
RenderTarget:clear(color,alpha,x,y,width,height)
</source>
+
</syntaxhighlight>
 +
 
 
=== Parameters ===
 
=== Parameters ===
'''color''': (number) <translate>color using which to clear the texture</translate> <br/>
+
'''color''': (number) color used to clear the texture<br/>
'''alpha''': (number) <translate>transparency using which to clear the texture</translate> <br/>
+
'''alpha''': (number) transparency used to clear the texture<br/>
'''x''': (number) <translate>relative x coordinate</translate> '''optional'''<br/>
+
'''x''': (number) relative x coordinate '''optional'''<br/>
'''y''': (number) <translate>relative y coordinate</translate> '''optional'''<br/>
+
'''y''': (number) relative y coordinate '''optional'''<br/>
'''width''': (number) <translate>width of the area to clear starting from x coordinate</translate> '''optional'''<br/>
+
'''width''': (number) width of the area to clear, starting from x coordinate '''optional'''<br/>
'''height''': (number) <translate>height of the area to clear starting from y coordinate</translate> '''optional'''<br/>
+
'''height''': (number) height of the area to clear, starting from y coordinate '''optional'''<br/>
 +
 
 +
{{RenderTarget}}

Latest revision as of 14:32, 13 July 2023

Available since: Gideros 2013.06
Class: RenderTarget

Description

Clears rendered texture with provided color and opacity.

RenderTarget:clear(color,alpha,x,y,width,height)

Parameters

color: (number) color used to clear the texture
alpha: (number) transparency used to clear the texture
x: (number) relative x coordinate optional
y: (number) relative y coordinate optional
width: (number) width of the area to clear, starting from x coordinate optional
height: (number) height of the area to clear, starting from y coordinate optional