This function changes the drawing destination for the dx functions. It can be used to select a previously created render target, or if called with no arguments, restore drawing directly to the screen.

Note

• Items drawn with postGUI set to true will not appear on a custom render target.
• dxSetRenderTarget can be set at any time as long as <min_mta_version> in meta.xml is set to at least 1.3.0-9.04431 e.g. <min_mta_version client="1.3.0-9.04431" />.

OOP Syntax Help! I don't understand this!

• Method:dx-rendertarget:setAsTarget(...)

Syntax

​bool dxSetRenderTarget ( ​dx-rendertarget renderTarget, [ ​bool clear = false ] )

Required Arguments

• renderTarget: The render target element whose pixels we want to draw on.

Optional Arguments

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

• clear (default: false): If set to true, the render target will also be cleared.

Returns

• bool: result

Returns true if the render target was successfully changed, false otherwise.

Code Examples

Example 1 Example 2 Example 3 (OOP)

client

local myRenderTarget

addEventHandler("onClientResourceStart", resourceRoot, function()
    myRenderTarget = dxCreateRenderTarget(80, 100) -- Create a render target texture which is 80 x 100 pixels
end)

addEventHandler("onClientRender", root, function()
    if myRenderTarget then
        dxSetRenderTarget(myRenderTarget) -- Select custom render target
        dxDrawText("Hello", 10, 20) -- The message 'Hello' will be drawn on myRenderTarget

        dxSetRenderTarget() -- Select default render target
        dxDrawText("Goodbye", 10, 20) -- The message 'Goodbye' will be drawn directly to the screen
    end
end)

client

This example shows how you can prepare render target contents at anytime.

local myRenderTarget

addEventHandler("onClientResourceStart", resourceRoot, function()
    myRenderTarget = dxCreateRenderTarget(80, 100) -- Create a render target texture which is 80 x 100 pixels
    dxSetRenderTarget(myRenderTarget) -- Select custom render target for drawing
    dxDrawRectangle(2, 2, 60, 60, tocolor(255, 255, 0)) -- Draw anything you like (to the render target)
    dxDrawText("Hello", 10, 20)
    dxDrawText("This is", 10, 40)
    dxDrawText("Amazing", 10, 60)
    dxSetRenderTarget() -- Unselect custom render target
end)

addEventHandler("onClientRender", root, function()
    if myRenderTarget then
        dxDrawImage(100, 200, 80, 100, myRenderTarget) -- Draw myRenderTarget content to the screen
    end
end)

client

OOP Required

This example shows how you can prepare render target contents at anytime.

local myRenderTarget

addEventHandler("onClientResourceStart", resourceRoot, function()
    myRenderTarget = DxRenderTarget(80, 100) -- Create a render target texture which is 80 x 100 pixels
end)

addEventHandler("onClientRender", root, function()
    if myRenderTarget then
        myRenderTarget:setAsTarget() -- Select custom render target
        dxDrawText("Hello", 10, 20) -- The message 'Hello' will be drawn on myRenderTarget

        dxSetRenderTarget() -- Select default render target
        dxDrawText("Goodbye", 10, 20) -- The message 'Goodbye' will be drawn directly to the screen
    end
end)

Changelog

1.3.0-9.04431

Removed restrictions on when dxSetRenderTarget could be called.

See Also

Drawing Functions

• dxConvertPixels
• dxCreateFont
• dxCreateRenderTargetUpdated
• dxCreateScreenSource
• dxCreateShader
• dxCreateTextureUpdated
• dxDrawCircle
• dxDrawImage
• dxDrawImageSection
• dxDrawLine
• dxDrawLine3D
• dxDrawMaterialLine3D
• dxDrawMaterialPrimitive
• dxDrawMaterialPrimitive3D
• dxDrawMaterialSectionLine3D
• dxDrawModel3DNew
• dxDrawPrimitive
• dxDrawPrimitive3D
• dxDrawRectangle
• dxDrawText
• dxDrawWiredSphere
• dxGetBlendMode
• dxGetFontHeight
• dxGetMaterialSize
• dxGetPixelColor
• dxGetPixelsFormat
• dxGetPixelsSize
• dxGetStatusUpdated
• dxGetTextSize
• dxGetTexturePixelsUpdated
• dxGetTextWidth
• dxIsAspectRatioAdjustmentEnabled
• dxSetAspectRatioAdjustmentEnabled
• dxSetBlendMode
• dxSetPixelColor
• dxSetRenderTarget
• dxSetShaderTessellation
• dxSetShaderTransform
• dxSetShaderValue
• dxSetTestMode
• dxSetTextureEdge
• dxSetTexturePixels
• dxUpdateScreenSource

Drawing Elements

• dx-font
• dx-rendertarget
• dx-screensource
• shader
• texture

Reference

• Scripting Functions