DxGetPixelsSize: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
 
(3 intermediate revisions by 3 users not shown)
Line 5: Line 5:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
int int dxGetPixelsSize ( string pixels )
int, int dxGetPixelsSize ( string pixels )
</syntaxhighlight>  
</syntaxhighlight>  


===Required Arguments===
===Required Arguments===
*'''pixels :''' The pixels to get the dimensions of
*'''pixels:''' The pixels to get the dimensions of


==Returns==
==Returns==
Line 15: Line 15:


==Example==  
==Example==  
<section name="Client" class="client" show="true">
The example loads an image, gets its pixels, and outputs the pixels size. (You can use [http://i1325.photobucket.com/albums/u630/Tourmalinelisa2/128x128.jpg this] image to test.)
The example loads an image, gets its pixels, and outputs the pixels size. (You can use [http://i1325.photobucket.com/albums/u630/Tourmalinelisa2/128x128.jpg this] image to test.)
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
Line 26: Line 25:
end)
end)
</syntaxhighlight>
</syntaxhighlight>
</section>


==Requirements==
==Requirements==
Line 33: Line 31:
==See Also==
==See Also==
{{Drawing_functions}}
{{Drawing_functions}}
[[hu:dxGetPixelsSize]]

Latest revision as of 08:53, 8 February 2021

This function gets the dimensions of pixels contained in a string. It works with all pixel formats.

Syntax

int, int dxGetPixelsSize ( string pixels )

Required Arguments

  • pixels: The pixels to get the dimensions of

Returns

Returns width and height of the pixels if successful, false if invalid arguments were passed to the function.

Example

The example loads an image, gets its pixels, and outputs the pixels size. (You can use this image to test.)

addEventHandler('onClientResourceStart', resourceRoot, function()
  local img = fileOpen('img.jpg')
  local pixels = fileRead(img, fileGetSize(img))
  local size = dxGetPixelsSize(pixels)
  outputChatBox('Pixels size is: ' .. size)
  fileClose(img)
end)

Requirements

Minimum server version n/a
Minimum client version 1.3

Note: Using this feature requires the resource to have the above minimum version declared in the meta.xml <min_mta_version> section. e.g. <min_mta_version client="1.3" />

See Also