Kinemium Docs
Instances

EditableImage

A mutable Argon/Skia image that can be drawn onto and modified at runtime.

Properties

PropertyTypeDefault
SizeVector2Vector2.new(1024, 1024)
Namestring"EditableImage"

Functions

`byte`

`rgba`

`dimensions`

`destroySurface`

`createSurface`

`surfacePixels`

`getPixelBytes`

`setPixelBytes`

`blendPixel`

`snapshot`

`replaceFromBuffer`

`instance:DrawCircle`

`instance:DrawCircleLines`

`instance:DrawRectangle`

`instance:DrawRectangleLines`

`instance:DrawRectangleOutline`

`instance:DrawLine`

`instance:DrawLineEx`

`instance:DrawTriangle`

`instance:DrawTriangleEx`

`instance:DrawTriangleLines`

`instance:DrawText`

`instance:DrawTextEx`

`instance:ReadPixelsBuffer`

`instance:WritePixelsBuffer`

`instance:SetPixelColor`

`instance:GetPixelColor`

`instance:Clear`

`instance:DrawImage`

`instance:DrawImageTransformed`

`instance:DrawImageProjected`

`remapPixels`

`instance:Resize`

`instance:Crop`

`instance:FlipHorizontal`

`instance:FlipVertical`

`instance:Flip`

`instance:Rotate`

`filterPixels`

`instance:ApplyGrayscale`

`instance:ApplyInvert`

`instance:ApplyContrast`

`instance:ApplyBrightness`

`instance:ColorReplace`

`instance:Blur`

`instance:Sharpen`

`instance:DrawGradient`

`instance:AlphaMask`

`instance:GetImageAlphaBorder`

`instance:AlphaCrop`

`instance:AlphaClear`

`instance:AlphaPremultiply`

`instance:Dither`

`quantize`

`instance:ExportToFile`

`instance:GetDimensions`

`instance:GetArea`

`instance:IsDirty`

`instance:MarkDirty`

`instance:ClearDirty`

byte

Arguments

value

Returns

This function returns nothing.

rgba

Arguments

color, transparency

Returns

This function returns nothing.

dimensions

Arguments

value

Returns

This function returns nothing.

destroySurface

Arguments

This function takes no arguments.

Returns

This function returns nothing.

createSurface

Arguments

size

Returns

This function returns nothing.

surfacePixels

Arguments

This function takes no arguments.

Returns

This function returns nothing.

getPixelBytes

Arguments

x, y

Returns

This function returns nothing.

setPixelBytes

Arguments

x, y, r, g, b, a

Returns

This function returns nothing.

blendPixel

Arguments

x, y, r, g, b, a

Returns

This function returns nothing.

snapshot

Arguments

This function takes no arguments.

Returns

This function returns nothing.

replaceFromBuffer

Arguments

width, height, data

Returns

This function returns nothing.

instance:DrawCircle

Arguments

center, radius, color, transparency, _combineType

Returns

This function returns nothing.

instance:DrawCircleLines

Arguments

center, radius, color, transparency

Returns

This function returns nothing.

instance:DrawRectangle

Arguments

position, size, color, transparency, _combineType

Returns

This function returns nothing.

instance:DrawRectangleLines

Arguments

position, size, thickness, color, transparency

Returns

This function returns nothing.

instance:DrawRectangleOutline

Arguments

position, size, color, transparency, thickness

Returns

This function returns nothing.

instance:DrawLine

Arguments

from, to, color, transparency, _combineType

Returns

This function returns nothing.

instance:DrawLineEx

Arguments

from, to, thickness, color, transparency

Returns

This function returns nothing.

instance:DrawTriangle

Arguments

v1, v2, v3, color, transparency

Returns

This function returns nothing.

instance:DrawTriangleEx

Arguments

v1, v2, v3, color1, color2, color3, transparency

Returns

This function returns nothing.

instance:DrawTriangleLines

Arguments

v1, v2, v3, color, transparency

Returns

This function returns nothing.

instance:DrawText

Arguments

text, position, fontSize, color, transparency

Returns

This function returns nothing.

instance:DrawTextEx

Arguments

font, text, position, fontSize, _spacing, color, transparency

Returns

This function returns nothing.

instance:ReadPixelsBuffer

Arguments

position, size

Returns

This function returns nothing.

instance:WritePixelsBuffer

Arguments

position, size, data

Returns

This function returns nothing.

instance:SetPixelColor

Arguments

position, color, transparency

Returns

This function returns nothing.

instance:GetPixelColor

Arguments

position

Returns

This function returns nothing.

instance:Clear

Arguments

color, transparency

Returns

This function returns nothing.

instance:DrawImage

Arguments

position, image, _combineType

Returns

This function returns nothing.

instance:DrawImageTransformed

Arguments

position, scale, rotation, image, _options

Returns

This function returns nothing.

instance:DrawImageProjected

Arguments

mesh, _projection, brushConfig

Returns

This function returns nothing.

remapPixels

Arguments

self, width, height, mapper

Returns

This function returns nothing.

instance:Resize

Arguments

newSize

Returns

This function returns nothing.

instance:Crop

Arguments

position, size

Returns

This function returns nothing.

instance:FlipHorizontal

Arguments

This function takes no arguments.

Returns

This function returns nothing.

instance:FlipVertical

Arguments

This function takes no arguments.

Returns

This function returns nothing.

instance:Flip

Arguments

horizontal, vertical

Returns

This function returns nothing.

instance:Rotate

Arguments

angle

Returns

This function returns nothing.

filterPixels

Arguments

self, transform

Returns

This function returns nothing.

instance:ApplyGrayscale

Arguments

This function takes no arguments.

Returns

This function returns nothing.

instance:ApplyInvert

Arguments

This function takes no arguments.

Returns

This function returns nothing.

instance:ApplyContrast

Arguments

contrast

Returns

This function returns nothing.

instance:ApplyBrightness

Arguments

brightness

Returns

This function returns nothing.

instance:ColorReplace

Arguments

oldColor, newColor

Returns

This function returns nothing.

instance:Blur

Arguments

strength

Returns

This function returns nothing.

instance:Sharpen

Arguments

This function takes no arguments.

Returns

This function returns nothing.

instance:DrawGradient

Arguments

fromPosition, toPosition, color1, color2, transparency

Returns

This function returns nothing.

instance:AlphaMask

Arguments

mask

Returns

This function returns nothing.

instance:GetImageAlphaBorder

Arguments

This function takes no arguments.

Returns

This function returns nothing.

instance:AlphaCrop

Arguments

alphaThreshold

Returns

This function returns nothing.

instance:AlphaClear

Arguments

color, transparency

Returns

This function returns nothing.

instance:AlphaPremultiply

Arguments

This function takes no arguments.

Returns

This function returns nothing.

instance:Dither

Arguments

rBits, gBits, bBits, aBits

Returns

This function returns nothing.

quantize

Arguments

value, bits

Returns

This function returns nothing.

instance:ExportToFile

Arguments

_filepath

Returns

This function returns nothing.

instance:GetDimensions

Arguments

This function takes no arguments.

Returns

This function returns nothing.

instance:GetArea

Arguments

This function takes no arguments.

Returns

This function returns nothing.

instance:IsDirty

Arguments

This function takes no arguments.

Returns

This function returns nothing.

instance:MarkDirty

Arguments

This function takes no arguments.

Returns

This function returns nothing.

instance:ClearDirty

Arguments

This function takes no arguments.

Returns

This function returns nothing.

API

instance:byte(value)
instance:rgba(color, transparency)
instance:dimensions(value)
instance:destroySurface()
instance:createSurface(size)
instance:surfacePixels()
instance:getPixelBytes(x, y)
instance:setPixelBytes(x, y, r, g, b, a)
instance:blendPixel(x, y, r, g, b, a)
instance:snapshot()
instance:replaceFromBuffer(width, height, data)
instance:DrawCircle(center, radius, color, transparency, _combineType)
instance:DrawCircleLines(center, radius, color, transparency)
instance:DrawRectangle(position, size, color, transparency, _combineType)
instance:DrawRectangleLines(position, size, thickness, color, transparency)
instance:DrawRectangleOutline(position, size, color, transparency, thickness)
instance:DrawLine(from, to, color, transparency, _combineType)
instance:DrawLineEx(from, to, thickness, color, transparency)
instance:DrawTriangle(v1, v2, v3, color, transparency)
instance:DrawTriangleEx(v1, v2, v3, color1, color2, color3, transparency)
instance:DrawTriangleLines(v1, v2, v3, color, transparency)
instance:DrawText(text, position, fontSize, color, transparency)
instance:DrawTextEx(font, text, position, fontSize, _spacing, color, transparency)
instance:ReadPixelsBuffer(position, size)
instance:WritePixelsBuffer(position, size, data)
instance:SetPixelColor(position, color, transparency)
instance:GetPixelColor(position)
instance:Clear(color, transparency)
instance:DrawImage(position, image, _combineType)
instance:DrawImageTransformed(position, scale, rotation, image, _options)
instance:DrawImageProjected(mesh, _projection, brushConfig)
instance:remapPixels(self, width, height, mapper)
instance:Resize(newSize)
instance:Crop(position, size)
instance:FlipHorizontal()
instance:FlipVertical()
instance:Flip(horizontal, vertical)
instance:Rotate(angle)
instance:filterPixels(self, transform)
instance:ApplyGrayscale()
instance:ApplyInvert()
instance:ApplyContrast(contrast)
instance:ApplyBrightness(brightness)
instance:ColorReplace(oldColor, newColor)
instance:Blur(strength)
instance:Sharpen()
instance:DrawGradient(fromPosition, toPosition, color1, color2, transparency)
instance:AlphaMask(mask)
instance:GetImageAlphaBorder()
instance:AlphaCrop(alphaThreshold)
instance:AlphaClear(color, transparency)
instance:AlphaPremultiply()
instance:Dither(rBits, gBits, bBits, aBits)
instance:quantize(value, bits)
instance:ExportToFile(_filepath)
instance:GetDimensions()
instance:GetArea()
instance:IsDirty()
instance:MarkDirty()
instance:ClearDirty()

Dropdown

GUI component that allows selection of a single option from a list.

EditableMesh

Stores editable mesh geometry, attributes, bones, and generated render data.

On this page

PropertiesFunctionsbytergbadimensionsdestroySurfacecreateSurfacesurfacePixelsgetPixelBytessetPixelBytesblendPixelsnapshotreplaceFromBufferinstance:DrawCircleinstance:DrawCircleLinesinstance:DrawRectangleinstance:DrawRectangleLinesinstance:DrawRectangleOutlineinstance:DrawLineinstance:DrawLineExinstance:DrawTriangleinstance:DrawTriangleExinstance:DrawTriangleLinesinstance:DrawTextinstance:DrawTextExinstance:ReadPixelsBufferinstance:WritePixelsBufferinstance:SetPixelColorinstance:GetPixelColorinstance:Clearinstance:DrawImageinstance:DrawImageTransformedinstance:DrawImageProjectedremapPixelsinstance:Resizeinstance:Cropinstance:FlipHorizontalinstance:FlipVerticalinstance:Flipinstance:RotatefilterPixelsinstance:ApplyGrayscaleinstance:ApplyInvertinstance:ApplyContrastinstance:ApplyBrightnessinstance:ColorReplaceinstance:Blurinstance:Sharpeninstance:DrawGradientinstance:AlphaMaskinstance:GetImageAlphaBorderinstance:AlphaCropinstance:AlphaClearinstance:AlphaPremultiplyinstance:Ditherquantizeinstance:ExportToFileinstance:GetDimensionsinstance:GetAreainstance:IsDirtyinstance:MarkDirtyinstance:ClearDirtyAPI