DxUpdateScreenSource: Difference between revisions

Revision as of 22:40, 31 March 2012

This function updates the contents of a screen source texture with the screen output from GTA

Syntax

bool dxUpdateScreenSource ( element screenSource [, bool resampleNow =false ] )

Required Arguments

screenSource: The screen source element whose pixels we want to fill with the screen capture

Optional Arguments

resampleNow: A bool to indicate if the screen capture should resample the current state. The default is false which is better for performance and consistency. Use true for layering fullscreen effects.

Returns

Returns true if the screen was successfully captured, false otherwise.

Example

This example will update the screen capture when F7 is pressed

addEventHandler("onClientResourceStart", resourceRoot,
    function()
        myScreenSource = dxCreateScreenSource( 500, 500)    -- Create a screen source texture which is 500 x 500 pixels
    end
)

bindKey( "F7", "down", 
    function()
        if myScreenSource then
            dxUpdateScreenSource( myScreenSource )          -- Capture the screen
        end
    end
)

addEventHandler( "onClientRender", root,
    function()
        if myScreenSource then
            dxDrawImage ( 0, 0, 300, 300, myScreenSource )  -- Draw the result in top left corner
        end
    end
)

Changelog

Version	Description

1.3.0-9.03795

Added resample argument

@@ Line 5: / Line 5: @@
 ==Syntax==
 <syntaxhighlight lang="lua">
-bool dxUpdateScreenSource ( element screenSource )
+bool dxUpdateScreenSource ( element screenSource [, bool resampleNow =false ] )
 </syntaxhighlight>
 ===Required Arguments===
 *'''screenSource:''' The screen source element whose pixels we want to fill with the screen capture
+===Optional Arguments===
+*'''resampleNow:''' A bool to indicate if the screen capture should resample the current state. The default is ''false'' which is better for performance and consistency. Use ''true'' for layering fullscreen effects.
 ===Returns===
@@ Line 39: / Line 42: @@
 )
 </syntaxhighlight>
+==Changelog==
+{{ChangelogHeader}}
+{{ChangelogItem|1.3.0-9.03795|Added resample argument}}
 ==See Also==
 {{Drawing_functions}}