DxGetTexturePixels: Difference between revisions

Revision as of 01:44, 25 January 2012

This function fetches the pixels from a texture element. It can be used with a standard texture, render target or screen source.

Performance note:

This function is slow and not something you want to be doing once a frame.
It is slower when reading pixels from a render target or screen source.
And is very slow indeed if the texture format is not 'argb'

Syntax

string dxGetTexturePixels( element texture [, int x, int y, int width, int height ] )

Required Arguments

texture : The texture element to get the pixels from

Optional Arguments

By default the pixels from the whole texture is returned. To get only a portion of the texture, define a rectangular area using all four of these optional arguments:

x: Rectangle left position
y: Rectangle top position
width: Rectangle width
height : Rectangle height

Returns

Returns a 'plain' format pixels string if successful, false if invalid arguments were passed to the function.

Example

TODO

Requirements

Minimum server version	n/a
Minimum client version	1.3

Note: Using this feature requires the resource to have the above minimum version declared in the meta.xml <min_mta_version> section. e.g. <min_mta_version client="1.3" />

@@ Line 32: / Line 32: @@
 TODO
 </syntaxhighlight>
+==Requirements==
+{{Requirements|n/a|1.3|}}
 ==See Also==
 {{Drawing_functions}}