DxSetTexturePixels: Difference between revisions

Latest revision as of 15:41, 7 November 2024

	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

@@ Line 1: / Line 1: @@
 {{Client function}}
+{{Needs_Example}}
 __NOTOC__
-This function set the [[Texture_pixels|pixels]] of a [[texture]] element. It will work with a standard texture, render target or screen source.
+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|
+* 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==
 <syntaxhighlight lang="lua">
-bool dxSetTexturePixels( 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>
+{{OOP||[[texture]]:setPixels}}
 ===Required Arguments===
 *'''texture :''' The texture element to set the pixels of
-*'''pixels :''' The pixels to use
+*'''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. <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:
 *'''x:''' Rectangle left position
@@ Line 26: / Line 34: @@
 TODO
 </syntaxhighlight>
+==Changelog==
+{{ChangelogHeader}}
+{{ChangelogItem|1.3.0-9.04021|Added surfaceIndex argument}}
 ==See Also==
 {{Drawing_functions}}