DxGetTexturePixels
Jump to navigation
Jump to search
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
string dxGetTexturePixels( [ int surfaceIndex, ] element texture [, int x, int y, int width, int height ] )
Required Arguments
- texture : The texture element to get the pixels from
Optional Arguments
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
This template will be deleted.
Changelog
| Version | Description |
|---|
| 1.3.0-9.04021 | Added surfaceIndex argument |
See Also
- dxConvertPixels
- dxCreateFont
- dxCreateRenderTarget
- dxCreateScreenSource
- dxCreateShader
- dxCreateTexture
- dxDrawCircle
- dxDrawImage
- dxDrawImageSection
- dxDrawLine
- dxDrawLine3D
- dxDrawMaterialLine3D
- dxDrawMaterialPrimitive
- dxDrawMaterialPrimitive3D
- dxDrawMaterialSectionLine3D
- dxDrawPrimitive
- dxDrawPrimitive3D
- dxDrawRectangle
- dxDrawText
- dxDrawWiredSphere
- dxGetBlendMode
- dxGetFontHeight
- dxGetMaterialSize
- dxGetPixelColor
- dxGetPixelsSize
- dxGetPixelsFormat
- dxGetStatus
- dxGetTextSize
- dxGetTextWidth
- dxGetTexturePixels
- dxIsAspectRatioAdjustmentEnabled
- dxSetAspectRatioAdjustmentEnabled
- dxSetBlendMode
- dxSetPixelColor
- dxSetRenderTarget
- dxSetShaderValue
- dxSetShaderTessellation
- dxSetShaderTransform
- dxSetTestMode
- dxSetTextureEdge
- dxSetTexturePixels
- dxUpdateScreenSource