DxGetPixelsFormat: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
m (No point of the section as it's already a client function)
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 format. (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 format. (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==

Revision as of 18:26, 28 September 2013

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'), 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)

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


Retrieved from "https://wiki.multitheftauto.com/wiki/DxGetPixelsFormat?oldid=37235"