DxGetTexturePixels

From Multi Theft Auto: Wiki
Revision as of 01:40, 25 January 2012 by Ccw (talk | contribs)
Jump to navigation Jump to search

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

See Also