BufferedImage

Extends
Image
Methods
8
Fields
8

Getting one

BufferedImage.new(…)
ImageUtil.bufferedImageFromImage(…)
ImageUtil.toARGB(…)

Methods

MethodReturnsDescription
getType()numberThe image type it was made with: TYPE_INT_ARGB for every image Bento makes itself, and the type a PNG decodes to for a decoded one (`TYPE…
getRGB(number, number)numberThe pixel at (x, y) as a signed 32-bit ARGB int. Outside the image is an error ("Coordinate out of bounds!").
setRGB(number, number, number)()(BufferedImage, number, number, number) -> (): Set the pixel at (x, y) (an opaque type keeps alpha 0xff).
setRGB(number, number, number, number, {number}, number, number)()
getSubimage(number, number, number, number)BufferedImageThe w x h rectangle at (x, y), sharing this image's pixels: writes to either show in the other. Outside the image, or an empty size,…
createGraphics()Graphics2DA Graphics2D drawing into this image: each call draws at once. Dispose it when done (nothing leaks if not).
getGraphics()Graphics2DThe same as createGraphics().
isLoaded()booleanWhether the pixels are all there: an item image (ItemManager:getImage) is a blank AsyncBufferedImage until its sprite renders (`onLoade…
new(number, number, number)BufferedImageBufferedImage.new(width, height, imageType): transparent, or black for an opaque type. TYPE_INT_RGB, TYPE_INT_ARGB, the BGR and 4-byt…

Fields

FieldTypeDescription
TYPE_CUSTOMnumberBufferedImage.TYPE_CUSTOM.
TYPE_INT_RGBnumberBufferedImage.TYPE_INT_RGB.
TYPE_INT_ARGBnumberBufferedImage.TYPE_INT_ARGB.
TYPE_INT_ARGB_PREnumberBufferedImage.TYPE_INT_ARGB_PRE.
TYPE_INT_BGRnumberBufferedImage.TYPE_INT_BGR.
TYPE_3BYTE_BGRnumberBufferedImage.TYPE_3BYTE_BGR.
TYPE_4BYTE_ABGRnumberBufferedImage.TYPE_4BYTE_ABGR.
TYPE_4BYTE_ABGR_PREnumberBufferedImage.TYPE_4BYTE_ABGR_PRE.

Returned by

MethodReturnsDescription
BufferedImageClass.newBufferedImageBufferedImage.new(width, height, imageType): transparent, or black for an opaque type. TYPE_INT_RGB, TYPE_INT_ARGB, the BGR and 4-byt…
ChatIconManager.getRankImageBufferedImage?(ChatIconManager, FriendsChatRank) -> BufferedImage?: The friends chat rank's 11x11 icon, outlined (nil for UNRANKED, before the rank…
ImageUtilClass.alphaOffsetBufferedImage(Image, number) -> BufferedImage: offset added to alpha, clamped. The two overloads are told apart by the number: a whole number (50,…
ImageUtilClass.bufferedImageFromImageBufferedImageThe image itself: every Bento image is already a BufferedImage.
ImageUtilClass.fillImageBufferedImageEvery non-transparent pixel color.
ImageUtilClass.flipImageBufferedImageA mirrored copy.
ImageUtilClass.fromBytesBufferedImage?The image encoded in data (a byte string, e.g. an HTTP body or Asset.bytes), or nil when it is not one, with the type and samples `lo…
ImageUtilClass.grayscaleImageBufferedImageA greyed copy, as Swing's disabled icons (GrayFilter, brighter, 50%).
ImageUtilClass.loadImageResourceBufferedImage?An image resource: path resolved against the class c. A relative path with the plugin's own class (pass the plugin object, a panel, or…
ImageUtilClass.luminanceOffsetBufferedImageoffset added to red, green and blue, clamped.
ImageUtilClass.luminanceScaleBufferedImageRed, green and blue scaled by percentage, clamped.
ImageUtilClass.outlineImageBufferedImage(BufferedImage, Color) -> BufferedImage: The image with a one-pixel color outline, corners left out.
ImageUtilClass.recolorImageBufferedImageEvery pixel color, keeping its alpha.
ImageUtilClass.resizeCanvasBufferedImageThe image centred on a transparent canvas of the given size.
ImageUtilClass.resizeImageBufferedImage(BufferedImage, number, number) -> BufferedImage: A smoothly scaled (area-averaged) copy of the given size.
ImageUtilClass.rotateImageBufferedImageThe image rotated theta radians about its centre, on a canvas the size of its rotated bounds, of the image's type when that has alpha (`T…
ImageUtilClass.toARGBBufferedImageThe image itself when its type is TYPE_INT_ARGB, else a TYPE_INT_ARGB image it is drawn into (a decoded PNG, a premultiplied or 4-byte…
InfoBox.getImageBufferedImage?The image.
ItemManager.getItemOutlineBufferedImageThe outline of the item's icon in outlineColor (`createItemSprite(itemId, itemQuantity, 1, 0, 0, false, CLIENT_DEFAULT_ZOOM).toBufferedOu…
NavigationButton.getIcon(BufferedImage | string)?The image or PNG bytes the rail draws.
SkillIconManager.getSkillImageBufferedImage(SkillIconManager, Skill, boolean) -> BufferedImage: skill's icon, small (16x16) or large (25x25 and the like). The same skill and size…
SpriteManager.getSpriteBufferedImage?Frame file of sprite archive (a SpriteID), as an image of its stored size, or nil while the client cannot read it (before the login…
SpritePixels.toBufferedImageBufferedImageA new getWidth() x getHeight() image of the pixels, every non-zero pixel ORed opaque (a drawn black reads 0xff000001).
SpritePixels.toBufferedOutlineBufferedImageA new image of the sprite's outline in color: each pixel that is 0 or 0xffffff beside a non-zero one becomes color, every other pix…
WorldMapPoint.getImageBufferedImage?The image drawn at the point (nil: nothing is drawn). Override it to draw another.

Method details

getType

getType: (BufferedImage) -> number

The image type it was made with: TYPE_INT_ARGB for every image Bento makes itself, and the type a PNG decodes to for a decoded one (TYPE_4BYTE_ABGR for RGBA, TYPE_CUSTOM for grey and alpha).

getRGB

getRGB: (BufferedImage, number, number) -> number

The pixel at (x, y) as a signed 32-bit ARGB int. Outside the image is an error ("Coordinate out of bounds!").

setRGB

setRGB: ((BufferedImage, number, number, number) -> ()) & ((BufferedImage, number, number, number, number, {number}, number, number) -> ())

(BufferedImage, number, number, number) -> (): Set the pixel at (x, y) (an opaque type keeps alpha 0xff).

(BufferedImage, number, number, number, number, {number}, number, number) -> (): Set a w x h block from rgbArray: the pixel at (startX + i, startY + j) is rgbArray[offset + j * scansize + i], offset counting from 0 (element 1 of a Luau array is offset 0).

getSubimage

getSubimage: (BufferedImage, number, number, number, number) -> BufferedImage

The w x h rectangle at (x, y), sharing this image's pixels: writes to either show in the other. Outside the image, or an empty size, is an error.

isLoaded

isLoaded: (BufferedImage) -> boolean

Whether the pixels are all there: an item image (ItemManager:getImage) is a blank AsyncBufferedImage until its sprite renders (onLoaded waits for it); every other image always is.

new

new: (number, number, number) -> BufferedImage

BufferedImage.new(width, height, imageType): transparent, or black for an opaque type. TYPE_INT_RGB, TYPE_INT_ARGB, the BGR and 4-byte ABGR types and the premultiplied ones are stored; the packed grey, 565/555, binary and indexed types are an error.