DxGetTexturePixels: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
(Remove obsolete Requirements section)
 
(9 intermediate revisions by 7 users not shown)
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.
 
{{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|
''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' ''' (unless the native ''''dds'''' format is used with correct options).
*''And is very slow indeed if the texture format is not ''' 'argb' ''' ''
}}
----


==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}}
===Required Arguments===
===Required Arguments===
*'''texture :''' The texture element to get the pixels from
*'''texture :''' The texture element to get the pixels from
Line 21: Line 19:
===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>
*'''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|
*'''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.
}}
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
Line 28: 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==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
TODO
local mtaLogo = dxCreateTexture("mta-logo.png")
outputChatBox("MTA logo pixels is: "..dxGetTexturePixels(mtaLogo))
</syntaxhighlight>
</syntaxhighlight>
==Requirements==
{{Requirements|n/a|1.3|}}


==Changelog==
==Changelog==
{{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==
{{Drawing_functions}}
{{Drawing_functions}}
[[hu:dxGetTexturePixels]]

Latest revision as of 15:41, 7 November 2024

This function fetches the pixels from a texture element. It can be used with a standard texture, render target or screen source.

[[{{{image}}}|link=|]] Important Note: If the user has not enabled screen uploading in the settings, the function will use a 32x32 empty texture as a basis.
[[{{{image}}}|link=|]] Note:
  • 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.
  • And is very slow indeed if the texture format is not 'argb' (unless the native 'dds' format is used with correct options).

Syntax

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 ] )

OOP Syntax Help! I don't understand this!

Method: texture:getPixels(...)


Required Arguments

  • texture : The texture element to get the pixels from

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. (Cube map faces: 0=+X 1=-X 2=+Y 3=-Y 4=+Z 5=-Z)
ADDED/UPDATED IN VERSION 1.6.0 r22185:
  • 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.

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 pixels string if successful, false if invalid arguments were passed to the function.

Example

local mtaLogo = dxCreateTexture("mta-logo.png")
outputChatBox("MTA logo pixels is: "..dxGetTexturePixels(mtaLogo))

Changelog

Version Description
1.3.0-9.04021 Added surfaceIndex argument
1.6.0-9.22185 Added dds pixels format

See Also

Retrieved from "https://wiki.multitheftauto.com/wiki/DxGetTexturePixels?oldid=81057"