25 lines
865 B
Markdown
25 lines
865 B
Markdown
## getShrinkedImage
|
|
|
|
### Description
|
|
|
|
The getShrinkedImage method generates a Blit-Image version of a standard Image object and returns it as a table. By using this method, the resulting image will only retain the background (BG) data, and both foreground (FG) and text information will be lost.
|
|
|
|
Shrinking the image is calculated by pixelbox, a algorithm created by 9551Dev. You can find his awesome work [here](https://github.com/9551-Dev/apis/blob/main/pixelbox_lite.lua)!
|
|
|
|
### Returns
|
|
|
|
1. `table` A table representing the Blit-Image version of the Image object, containing only the background data.
|
|
|
|
### Usage
|
|
|
|
* Creates a default image and loads a test.nfp file
|
|
|
|
```lua
|
|
local basalt = require("basalt")
|
|
|
|
local mainFrame = basalt.createFrame()
|
|
local image = mainFrame:addImage:loadImage("path/to/your/image.nfp")
|
|
|
|
local blitImage = image:getShrinkedImage()
|
|
```
|