DxSetTexturePixels: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(Remove obsolete Requirements section)
 
(4 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Client function}}
{{Client function}}
{{Needs_Example}}
__NOTOC__
__NOTOC__
This function sets the [[Texture_pixels|pixels]] of a [[texture]] element. It can be used with a standard texture, render target or screen source. Only ''''plain'''' format pixels please.
This function sets the [[Texture_pixels|pixels]] of a [[texture]] element. It can be used with a standard texture, render target or screen source. Only ''''plain'''' format pixels please.


----
{{Note|
''Performance note:
* This function is slow and not something you want to be doing once a frame.
*''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.
*''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"'''.
*''And is very slow indeed if the texture format is not ''' 'argb' ''' ''
}}
----


==Syntax==  
==Syntax==  
Line 14: Line 14:
bool dxSetTexturePixels ( [ int surfaceIndex = 0, ] element texture, string pixels [, int x = 0, int y = 0, int width = 0, int height = 0 ] )
bool dxSetTexturePixels ( [ int surfaceIndex = 0, ] element texture, string pixels [, int x = 0, int y = 0, int width = 0, int height = 0 ] )
</syntaxhighlight>  
</syntaxhighlight>  
 
{{OOP||[[texture]]:setPixels}}
===Required Arguments===
===Required Arguments===
*'''texture :''' The texture element to set the pixels of
*'''texture :''' The texture element to set the pixels of
Line 20: Line 20:


===Optional Arguments===
===Optional Arguments===
{{New feature/item|4.0130|1.3|4021|
*'''surfaceIndex:''' Desired slice to set if the texture is a volume texture, or desired face to set if the texture is a cube map. <nowiki>(Cube map faces: 0=+X 1=-X 2=+Y 3=-Y 4=+Z 5=-Z)</nowiki>
*'''surfaceIndex:''' Desired slice to set if the texture is a volume texture, or desired face to set if the texture is a cube map. <nowiki>(Cube map faces: 0=+X 1=-X 2=+Y 3=-Y 4=+Z 5=-Z)</nowiki>
}}
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:
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
*'''x:''' Rectangle left position
Line 36: Line 34:
TODO
TODO
</syntaxhighlight>
</syntaxhighlight>
==Requirements==
{{Requirements|n/a|1.3|}}


==Changelog==
==Changelog==
Line 46: Line 41:
==See Also==
==See Also==
{{Drawing_functions}}
{{Drawing_functions}}
[[Category:Needs Example]]

Latest revision as of 15:41, 7 November 2024

Accessories-text-editor.png Script Example Missing Function DxSetTexturePixels needs a script example, help out by writing one.
Before submitting check out Editing Guidelines Script Examples.


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.

[[{{{image}}}|link=|]] 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 ] )

OOP Syntax Help! I don't understand this!

Method: texture:setPixels(...)


Required Arguments

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

Optional Arguments

  • 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

Changelog

Version Description
1.3.0-9.04021 Added surfaceIndex argument

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/DxSetTexturePixels?oldid=81058"