DxGetTexturePixels: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "{{Client function}} __NOTOC__ This function fetches the pixels from a texture element. It will work with a standard texture, render target or screen source...")
 
No edit summary
Line 1: Line 1:
{{Client function}}
{{Client function}}
__NOTOC__
__NOTOC__
This function fetches the [[Texture_pixels|pixels]] from a [[texture]] element. It will work with a standard texture, render target or screen source.
This function fetches the [[Texture_pixels|pixels]] from a [[texture]] element. It can be used with a standard texture, render target or screen source.


==Syntax==  
==Syntax==  
Line 19: Line 19:


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


==Example==  
==Example==  

Revision as of 01:34, 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.

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