DxDrawCircle: Difference between revisions

Latest revision as of 19:07, 8 December 2021

This function draws a circle shape on the screen - rendered for one frame. This should be used in conjunction with onClientRender in order to be display continuously.

Syntax

bool dxDrawCircle ( float posX, float posY, float radius [, float startAngle = 0.0, float stopAngle = 360.0, int theColor = white,
                    int theCenterColor = theColor, int segments = 32, int ratio = 1, bool postGUI = false ] )

Required Arguments

An example of how dxDrawCircle function works in practice.

posX: An integer representing the absolute X position of the circle center, represented by pixels on the screen.
posY: An integer representing the absolute Y position of the circle center, represented by pixels on the screen.
radius: An integer representing the radius scale of the circle that is being drawn.

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.

startAngle: An integer representing the angle of the first point of the circle.
stopAngle: An integer representing the angle of the last point of the circle.
theColor: An integer of the hex color, produced using tocolor or 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue).
theCenterColor: An integer of the hex color, produced using tocolor or 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue).
segments: An integer ranging from 3-1024 representing how many triangles are used to form the circle, more segments = smoother circle. Note: using lots of segments may cause lag.
ratio: Ratio between width and height, e.g: 2 would mean that the width of the circle is 2 times the height.
postGUI: A bool representing whether the circle should be drawn on top of or behind any ingame GUI (rendered by CEGUI).

Returns

Returns true if the creation of the 2D circle was successful, false otherwise.

Remarks

By documentation this function does perform a triangle approximation of the cicle. This is important for when there is no shader support on the end-user hardware. If there is shader support then you can instead use shaders with euler-based math (sin/cos/asin) to create a smoother circle. The performance does scale much better than increasing the segment count of this function because drawing using shader would take up only one draw-call. Take look at this post for more details.

The above remark is about drawing circles on modern end-user hardware with angle-interval support, as necessary by example for pie-charts. Drawing full circles is easier because the math can be simplified to a euler distance calculation from the texcoord (0.5, 0.5) to the currently drawing pixel. Then the HLSL clip function can be used to not render any pixels outside of the circle. Read more about it in this post.

Example

This function draws a rectangle with rounded corners.

function dxDrawRoundedRectangle(x, y, rx, ry, color, radius)
    rx = rx - radius * 2
    ry = ry - radius * 2
    x = x + radius
    y = y + radius

    if (rx >= 0) and (ry >= 0) then
        dxDrawRectangle(x, y, rx, ry, color)
        dxDrawRectangle(x, y - radius, rx, radius, color)
        dxDrawRectangle(x, y + ry, rx, radius, color)
        dxDrawRectangle(x - radius, y, radius, ry, color)
        dxDrawRectangle(x + rx, y, radius, ry, color)

        dxDrawCircle(x, y, radius, 180, 270, color, color, 7)
        dxDrawCircle(x + rx, y, radius, 270, 360, color, color, 7)
        dxDrawCircle(x + rx, y + ry, radius, 0, 90, color, color, 7)
        dxDrawCircle(x, y + ry, radius, 90, 180, color, color, 7)
    end
end
dxDrawRoundedRectangle(350, 50, 100, 100, tocolor(0, 255, 0, 255), 20)

@@ Line 1: / Line 1: @@
-{{Useful Function}}
+{{Client Function}}
 <lowercasetitle/>
 __NOTOC__
-This function draws a 2D line in a circle shape on the screen - rendered for one frame continuously.
+{{New feature/item|3.0156|1.5.5|13977|This function draws a circle shape on the screen - rendered for '''one''' frame.  This should be used in conjunction with [[onClientRender]] in order to be display continuously.}}
 ==Syntax==
-<syntaxhighlight lang="lua">void dxDrawCircle( int posX, int posY[, int radius, int, width, int angleAmount, int red, int green, int blue, int alpha, bool postGUI ] )</syntaxhighlight>
+<syntaxhighlight lang="lua">bool dxDrawCircle ( float posX, float posY, float radius [, float startAngle = 0.0, float stopAngle = 360.0, int theColor = white,
+                    int theCenterColor = theColor, int segments = 32, int ratio = 1, bool postGUI = false ] )</syntaxhighlight>
 ===Required Arguments===
+[[Image:DxDrawCircle_Saml1er.png|thumb|An example of how dxDrawCircle function works in practice.]]
 * '''posX''': An integer representing the '''absolute''' X position of the circle center, represented by pixels on the screen.
 * '''posY''': An integer representing the '''absolute''' Y position of the circle center, represented by pixels on the screen.
+* '''radius''': An integer representing the radius scale of the circle that is being drawn.
 ===Optional Arguments===
 {{OptionalArg}}
-* '''radius''': An integer representing the radius scale of the circle that is being drawn.
+* '''startAngle''': An integer representing the angle of the first point of the circle.
-* '''width''': An integer representing the width of the line that is being drawn.
+* '''stopAngle''': An integer representing the angle of the last point of the circle.
-* '''angleAmount''': An integer representing the tightness of the circle. Lower amount makes it smoother, higher amount makes it more of a clock looking circle.
+* '''theColor''': An integer of the hex color, produced using [[tocolor]] or 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue).
-* '''red''': An integer representing the amount of red color.
+* '''theCenterColor''': An integer of the hex color, produced using [[tocolor]] or 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue).
-* '''green''': An integer representing the amount of green color.
+* '''segments''': An integer ranging from 3-1024 representing how many triangles are used to form the circle, more segments = smoother circle. Note: using lots of segments may cause lag.
-* '''blue''': An integer representing the amount of blue color.
+* '''ratio''': Ratio between width and height, e.g: 2 would mean that the width of the circle is 2 times the height.
-* '''alpha''': An integer representing the amount of transparency.
+* '''postGUI''': A bool representing whether the circle should be drawn on top of or behind any ingame GUI (rendered by CEGUI).
-* '''postGUI''': A bool representing whether the line should be drawn on top of or behind any ingame GUI (rendered by CEGUI).
-==Code==
+===Returns===
-<section name="Clientside Script" class="client" show="true">
+Returns ''true'' if the creation of the 2D circle was successful, ''false'' otherwise.
-<syntaxhighlight lang="lua">
-local deg2rad = math.pi/180
-local function clamp(val, lower, upper)
+==Remarks==
-	if (lower > upper) then lower, upper = upper, lower end
+By documentation this function does perform a '''triangle approximation of the cicle'''. This is important for when there is no shader support on the end-user hardware. If there is shader support then you can instead use shaders with euler-based math (sin/cos/asin) to create a smoother circle. The performance does scale much better than increasing the segment count of this function because drawing using shader would take up only one draw-call. Take look at [https://forum.mtasa.com/topic/133045-dxdrawcircle-chart/?do=findComment&comment=1002953 this post] for more details.
-	return math.max(lower, math.min(upper, val))
-end
-function dxDrawCircle(posX, posY, radius, width, angleAmount, red, green, blue, alpha, postGUI)
+The above remark is about drawing circles on modern end-user hardware with angle-interval support, as necessary by example for pie-charts. '''Drawing full circles''' is easier because the math can be simplified to a euler distance calculation from the texcoord (0.5, 0.5) to the currently drawing pixel. Then the HLSL clip function can be used to not render any pixels outside of the circle. Read more about it in [https://forum.mtasa.com/topic/133453-round-render-target/#comment-1004102 this post].
-	radius = radius or 50
-	width = width or 5
-	angleAmount = angleAmount or 1
-	red = red or 255
-	green = green or 255
-	blue = blue or 255
-	alpha = alpha or 255
-	postGUI = postGUI or false
-	for i=0,360,angleAmount do
-		local _i = i*deg2rad
-		dxDrawLine(math.cos(_i)*(radius-width)+posX, math.sin(_i)*(radius-width)+posY, math.cos(_i)*(radius+width)+posX, math.sin(_i)*(radius+width)+posY, tocolor(red, green, blue, alpha), width, postGUI)
-	end
-end
-</syntaxhighlight>
-</section>
 ==Example==
-<section name="Client" class="client" show="true">
+This function draws a rectangle with rounded corners.
-This example draws a circle shape in the middle of the screen on resource start.
 <syntaxhighlight lang="lua">
-local sx, sy = guiGetScreenSize()
+function dxDrawRoundedRectangle(x, y, rx, ry, color, radius)
+    rx = rx - radius * 2
+    ry = ry - radius * 2
+    x = x + radius
+    y = y + radius
-addEventHandler("onClientResourceStart", resourceRoot,
+    if (rx >= 0) and (ry >= 0) then
-	function()
+        dxDrawRectangle(x, y, rx, ry, color)
-		addEventHandler("onClientRender", root,
+        dxDrawRectangle(x, y - radius, rx, radius, color)
-			function()
+        dxDrawRectangle(x, y + ry, rx, radius, color)
-				dxDrawCircle(sx/2, sy/2)
+        dxDrawRectangle(x - radius, y, radius, ry, color)
-			end
+        dxDrawRectangle(x + rx, y, radius, ry, color)
-		)
-	end
+        dxDrawCircle(x, y, radius, 180, 270, color, color, 7)
-)
+        dxDrawCircle(x + rx, y, radius, 270, 360, color, color, 7)
+        dxDrawCircle(x + rx, y + ry, radius, 0, 90, color, color, 7)
+        dxDrawCircle(x, y + ry, radius, 90, 180, color, color, 7)
+    end
+end
+dxDrawRoundedRectangle(350, 50, 100, 100, tocolor(0, 255, 0, 255), 20)
 </syntaxhighlight>
-</section>
-'''Author:''' Socialz
+==See Also==
+{{Drawing_functions}}
-==See Also==
+[[hu:dxDrawCircle]]
-{{Useful_Functions}}