DgsCreateGradient: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Client function}}
{{Client function}}
This function is for creating a gradient for DGS elements.
This function is for creating a gradient shader.


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
element dgsCreateShader ( float color1, float color2, [ float direction = 1 ] )
element dgsCreateGradient( int colorFrom, int colorTo [, float rotation =0 ] )
</syntaxhighlight>
</syntaxhighlight>


===Required Arguments===
===Required Arguments===
*'''color1''': Gradient color 1
*'''colorFrom''': Gradient color 1
*'''color2''': Gradient color 2
*'''colorTo ''': Gradient color 2


===Optional Arguments===
===Optional Arguments===
*'''direction''': The direction in which gradient will follow. (1- left to right, 2- right to left, 3- top to bottom, 4- bottom to top)
*'''rotation ''': The rotation of the direction of the gradient.


===Returns===
===Returns===
Returns a shader if successful, ''false'' otherwise.
Returns a dgs-dxgradient [Element Type:shader] if successful, ''false'' otherwise.
 
==Example==
<syntaxhighlight lang="lua">
DGS = exports.dgs
--create our button
button = DGS:dgsCreateButton( 0.7, 0.1, 0.2, 0.1, "OK", true )
gradient = DGS:dgsCreateGradient(tocolor(240,10,10,255),tocolor(100,10,10,255),-90)
DGS:dgsGradientSetColorOverwritten(gradient,false) --Tell gradient that don't overwrite the color from the button
DGS:dgsSetProperty(button,"image",{gradient, gradient, gradient}) -- Apply the gradient to the button
DGS:dgsSetProperty(button,"color",{tocolor(200,200,200,255),tocolor(255,255,255,255),tocolor(100,100,100,255)}) -- Apply the gradient to the button
 
</syntaxhighlight>

Revision as of 17:29, 7 August 2021

This function is for creating a gradient shader.

Syntax

element dgsCreateGradient( int colorFrom, int colorTo [, float rotation =0 ] )

Required Arguments

  • colorFrom: Gradient color 1
  • colorTo : Gradient color 2

Optional Arguments

  • rotation : The rotation of the direction of the gradient.

Returns

Returns a dgs-dxgradient [Element Type:shader] if successful, false otherwise.

Example

DGS = exports.dgs
--create our button
button = DGS:dgsCreateButton( 0.7, 0.1, 0.2, 0.1, "OK", true )
gradient = DGS:dgsCreateGradient(tocolor(240,10,10,255),tocolor(100,10,10,255),-90)
DGS:dgsGradientSetColorOverwritten(gradient,false) --Tell gradient that don't overwrite the color from the button
DGS:dgsSetProperty(button,"image",{gradient, gradient, gradient}) -- Apply the gradient to the button
DGS:dgsSetProperty(button,"color",{tocolor(200,200,200,255),tocolor(255,255,255,255),tocolor(100,100,100,255)}) -- Apply the gradient to the button