DxSetRenderTarget

From Multi Theft Auto: Wiki

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.

Syntax

bool dxSetRenderTarget ( [ element renderTarget, bool clear = false ] )

If no arguments are supplied, the screen is restored as the drawing destination.

Optional Arguments

• renderTarget: The render target element whose pixels we want to draw on.
• clear: If set to true, the render target will also be cleared.

Returns

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

Usage restrictions

• dxSetRenderTarget can only be called during the onClientRender, onClientHUDRender and onClientRestore events.
• Items drawn with postGUI set to true will not appear on a custom render target.

Example

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
)

See Also

• dxDrawImage
• dxDrawImageSection
• dxDrawLine
• dxDrawLine3D
• dxDrawRectangle
• dxDrawText
• dxGetFontHeight
• dxGetTextWidth
• dxCreateFont
• dxCreateTexture
• dxCreateShader
• dxCreateRenderTarget
• dxCreateScreenSource
• dxGetMaterialSize
• dxSetShaderValue
• dxSetShaderTessellation
• dxSetShaderTransform
• dxSetRenderTarget
• dxUpdateScreenSource
• dxGetStatus
• dxSetTestMode

• dxGetTexturePixels
• dxSetTexturePixels
• dxGetPixelsSize
• dxGetPixelsFormat
• dxConvertPixels
• dxGetPixelColor
• dxSetPixelColor