DgsCreateImage

2018-01-27T15:55:58Z

Fanbox: /* Example */

__NOTOC__
{{Client function}}
This function creates an image using image elements ( render target, texture element, shader and screen source and so on, even nothing just color ).

==Syntax==
<syntaxhighlight lang="lua">
element dgsCreateImage ( float x, float y, float width, float height, element image = nil, bool relative, [element parent = nil, int color = 0xFFFFFFFF ] )
</syntaxhighlight>

===Required Arguments===
[[Image:gui-staticimage.png|frame|Example image .]]
*'''x:''' A float of the 2D x position of the image on a player's screen. This is affected by the ''relative'' argument.
*'''y:''' A float of the 2D y position of the image on a player's screen. This is affected by the ''relative'' argument.
*'''width:''' A float of the width of the image. This is affected by the ''relative'' argument.
*'''height:''' A float of the height of the image. This is affected by the ''relative'' argument.
*'''image:''' An texture element such as texture, render target, screen source, shader and so on. Or nil (color only).
*'''relative:''' This is whether sizes and positioning are relative. If this is ''true'', then all x,y,width,height floats must be between 0 and 1, representing measures relative to the parent.

===Optional Arguments===
{{OptionalArg}}
*'''parent:''' This is the parent that the image is attached to. If the ''relative'' argument is true, sizes and positioning will be made relative to this parent. If the ''relative'' argument is false, positioning will be the number of offset pixels from the parent's origin. If no parent is passed, the parent will become the screen - causing positioning and sizing according to screen positioning.
*'''color:''' A integer of the color of the image.

===Returns===
Returns [[element]] if image was created successfully, ''false'' otherwise.

==Example==
This example will display a rectangle on the player's screen.
<section name="Client-side" class="client" show="true">
<syntaxhighlight lang="lua">
DGS = exports.dgs
local image = DGS:dgsCreateImage(100,100,200,200,_,false,_,tocolor(255,255,255,255))
setTimer(function()
DGS:dgsSetProperty(image,"color",tocolor(math.random(0,255),math.random(0,255),math.random(0,255),255))
end,100,0)
</syntaxhighlight>
</section>

==See Also==
{{DGSFUNCTIONS}}

Multi Theft Auto: Wiki - User contributions [en]

DgsCreateImage