DxUpdateScreenSource - Revision history

Toliak: Fix class name in OOP

2021-05-14T16:52:08Z

Fix class name in OOP

← Older revision		Revision as of 16:52, 14 May 2021
Line 7:		Line 7:
	bool dxUpdateScreenSource ( element screenSource [, bool resampleNow = false ] )		bool dxUpdateScreenSource ( element screenSource [, bool resampleNow = false ] )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|\|[[~~texture\|screensource~~]]:update}}		{{OOP\|\|[[DxScreenSource]]:update}}
	===Required Arguments===		===Required Arguments===
	*'''screenSource:''' The screen source element whose pixels we want to fill with the screen capture		*'''screenSource:''' The screen source element whose pixels we want to fill with the screen capture

Strix: add oop syntax

2015-01-02T20:06:05Z

add oop syntax

← Older revision		Revision as of 20:06, 2 January 2015
Line 7:		Line 7:
	bool dxUpdateScreenSource ( element screenSource [, bool resampleNow = false ] )		bool dxUpdateScreenSource ( element screenSource [, bool resampleNow = false ] )
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\|\|[[texture\|screensource]]:update}}
	===Required Arguments===		===Required Arguments===
	*'''screenSource:''' The screen source element whose pixels we want to fill with the screen capture		*'''screenSource:''' The screen source element whose pixels we want to fill with the screen capture

Ccw at 11:14, 1 August 2012

2012-08-01T11:14:25Z

← Older revision		Revision as of 11:14, 1 August 2012
Line 5:		Line 5:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool dxUpdateScreenSource ( element screenSource [, bool resampleNow =false ] )		bool dxUpdateScreenSource ( element screenSource [, bool resampleNow = false ] )
	</syntaxhighlight>		</syntaxhighlight>

Line 12:		Line 12:

	===Optional Arguments===		===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.		*'''resampleNow:''' A bool to indicate if the screen should be captured immediately. The default is ''false'' which means the screen from the end of the previous frame is used (better for performance and consistency). Use ''true'' for layering fullscreen effects.

	===Returns===		===Returns===

Ccw at 22:40, 31 March 2012

2012-03-31T22:40:09Z

← Older revision		Revision as of 22:40, 31 March 2012
Line 5:		Line 5:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool dxUpdateScreenSource ( element screenSource )		bool dxUpdateScreenSource ( element screenSource [, bool resampleNow =false ] )
	</syntaxhighlight>		</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
	*'''screenSource:''' The screen source element whose pixels we want to fill with the screen capture		*'''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===
Line 39:		Line 42:
	)		)
	</syntaxhighlight>		</syntaxhighlight>

			==Changelog==
			{{ChangelogHeader}}
			{{ChangelogItem\|1.3.0-9.03795\|Added resample argument}}

	==See Also==		==See Also==
	{{Drawing_functions}}		{{Drawing_functions}}

Ccw at 17:35, 31 August 2011

2011-08-31T17:35:40Z

← Older revision		Revision as of 17:35, 31 August 2011
Line 1:		Line 1:
	{{Client function}}		{{Client function}}
	__NOTOC__		__NOTOC__
	~~{{New feature\|3.0110\|1.1\|~~
	~~Only available in 1.1~~
	}}
	This function updates the contents of a screen source [[texture]] with the screen output from GTA		This function updates the contents of a screen source [[texture]] with the screen output from GTA

Ccw: Created page with "{{Client function}} NOTOC {{New feature|3.0110|1.1| Only available in 1.1 }} This function updates the contents of a screen source texture with the screen output from GTA..."

2011-06-13T23:56:08Z

Created page with "{{Client function}} __NOTOC__ {{New feature|3.0110|1.1| Only available in 1.1 }} This function updates the contents of a screen source texture with the screen output from GTA..."

New page

{{Client function}}
__NOTOC__
{{New feature|3.0110|1.1|
Only available in 1.1
}}
This function updates the contents of a screen source [[texture]] with the screen output from GTA

==Syntax==
<syntaxhighlight lang="lua">
bool dxUpdateScreenSource ( element screenSource )
</syntaxhighlight>

===Required Arguments===
*'''screenSource:''' The screen source element whose pixels we want to fill with the screen capture

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

==Example==
This example will update the screen capture when F7 is pressed
<syntaxhighlight lang="lua">
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
)
</syntaxhighlight>

==See Also==
{{Drawing_functions}}