DxGetPixelsFormat: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "{{Client function}} __NOTOC__ This function returns the format of pixels contained in a string. ==Syntax== <syntaxhighlight lang="lua"> string format = dxGetPixelsFormat( s...")
 
(Remove obsolete Requirements section)
 
(9 intermediate revisions by 6 users not shown)
Line 5: Line 5:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
string format = dxGetPixelsFormat( string pixels )
string dxGetPixelsFormat ( string pixels )
</syntaxhighlight>  
</syntaxhighlight>  


Line 12: Line 12:


==Returns==
==Returns==
Returns the format of the pixels if successful, ''false'' if invalid arguments were passed to the function.
Returns the format of the pixels if successful (''''plain'''' or ''''png'''' or ''''jpeg'''' or ''''dds''''), ''false'' if invalid arguments were passed to the function.


==Example==  
==Example==  
The example loads an image, gets its pixels, and outputs the pixels format. (You can use [http://i1325.photobucket.com/albums/u630/Tourmalinelisa2/128x128.jpg this] image to test.)
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
TODO
addEventHandler('onClientResourceStart', resourceRoot, function()
  local img = fileOpen('img.jpg')
  local pixels = fileRead(img, fileGetSize(img))
  local pixelsFormat = dxGetPixelsFormat(pixels)
  outputChatBox('Pixels format is: ' .. pixelsFormat)
  fileClose(img)
end)
</syntaxhighlight>
</syntaxhighlight>


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

Latest revision as of 15:42, 7 November 2024

This function returns the format of pixels contained in a string.

Syntax

string dxGetPixelsFormat ( string pixels )

Required Arguments

  • pixels : The pixels to get the format of

Returns

Returns the format of the pixels if successful ('plain' or 'png' or 'jpeg' or 'dds'), false if invalid arguments were passed to the function.

Example

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

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

See Also