DxGetPixelsFormat: Difference between revisions

Latest revision as of 14:19, 29 August 2023

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)

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 12: / Line 12: @@
 ==Returns==
-Returns the format of the pixels if successful (''''plain'''' or ''''png'''' or ''''jpeg''''), ''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==
@@ Line 31: / Line 31: @@
 ==See Also==
 {{Drawing_functions}}
+[[hu:dxGetPixelsFormat]]