Difference between revisions of "DxSetTexturePixels"

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
Line 12: Line 12:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool dxSetTexturePixels( [ int surfaceIndex, ] element texture, string pixels [, int x = 0, int y = 0, int width, int height ] )
bool dxSetTexturePixels ( [ int surfaceIndex = 0, ] element texture, string pixels [, int x = 0, int y = 0, int width = 0, int height = 0 ] )
</syntaxhighlight>  
</syntaxhighlight>  



Revision as of 19:21, 20 September 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 ( [ int surfaceIndex = 0, ] element texture, string pixels [, int x = 0, int y = 0, int width = 0, int height = 0 ] )

Required Arguments

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

Optional Arguments

BETA: FROM VERSION 1.3 r4021 ONWARDS
  • surfaceIndex: Desired slice to set if the texture is a volume texture, or desired face to set if the texture is a cube map. (Cube map faces: 0=+X 1=-X 2=+Y 3=-Y 4=+Z 5=-Z)

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 supported server n/a
Minimum supported client 1.3

Note: Using this function/event 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" />

Changelog

Version Description
1.3.0-9.04021 Added surfaceIndex argument

See Also