Manual Review Required

Please finish this page using the corresponding Old Wiki article. Go to Contribution guidelines for more information.

---

This function draws a 2D line across the screen - rendered for one frame. This should be used in conjunction with onClientRender in order to display continuously.

Syntax

bool dxDrawLine ( int startX, int startY, int endX, int endY, int color, [ float width = 1.0, bool postGUI = false ] )

Required Arguments

• startX: An integer representing the absolute start X position of the line, represented by pixels on the screen.
• startY: An integer representing the absolute start Y position of the line, represented by pixels on the screen.
• endX: An integer representing the absolute end X position of the line, represented by pixels on the screen.
• endY: An integer representing the absolute end Y position of the line, represented by pixels on the screen.
• color: An integer of the hex color, produced using tocolor or 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue).

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use.

• width (default: 1.0): MISSING_PARAM_DESC
• postGUI (default: false): MISSING_PARAM_DESC

Returns

• bool: value

Returns a true if the operation was successful, false otherwise.

Code Examples

Example 1 Example 2

shared

This example draws an 'X' across the screen.

local screenWidth, screenHeight = guiGetScreenSize()
local lineColor = tocolor(255, 0, 0)
function drawLinesAcrossScreen()
  dxDrawLine(0, 0, screenWidth, screenHeight, lineColor)
  dxDrawLine(screenWidth, 0, 0, screenHeight, lineColor)
end
addEventHandler("onClientRender", root, drawLinesAcrossScreen)

shared

This example draws a couple of circles

function drawCircle(x,y, radius, color)
    local numPoints = math.floor(math.pow(radius, 0.4) * 5)     -- Calculate number of points to make it look good
    local step = math.pi * 2 / numPoints
    local sx,sy
    for p=0,numPoints do
        local ex = math.cos(p * step) * radius
        local ey = math.sin(p * step) * radius
        if sx then
            dxDrawLine(x+sx, y+sy, x+ex, y+ey, color)
        end
        sx,sy = ex,ey
    end
end

addEventHandler("onClientRender", root, function()
    drawCircle(350, 350, 10, tocolor(255,0,255))
    drawCircle(350, 350, 50, tocolor(255,0,255))
end)

See Also

Drawing Functions

• dxConvertPixels
• dxCreateFont
• dxCreateRenderTarget
• dxCreateScreenSource
• dxCreateShader
• dxCreateTexture
• dxDrawCircle
• dxDrawImage
• dxDrawImageSection
• dxDrawLine
• dxDrawLine3D
• dxDrawMaterialLine3D
• dxDrawMaterialPrimitive
• dxDrawMaterialPrimitive3D
• dxDrawMaterialSectionLine3D
• dxDrawModel3D
• dxDrawPrimitive
• dxDrawPrimitive3D
• dxDrawRectangle
• dxDrawText
• dxDrawWiredSphere
• dxGetBlendMode
• dxGetFontHeight
• dxGetMaterialSize
• dxGetPixelColor
• dxGetPixelsFormat
• dxGetPixelsSize
• dxGetStatus
• dxGetTextSize
• dxGetTexturePixels
• dxGetTextWidth
• dxIsAspectRatioAdjustmentEnabled
• dxSetAspectRatioAdjustmentEnabled
• dxSetBlendMode
• dxSetPixelColor
• dxSetRenderTarget
• dxSetShaderTessellation
• dxSetShaderTransform
• dxSetShaderValue
• dxSetTestMode
• dxSetTextureEdge
• dxSetTexturePixels
• dxUpdateScreenSource

Drawing Elements

• dx-font
• shader
• texture

Reference

• Scripting Functions