DxGetTexturePixels
From Multi Theft Auto: Wiki
This function fetches the pixels from a texture element. It can be used with a standard texture, render target or screen source.
Performance note:
- This function is slow and not something you want to be doing once a frame.
- It is slower when reading pixels from a render target or screen source.
- And is very slow indeed if the texture format is not 'argb'
Syntax
Required Arguments
- texture : The texture element to get the pixels from
Optional Arguments
FROM VERSION 1.3 r4021 ONWARDS
- surfaceIndex: Desired slice to get if the texture is a volume texture, or desired face to get if the texture is a cube map. (Cube map faces: 0=+X 1=-X 2=+Y 3=-Y 4=+Z 5=-Z)
By default the pixels from the whole texture is returned. To get only a portion of the texture, define a rectangular area using all four of these optional arguments:
- x: Rectangle left position
- y: Rectangle top position
- width: Rectangle width
- height : Rectangle height
Returns
Returns a 'plain' format pixels string if successful, false if invalid arguments were passed to the function.
Example
TODO
Requirements
| Minimum supported server | n/a |
|---|---|
| Minimum supported client | 1.3 |
Changelog
| Version | Description |
|---|
| 1.3.0-9.04021 | Added surfaceIndex argument |
See Also
- dxDrawImage
- dxDrawImageSection
- dxDrawLine
- dxDrawLine3D
- dxDrawRectangle
- dxDrawText
- dxGetFontHeight
- dxGetTextWidth
- dxCreateFont
- dxCreateTexture
- dxCreateShader
- dxCreateRenderTarget
- dxCreateScreenSource
- dxGetMaterialSize
- dxSetShaderValue
- dxSetShaderTessellation
- dxSetShaderTransform
- dxSetRenderTarget
- dxUpdateScreenSource
- dxGetStatus
- dxSetTestMode
- dxGetTexturePixels
- dxSetTexturePixels
- dxGetPixelsSize
- dxGetPixelsFormat
- dxConvertPixels
- dxGetPixelColor
- dxSetPixelColor
FROM VERSION 1.3.1 ONWARDS