DxGetPixelsFormat

From Multi Theft Auto: Wiki
Jump to: navigation, search

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 supported server n/a
Minimum supported client 1.3
Note: Using this function 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