DxGetPixelsFormat: Difference between revisions

Revision as of 21:38, 27 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

Click to collapse [-]

Client

The example loads an image, gets its pixels, and outputs the pixels format.

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" />

@@ Line 15: / Line 15: @@
 ==Example==
+<section name="Client" class="client" show="true">
+The example loads an image, gets its pixels, and outputs the pixels format.
 <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>
+</section>
 ==Requirements==
@@ Line 24: / Line 33: @@
 ==See Also==
 {{Drawing_functions}}
-[[Category:Needs Example]]