DxGetTexturePixels - Revision history

Fernando187: Remove obsolete Requirements section

2024-11-07T15:41:48Z

Remove obsolete Requirements section

← Older revision		Revision as of 15:41, 7 November 2024
Line 43:		Line 43:
	outputChatBox("MTA logo pixels is: "..dxGetTexturePixels(mtaLogo))		outputChatBox("MTA logo pixels is: "..dxGetTexturePixels(mtaLogo))
	</syntaxhighlight>		</syntaxhighlight>

	~~==Requirements==~~
	~~{{Requirements\|n/a\|1.3\|}}~~

	==Changelog==		==Changelog==

Nico834: Correction of an incorrectly worded important note

2024-04-30T16:52:33Z

Correction of an incorrectly worded important note

← Older revision		Revision as of 16:52, 30 April 2024
Line 2:		Line 2:
	__NOTOC__		__NOTOC__
	This function fetches the [[Texture_pixels\|pixels]] from a [[texture]] element. It can be used 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.
	{{Important Note\|~~dxGetTexturePixels will~~ not ~~work on a~~ screen ~~source or render target if~~ the ~~player has disabled screen upload~~.}}		{{Important Note\|If the user has not enabled screen uploading in the settings, the function will use a 32x32 empty texture as a basis.}}
	{{Note\|		{{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.

Samr46 at 14:47, 29 August 2023

2023-08-29T14:47:19Z

← Older revision		Revision as of 14:47, 29 August 2023
Line 6:		Line 6:
	*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 slower when reading pixels from a render target or screen source.		*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' '''.		*And is very slow indeed if the texture format is not ''' 'argb' ''' (unless the native ''''dds'''' format is used with correct options).
	}}		}}

Samr46: Move dds pixels arguments to proper position

2023-08-29T14:35:45Z

Move dds pixels arguments to proper position

← Older revision		Revision as of 14:35, 29 August 2023
Line 18:		Line 18:

	===Optional Arguments===		===Optional Arguments===
			*'''surfaceIndex:''' Desired slice to get if the texture is a volume texture, or desired face to get if the texture is a cube map. <nowiki>(Cube map faces: 0=+X 1=-X 2=+Y 3=-Y 4=+Z 5=-Z)</nowiki>
	{{New feature/item\|3.0161\|1.6.0\|22185\|		{{New feature/item\|3.0161\|1.6.0\|22185\|
	*'''pixelsFormat:''' "plain", "dds"		*'''pixelsFormat:''' "plain", "dds"
Line 28:		Line 29:
	*'''mipmaps:''' True to create a mip-map chain for "'''dds'''" pixels so the texture looks good when drawn at various sizes.		*'''mipmaps:''' True to create a mip-map chain for "'''dds'''" pixels so the texture looks good when drawn at various sizes.
	}}		}}
	*'''surfaceIndex:''' Desired slice to get if the texture is a volume texture, or desired face to get 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 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:		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		*'''x:''' Rectangle left position

Samr46: Add dds pixels format

2023-08-29T14:32:03Z

Add dds pixels format

← Older revision		Revision as of 14:32, 29 August 2023
Line 11:		Line 11:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	string dxGetTexturePixels ( [ int surfaceIndex = 0, ] element texture [, int x = 0, int y = 0, int width = 0, int height = 0 ] )		string dxGetTexturePixels ( [ int surfaceIndex = 0, ] element texture [, string pixelsFormat = "plain" [, string textureFormat = "unknown"] [, bool mipmaps = true] ] [, int x = 0, int y = 0, int width = 0, int height = 0 ] )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|\|[[texture]]:getPixels}}		{{OOP\|\|[[texture]]:getPixels}}
Line 18:		Line 18:

	===Optional Arguments===		===Optional Arguments===
			{{New feature/item\|3.0161\|1.6.0\|22185\|
			*'''pixelsFormat:''' "plain", "dds"
			*'''textureFormat:''' A string representing the desired texture format for "'''dds'''" pixels, which can be one of:
			**'''"unknown"''': Determined automatically based on texture format (default).
			**'''"argb"''': ARGB uncompressed 32 bit color.
			**'''"dxt1"''': DXT1 compressed - Can take a fraction of a second longer to create (unless the texture is already in DXT1). Uses 8 times less video memory than ARGB and ''can speed up drawing''. Quality not as good as ARGB. ''It supports alpha blending, but it can only be on or off, that is: either 0 or 255.''
			**'''"dxt3"''': DXT3 compressed - Can take a fraction of a second longer to create (unless the texture is already in DXT3). Uses 4 times less video memory than ARGB and ''can speed up drawing''. Quality slightly better than DXT1 and supports crisp alpha blending.
			**'''"dxt5"''': DXT5 compressed - Can take a fraction of a second longer to create (unless the texture is already in DXT5). Uses 4 times less video memory than ARGB and ''can speed up drawing''. Quality slightly better than DXT1 and supports smooth alpha blending.
			*'''mipmaps:''' True to create a mip-map chain for "'''dds'''" pixels so the texture looks good when drawn at various sizes.
			}}
	*'''surfaceIndex:''' Desired slice to get if the texture is a volume texture, or desired face to get 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 get if the texture is a volume texture, or desired face to get 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 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:		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:
Line 26:		Line 36:

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

	==Example==		==Example==
Line 40:		Line 50:
	{{ChangelogHeader}}		{{ChangelogHeader}}
	{{ChangelogItem\|1.3.0-9.04021\|Added surfaceIndex argument}}		{{ChangelogItem\|1.3.0-9.04021\|Added surfaceIndex argument}}
			{{ChangelogItem\|1.6.0-9.22185\|Added dds pixels format}}

	==See Also==		==See Also==

Surge at 10:15, 30 November 2018

2018-11-30T10:15:25Z

← Older revision		Revision as of 10:15, 30 November 2018
Line 43:		Line 43:
	==See Also==		==See Also==
	{{Drawing_functions}}		{{Drawing_functions}}

			[[hu:dxGetTexturePixels]]

Lexr128 at 10:58, 14 April 2018

2018-04-14T10:58:18Z

← Older revision		Revision as of 10:58, 14 April 2018
Line 2:		Line 2:
	__NOTOC__		__NOTOC__
	This function fetches the [[Texture_pixels\|pixels]] from a [[texture]] element. It can be used 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.
	{{Note\|dxGetTexturePixels will not work on a screen source or render target if the player has disabled screen upload.}}		{{Important Note\|dxGetTexturePixels will not work on a screen source or render target if the player has disabled screen upload.}}
	~~----~~		{{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 slower when reading pixels from a render target or screen source.
	*''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' '''.
	*''And is very slow indeed if the texture format is not ''' 'argb' ''' ''		}}
	~~----~~

	==Syntax==		==Syntax==

ThePiotrek: Example

2016-10-09T14:17:55Z

Example

← Older revision		Revision as of 14:17, 9 October 2016
Line 1:		Line 1:
	{{Client function}}		{{Client function}}
	~~{{Needs_Example}}~~
	__NOTOC__		__NOTOC__
	This function fetches the [[Texture_pixels\|pixels]] from a [[texture]] element. It can be used 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.
Line 32:		Line 31:
	==Example==		==Example==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~TODO~~		local mtaLogo = dxCreateTexture("mta-logo.png")
			outputChatBox("MTA logo pixels is: "..dxGetTexturePixels(mtaLogo))
	</syntaxhighlight>		</syntaxhighlight>

Strix: add oop syntax

2015-01-02T19:50:30Z

add oop syntax

← Older revision		Revision as of 19:50, 2 January 2015
Line 15:		Line 15:
	string dxGetTexturePixels ( [ int surfaceIndex = 0, ] element texture [, int x = 0, int y = 0, int width = 0, int height = 0 ] )		string dxGetTexturePixels ( [ int surfaceIndex = 0, ] element texture [, int x = 0, int y = 0, int width = 0, int height = 0 ] )
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\|\|[[texture]]:getPixels}}
	===Required Arguments===		===Required Arguments===
	*'''texture :''' The texture element to get the pixels from		*'''texture :''' The texture element to get the pixels from

Ccw at 22:11, 8 March 2014

2014-03-08T22:11:17Z

← Older revision		Revision as of 22:11, 8 March 2014
Line 3:		Line 3:
	__NOTOC__		__NOTOC__
	This function fetches the [[Texture_pixels\|pixels]] from a [[texture]] element. It can be used 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.
			{{Note\|dxGetTexturePixels will not work on a screen source or render target if the player has disabled screen upload.}}
	----		----
	''Performance note:		''Performance note: