Engine Class
EditableImage
Summary
Methods
Destroy():() |
DrawCircle(center: Vector2,radius: number,color: Color3,transparency: number,combineType: Enum.ImageCombineType,antiAliasing: Enum.AntiAliasing):() |
DrawImage(position: Vector2,image: EditableImage,combineType: Enum.ImageCombineType):() |
DrawImageProjected(mesh: EditableMesh,projection: Dictionary,brushConfig: Dictionary):() |
DrawImageTransformed(position: Vector2,scale: Vector2,rotation: number,image: EditableImage,options: Dictionary?):() |
DrawLine(p1: Vector2,p2: Vector2,color: Color3,transparency: number,combineType: Enum.ImageCombineType,antiAliasing: Enum.AntiAliasing):() |
DrawRectangle(position: Vector2,size: Vector2,color: Color3,transparency: number,combineType: Enum.ImageCombineType):() |
ReadPixelsBuffer(position: Vector2,size: Vector2):buffer |
WritePixelsBuffer(position: Vector2,size: Vector2,buffer: buffer):() |
Inherited Members
6 inherited from Object
API Reference
Properties
Methods
Destroy
EditableImage:Destroy():()
Returns
()
DrawCircle
EditableImage:DrawCircle(
center:Vector2, radius:number, color:Color3, transparency:number, combineType:Enum.ImageCombineType, antiAliasing:Enum.AntiAliasing
):()
Parameters
| Default Value: "Enabled" |
Returns
()
DrawImage
EditableImage:DrawImage(
):()
Parameters
Returns
()
DrawImageProjected
EditableImage:DrawImageProjected(
):()
Parameters
Returns
()
DrawImageTransformed
EditableImage:DrawImageTransformed(
):()
Parameters
Returns
()
Code Samples
EditableImage:DrawImageTransformed()
local AssetService = game:GetService("AssetService")
-- Example of drawing a rotated and scaled image onto another EditableImage
local srcImage = AssetService:CreateEditableImage({ Size = Vector2.new(256, 256) })
local dstImage = AssetService:CreateEditableImage({ Size = Vector2.new(512, 512) })
-- Drawing with a rotation of 45 degrees, scaling by 2x, and placing at (100, 100)
dstImage:DrawImageTransformed(
Vector2.new(100, 100), -- Position
Vector2.new(2, 2), -- Scale
45, -- Rotation (degrees)
srcImage, -- Source image
{
CombineType = Enum.ImageCombineType.AlphaBlend, -- Optional, default is AlphaBlend
SamplingMode = Enum.ResamplerMode.Default, -- Optional, default is Default
PivotPoint = srcImage.Size / 2, -- Optional, default is center of the source image
}
)EditableImage:DrawImageTransformed() - Crop
local AssetService = game:GetService("AssetService")
-- Source image
local srcImage = AssetService:CreateEditableImageAsync(Content.fromUri(assetUri))
-- Crop area defined by offset and size
local cropOffset = Vector2.new(50, 50)
local cropSize = Vector2.new(100, 100)
-- Destination image with size of the crop area
local dstImage = AssetService:CreateEditableImage({ Size = cropSize })
-- Position (top-left corner)
local position = Vector2.new(0, 0)
-- Scale factors (no scaling)
local scale = Vector2.new(1, 1)
-- Rotation angle (no rotation)
local rotation = 0
-- Draw the source image onto the destination image with adjusted pivot to crop the image
dstImage:DrawImageTransformed(position, scale, rotation, srcImage, {
CombineType = Enum.ImageCombineType.Overwrite,
PivotPoint = cropOffset, -- Set pivot point to cropOffset to start drawing from there
})DrawLine
EditableImage:DrawLine(
p1:Vector2, p2:Vector2, color:Color3, transparency:number, combineType:Enum.ImageCombineType, antiAliasing:Enum.AntiAliasing
):()
Parameters
| Default Value: "Enabled" |
Returns
()
DrawRectangle
EditableImage:DrawRectangle(
position:Vector2, size:Vector2, color:Color3, transparency:number, combineType:Enum.ImageCombineType
):()
Parameters
Returns
()
ReadPixelsBuffer
Returns
Code Samples
EditableImage:ReadPixelsBuffer()
local AssetService = game:GetService("AssetService")
local options = { Size = Vector2.new(32, 32) }
local editableImage = AssetService:CreateEditableImage(options)
local pixelsBuffer = editableImage:ReadPixelsBuffer(Vector2.zero, Vector2.new(2, 1))
local color1 =
Color3.fromRGB(buffer.readu8(pixelsBuffer, 0), buffer.readu8(pixelsBuffer, 1), buffer.readu8(pixelsBuffer, 2))
local transparency1 = (255 - buffer.readu8(pixelsBuffer, 3)) / 255
local color2 =
Color3.fromRGB(buffer.readu8(pixelsBuffer, 4), buffer.readu8(pixelsBuffer, 5), buffer.readu8(pixelsBuffer, 6))
local transparency2 = (255 - buffer.readu8(pixelsBuffer, 7)) / 255
local averageColor = color1:Lerp(color2, 0.5)
local averageTransparency = (transparency1 + transparency2) / 2
local part = Instance.new("Part")
part.Color = averageColor
part.Transparency = averageTransparency
part.Parent = workspaceWritePixelsBuffer
Returns
()
Code Samples
EditableImage:WritePixelsBuffer()
local AssetService = game:GetService("AssetService")
local options = { Size = Vector2.new(32, 32) }
local editableImage = AssetService:CreateEditableImage(options)
local pixelsBuffer = editableImage:ReadPixelsBuffer(Vector2.zero, editableImage.Size)
for i = 1, editableImage.Size.X * editableImage.Size.Y do
local pixelIndex = (i - 1) * 4
buffer.writeu8(pixelsBuffer, pixelIndex, 255 - buffer.readu8(pixelsBuffer, pixelIndex))
buffer.writeu8(pixelsBuffer, pixelIndex + 1, 255 - buffer.readu8(pixelsBuffer, pixelIndex + 1))
buffer.writeu8(pixelsBuffer, pixelIndex + 2, 255 - buffer.readu8(pixelsBuffer, pixelIndex + 2))
-- Set alpha to 255 to make all pixels fully opaque.
buffer.writeu8(pixelsBuffer, pixelIndex + 3, 255)
end
editableImage:WritePixelsBuffer(Vector2.zero, editableImage.Size, pixelsBuffer)