DxSetTexturePixels: Difference between revisions

Revision as of 01:44, 25 January 2012

This function sets the pixels of a texture element. It can be used with a standard texture, render target or screen source. Only 'plain' format pixels please.

Performance note:

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

Syntax

bool dxSetTexturePixels( element texture, string pixels [, int x = 0, int y = 0, int width, int height ] )

Required Arguments

texture : The texture element to set the pixels of
pixels : The 'plain' format pixels to use

Optional Arguments

By default the pixels are set starting at the top left corner of the texture. To set a different region, 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 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 33: / Line 33: @@
 TODO
 </syntaxhighlight>
+==Requirements==
+{{Requirements|n/a|1.3|}}
 ==See Also==
 {{Drawing_functions}}