DxGetPixelColor: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(Remove obsolete Requirements section)
 
(6 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Client function}}
{{Client function}}
{{Needs_Example}}
__NOTOC__
__NOTOC__
This function gets the color of a single pixel from [[Texture_pixels|pixels]] contained in a string. It only works with ''''plain'''' format pixels.
This function gets the color of a single pixel from [[Texture_pixels|pixels]] contained in a string. It only works with ''''plain'''' format pixels.
Line 6: Line 5:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
int r,g,b,a dxGetPixelColor( string pixels, int x, int y )
int, int, int, int dxGetPixelColor( string pixels, int x, int y )
</syntaxhighlight>  
</syntaxhighlight>  


Line 15: Line 14:


==Returns==
==Returns==
Returns the color of pixel if successful, or ''false'' if invalid arguments were passed to the function.
Returns 4 ''int''s representing the rgba color value of the pixel if succesful, or ''false'' if invalid arguments were passed to the function.


==Example==  
==Example==  
Line 21: Line 20:
local texture = dxCreateTexture(4,4)        --Create a texture
local texture = dxCreateTexture(4,4)        --Create a texture
local pixel = dxGetTexturePixels(texture)  --Get pixel element
local pixel = dxGetTexturePixels(texture)  --Get pixel element
local sx,sy = dxGetPixelSize(pixel)            --Get pixel size
local sx,sy = dxGetPixelsSize(pixel)            --Get pixel size
local tab = {}                                          --Define a table
local tab = {}                                          --Define a table
for i=0,sx-1 do                                        --From 0th pixel to 3th pixel in width
for i=0,sx-1 do                                        --From 0th pixel to 3th pixel in width
     tab[i+1] = {}                                        --Define a table
     tab[i+1] = {}                                        --Define a table
     for j=0,sy-1 do                                    --From 0th pixel to 3th pixel in height
     for j=0,sy-1 do                                    --From 0th pixel to 3th pixel in height
      tab[i+1][j+1] = dxGetPixelColor(pixel,i,j) --Get pixel color and save it in the table
        local r,g,b,a = dxGetPixelColor(pixel,i,j) --Get pixel color
        tab[i+1][j+1] = {r,g,b,a}                      --Save the color in the table
     end
     end
end
end
</syntaxhighlight>
</syntaxhighlight>
==Requirements==
{{Requirements|n/a|1.3|}}


==See Also==
==See Also==
{{Drawing_functions}}
{{Drawing_functions}}
[[hu:dxGetPixelColor]]

Latest revision as of 15:42, 7 November 2024

This function gets the color of a single pixel from pixels contained in a string. It only works with 'plain' format pixels.

Syntax

int, int, int, int dxGetPixelColor( string pixels, int x, int y )

Required Arguments

  • pixels : The pixels to use
  • x: The X coordinate for the pixel
  • y: The Y coordinate for the pixel

Returns

Returns 4 ints representing the rgba color value of the pixel if succesful, or false if invalid arguments were passed to the function.

Example

local texture = dxCreateTexture(4,4)        --Create a texture
local pixel = dxGetTexturePixels(texture)  --Get pixel element
local sx,sy = dxGetPixelsSize(pixel)             --Get pixel size
local tab = {}                                           --Define a table
for i=0,sx-1 do                                         --From 0th pixel to 3th pixel in width
    tab[i+1] = {}                                         --Define a table
    for j=0,sy-1 do                                     --From 0th pixel to 3th pixel in height
        local r,g,b,a = dxGetPixelColor(pixel,i,j) --Get pixel color
        tab[i+1][j+1] = {r,g,b,a}                      --Save the color in the table
    end
end

See Also