DgsCreateRoundRect: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
(33 intermediate revisions by 2 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Client function}}
{{Client function}}
<span style="color:#FF0000;text-shadow:black 0.1em 0.1em 0.2em;">>>>Warning: This feature requires pixel shader module 2_a<<<</span>
<span style="color:#FF0000;text-shadow:black 0.1em 0.1em 0.6em;">>>>Warning: This feature requires pixel shader model 2_a<<<</span>


This function creates a rounded rectangle shader that can be used for dgs elements.
This function creates a rounded rectangle shader that can be used for dgs elements.
Line 7: Line 7:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
element dgsCreateRoundRect( float radius [, int color = 0xFFFFFFFF, texture background = nil )
element dgsCreateRoundRect( float radius, bool relative [, int color = 0xFFFFFFFF, texture background = nil, bool colorOverwritten = true, bool/int border = false, float borderHorizontalThickness, float borderVerticalThickness ] )
</syntaxhighlight>  
</syntaxhighlight>  


[[Image:DGS_Rounded_Rectangle.png|300px|thumb|Example Rounded Rectangle]]
[[Image:DGS_Rounded_Rectangle.png|300px|thumb|Example Rounded Rectangle]]
===Required Arguments===
===Required Arguments===
*'''radius:''' A float of the relative radius of corner of the rounded rectangle ranges from 0 to 1.
*'''radius:''' A float of the relative radius of corner of the rounded rectangle ranges from 0 to 1 '''if relative is true''', or the radius will be absolute pixels.
*'''relative:''' A bool indicates whether the radius is relative to the size of round rectangle or just absolute pixels.
 
===Optional Arguments===
{{OptionalArg}}
*'''color''': An int of the color of the rounded rectangle.
*'''background''': A texture element of the background of the rounded rectangle.
*'''colorOverwritten''': A bool indicates whether the final color will be overwritten by '''color ''' or the product of render color and '''color''' (resultColor = render color * '''color''') when rendering.
*'''border''': set to ''true'' to make it border only or an integer of color to apply the border with color. ''false'' is set by default to disable border.
*'''borderHorizontalThickness''': A float of the horizontal thickness, only works when '''border''' is not set to false.
*'''borderVerticalThickness''': A float of the vertical thickness, only works when '''border''' is not set to false.
 
===Returns===
Returns a dgs-dxroundrectangle element (dgs Type)/ shader (element Type) if succeed, ''false'' otherwise
 
==Example==
<syntaxhighlight lang="lua">
DGS = exports.dgs --get exported functions from dgs
 
local rndRect = DGS:dgsCreateRoundRect(50,false,tocolor(0,0,0,150))  --Create Rounded Rectangle with 50 pixels radius
local image1 = DGS:dgsCreateImage(200,200,400,100,rndRect,false)  --Apply it to the dgs image
</syntaxhighlight>
 
==Syntax==
<syntaxhighlight lang="lua">
element dgsCreateRoundRect( table multiArguments [, int color = 0xFFFFFFFF, texture background = nil, bool colorOverwritten = true, bool/int border = false, float borderHorizontalThickness, float borderVerticalThickness ] )
</syntaxhighlight>
 
===Required Arguments===
*'''multiArguments :''' A table contains at least 1 group of the radius of the corner. The structure is as follows:
<syntaxhighlight lang="lua">
{
{ float LeftTopRadius, bool relative },
{ float RightTopRadius, bool relative },
{ float RightBottomRadius, bool relative },
{ float LeftBottomRadius, bool relative },
}
</syntaxhighlight>


===Optional Arguments===  
===Optional Arguments===  
{{OptionalArg}}  
{{OptionalArg}}  
*'''color :''' An int of the color of the rounded rectangle.
*'''color :''' An int of the color of the rounded rectangle.
*'''background:''' A texture element of the background of the rounded rectangle
*'''background:''' A texture element of the background of the rounded rectangle.
*'''colorOverwritten :''' A bool indicates whether the final color will be overwritten by '''color ''' or the product of render color and '''color''' when rendering.
*'''border''': set to ''true'' to make it border only or an ''integer'' of color to apply the border with color. ''false'' is set by default to disable border.
*'''borderHorizontalThickness''': A float of the horizontal thickness, only works when '''border''' is not set to false.
*'''borderVerticalThickness''': A float of the vertical thickness, only works when '''border''' is not set to false.


===Returns===
===Returns===
Returns a dgs-dxroundrectangle element (dgs Type)/ shader (element Type) if succeed, '''false''' otherwise
Returns a dgs-dxroundrectangle element (dgs Type)/ shader (element Type) if succeed, ''false'' otherwise


==Example==  
==Example==  
Line 26: Line 67:
DGS = exports.dgs --get exported functions from dgs
DGS = exports.dgs --get exported functions from dgs


local rndRect = dgsCreateRoundRect(1,tocolor(0,0,0,150))  --Create Rounded Rectangle
local rndRect = DGS:dgsCreateRoundRect({{50,false},{40,false},{30,false},{20,false}},tocolor(0,0,0,150))  --Create Rounded Rectangle with 50 pixels radius
local image1 = dgsCreateImage(200,200,400,100,rndRect,false)  --Apply it to the dgs image
local image1 = DGS:dgsCreateImage(200,200,400,100,rndRect,false)  --Apply it to the dgs image
</syntaxhighlight>
</syntaxhighlight>
==See Also==
==See Also==
{{DGSFUNCTIONS}}
{{DGSFUNCTIONS}}

Latest revision as of 08:05, 1 March 2023

>>>Warning: This feature requires pixel shader model 2_a<<<

This function creates a rounded rectangle shader that can be used for dgs elements.

Syntax

element dgsCreateRoundRect( float radius, bool relative [, int color = 0xFFFFFFFF, texture background = nil, bool colorOverwritten = true, bool/int border = false, float borderHorizontalThickness, float borderVerticalThickness ] )
Example Rounded Rectangle

Required Arguments

  • radius: A float of the relative radius of corner of the rounded rectangle ranges from 0 to 1 if relative is true, or the radius will be absolute pixels.
  • relative: A bool indicates whether the radius is relative to the size of round rectangle or just absolute pixels.

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

  • color: An int of the color of the rounded rectangle.
  • background: A texture element of the background of the rounded rectangle.
  • colorOverwritten: A bool indicates whether the final color will be overwritten by color or the product of render color and color (resultColor = render color * color) when rendering.
  • border: set to true to make it border only or an integer of color to apply the border with color. false is set by default to disable border.
  • borderHorizontalThickness: A float of the horizontal thickness, only works when border is not set to false.
  • borderVerticalThickness: A float of the vertical thickness, only works when border is not set to false.

Returns

Returns a dgs-dxroundrectangle element (dgs Type)/ shader (element Type) if succeed, false otherwise

Example

DGS = exports.dgs --get exported functions from dgs

local rndRect = DGS:dgsCreateRoundRect(50,false,tocolor(0,0,0,150))  --Create Rounded Rectangle with 50 pixels radius 
local image1 = DGS:dgsCreateImage(200,200,400,100,rndRect,false)  --Apply it to the dgs image

Syntax

element dgsCreateRoundRect( table multiArguments [, int color = 0xFFFFFFFF, texture background = nil, bool colorOverwritten = true, bool/int border = false, float borderHorizontalThickness, float borderVerticalThickness ] )

Required Arguments

  • multiArguments : A table contains at least 1 group of the radius of the corner. The structure is as follows:
{
	{ float LeftTopRadius, bool relative },
	{ float RightTopRadius, bool relative },
	{ float RightBottomRadius, bool relative },
	{ float LeftBottomRadius, bool relative },
}

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

  • color : An int of the color of the rounded rectangle.
  • background: A texture element of the background of the rounded rectangle.
  • colorOverwritten : A bool indicates whether the final color will be overwritten by color or the product of render color and color when rendering.
  • border: set to true to make it border only or an integer of color to apply the border with color. false is set by default to disable border.
  • borderHorizontalThickness: A float of the horizontal thickness, only works when border is not set to false.
  • borderVerticalThickness: A float of the vertical thickness, only works when border is not set to false.

Returns

Returns a dgs-dxroundrectangle element (dgs Type)/ shader (element Type) if succeed, false otherwise

Example

DGS = exports.dgs --get exported functions from dgs

local rndRect = DGS:dgsCreateRoundRect({{50,false},{40,false},{30,false},{20,false}},tocolor(0,0,0,150))  --Create Rounded Rectangle with 50 pixels radius 
local image1 = DGS:dgsCreateImage(200,200,400,100,rndRect,false)  --Apply it to the dgs image

See Also

Custom Cursor Functions

Multi Language Supports

Animation

3D Element

3D Interface

3D Line

3D Image

3D Text

Browser

Button

Check Box

Combo Box

Custom Renderer

Edit

Detect Area

Drag'N Drop

Grid List

Image

Memo

Menu

Label

Layout

Line

Progress Bar

Radio Button

Scale Pane

Scroll Bar

Scroll Pane

Selector

Style

Switch Button

Tab Panel

Window

Basic Shape Plugins

Circle

Quadrilateral

Rounded Rectangle

Other Plugins

Blur Box

Canvas

Chart

Color Picker

Effect 3D

Gradient

Mask

Media Browser

Nine Slice

Object Preview Supports

Paste Handler

QRCode

Remote Image

Screen Source

SVG

Tooltips

Retrieved from "https://wiki.multitheftauto.com/wiki/DgsCreateRoundRect?oldid=76236"