GitHub/Basalt
1
0
Fork 0
Code Issues 28 Pull Requests 3 Actions Packages Projects Releases 9 Wiki Activity

Updated image docs

Browse Source
This commit is contained in:
Robert Jelic
2022-12-24 11:48:35 +01:00
parent 91e42e096c
commit 6d2956f3bf
9 changed files with 117 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/objects/Image.md
View File

@@ -1,12 +1,18 @@
The image object is for adding more advanced backgrounds.
It also provides a :shrink() function, where you can shrink the images to smaller ones. This functionallity is fully provided by the blittle library created by Bomb Bloke. I did not ask for permission to add it into the framework. If the creator wants me to remove the blittle part, just text me on discord!
The image object is still not done. in the future i will provide more image formats.
The image object is for adding more advanced backgrounds to your interface. It supports the loading of .nfp and .bimg images.
[Object](objects/Object.md) methods also apply for images.
| | |
|---|---|
|[loadImage](objects/Image/loadImage.md)|Adds a new object
|[shrink](objects/Image/shrink.md)|Sets the top bar text and colors - deprecated
|[loadImage](objects/Image/loadImage.md)|Loads an image from the specified file path
|[setImage](objects/Image/setImage.md)|Set's a new image
|[usePalette](objects/Image/usePalette.md)|Changes the used palette to the image prefered palette
|[play](objects/Image/play.md)|Plays an animated image
|[selectFrame](objects/Image/selectFrame.md)|Selects a specific frame in an animated image
|[getMetadata](objects/Image/getMetadata.md)|Returns the metadata of the image
|[getImageSize](objects/Image/getImageSize.md)|Returns the width and height of the image
|[resizeImage](objects/Image/resizeImage.md)|Resizes the image to the specified dimensions
# About Bimg
Bimg is a custom image format that can be used in place of .nfp, it is a table which can store multiple frames and metadata. The frames can store text, background and foreground, which makes it possible to create any image you'd like. The image format is made by people from the Minecraft Computercraft Mods - Discord. Here's a Github page which explains how the Bimg format works: [bimg](https://github.com/SkyTheCodeMaster/bimg)