Object which allows for the runtime creation and manipulation of images.
- Memory category
- Instances
- Own members
- 15
- Inherited members
- 6
- Subclasses
- 0
- Siblings
- 30
Properties6
Defined byEditableImage4
Property categoryData
EditableImage.ImageData: string EditableImage.ImageHolder: NetAssetRef EditableImage.IsReplicatedCopy: boolean EditableImage.Size: Vector2 Size of theEditableImagein pixels.
No properties match the filters.
Methods14
Object:GetPropertyChangedSignal( property: string): RBXScriptSignal Get an event that fires when a given property of the object changes.Parameters Parameter Description property: stringThe property to connect to.Returns Type Description RBXScriptSignalA signal that fires whenever the property changes.- Returns true if an object's class matches or inherits from a given class.
Parameters Parameter Description className: stringThe class against which the Object's class will be checked. Case-sensitive.Returns Type Description booleanDescribes whether the Object's class matched or is a subclass of the given class. - Deprecated: This deprecated function is a variant of
Object:IsA()which should be used instead.Parameters Parameter className: stringReturns Type booleanUse IsA instead.
Defined byEditableImage11
- Destroys the image contents and immediately reclaims the memory they use.
EditableImage:DrawCircle(center: Vector2,radius: number,color: Color3,transparency: number,combineType: Enum.ImageCombineType,antiAliasing: Enum.AntiAliasing? = Enum.AntiAliasing.Enabled,) Draws a circle at the specified point.Parameters Parameter Description center: Vector2Center of the circle, relative to the top-left corner of theEditableImage. Positions outside the canvas bounds are allowed.radius: numberRadius of the circle in pixels.color: Color3Color of the circle.transparency: numberTransparency of the circle with 0 being fully opaque and 1 being fully transparent.combineType: Enum.ImageCombineTypeHow the drawn pixels (source) are combined with the existing pixels of this image (destination).antiAliasing: Enum.AntiAliasing? = Enum.AntiAliasing.EnabledDetermines whether anti-aliasing is applied to the circle. When set toAntiAliasing.Enabled, circle edges are soft. When set toAntiAliasing.Disabled, circle edges are hard.EditableImage:DrawImage(position: Vector2,image: EditableImage,combineType: Enum.ImageCombineType,) Draws anotherEditableImageinto thisEditableImageat the given position.Parameters Parameter Description position: Vector2Position at which the top-left corner of the source image will be drawn.image: EditableImageThe sourceEditableImageto draw into thisEditableImage.combineType: Enum.ImageCombineTypeHow the pixels of the source image are combined with the existing pixels of this image (destination).EditableImage:DrawImageProjected(projectionSource: Object,projection: { [string]: any },brushConfig: { [string]: any },) Parameters Parameter Description projectionSource: Objectprojection: { [string]: any }Projection configuration dictionary including the following key-value pairs:brushConfig: { [string]: any }Brush configuration dictionary including the following key-value pairs:AlphaBlendType(ImageAlphaType) which determines how this projection will blend alpha values.ColorBlendType(ImageCombineType) which determines how this projection will blend color values.Decal(EditableImage) as the image used for projection.FadeAngle(number) as the angle in degrees for the projection edges to start to fall off. The projection will be fully faded out at 90 degrees. An angle of 0 means fading starts immediately at 0 degrees and an angle of 90 means no fading but instead a hard edge at 90 degrees. An angle of 70 degrees would mean the projection starts to fade at 70 degrees and is fully faded out at 90 degrees.BlendIntensity(number) as the value between0and1which controls how much of the projection is blended into the resulting image.
EditableImage:DrawImageTransformed(position: Vector2,scale: Vector2,rotation: number,image: EditableImage,options: { [string]: any }?,) Draws an image into thisEditableImagewith transformations including scaling and rotation, placing it at the specified position.Parameters Parameter Description position: Vector2Position in pixels where the pivot point of the source image will be placed on this image.scale: Vector2Scaling factors for the source image along the X and Y axes.rotation: numberThe rotation angle in degrees, applied around the pivot point of the source image.image: EditableImageThe sourceEditableImageto be drawn into this image.options: { [string]: any }?Optional dictionary for additional configuration:CombineType: Specifies how the pixels of the source image blend with those of the destination. Default isImageCombineType.AlphaBlend.SamplingMode: Specifies the sampling method (e.g.Defaultfor bilinear orPixelatedfor nearest neighbor). Default isResamplerMode.Default.PivotPoint: Specifies the pivot point within the source image for scaling and rotation. Default is the center of the source image (i.e.Size / 2).
EditableImage:DrawLine(p1: Vector2,p2: Vector2,color: Color3,transparency: number,combineType: Enum.ImageCombineType,antiAliasing: Enum.AntiAliasing? = Enum.AntiAliasing.Enabled,) Draws a line between two provided points.Parameters Parameter Description p1: Vector2Start point of the line.p2: Vector2End point of the line.color: Color3Color of the line.transparency: numberTransparency of the line.combineType: Enum.ImageCombineTypeHow the drawn pixels (source) are combined with the existing pixels of this image (destination).antiAliasing: Enum.AntiAliasing? = Enum.AntiAliasing.EnabledDetermines whether anti-aliasing is applied to the line. When set toAntiAliasing.Enabled, line edges are soft. When set toAntiAliasing.Disabled, line edges are hard.EditableImage:DrawRectangle(position: Vector2,size: Vector2,color: Color3,transparency: number,combineType: Enum.ImageCombineType,) Draws a rectangle of the given size at the given top-left position.Parameters Parameter Description position: Vector2Position of the top-left of the rectangle. Unlike other drawing methods, this cannot be outside the canvas bounds of theEditableImage.size: Vector2Size of the rectangle to draw, in pixels.color: Color3Color of the rectangle.transparency: numberTransparency of the rectangle.combineType: Enum.ImageCombineTypeHow the drawn pixels (source) are combined with the existing pixels of this image (destination).- Reads a rectangular region of pixels into a buffer.
Parameters Parameter Description position: Vector2Top-left corner of the rectangular region of pixels to read.size: Vector2Size of the rectangular region of pixels to read.Returns Type Description bufferBuffer where each pixel is represented by four bytes (red, green, blue and alpha respectively). The length of the buffer can be calculated asX * Size.Y * 4bytes. EditableImage:SampleImageProjected(projectionSource: Object,sourceTexture: EditableImage,projectionConfig: { [string]: any },brushConfig: { [string]: any },) Projects pixels from anEditableMeshtexture into thisEditableImage.Parameters Parameter Description projectionSource: ObjectsourceTexture: EditableImageTheEditableImagefrom which pixels are sampled.projectionConfig: { [string]: any }Projection configuration dictionary containing the following key-value pairs:Direction(Vector3) where the projector is facing.Position(Vector3) as the projector position in local space with respect to the mesh.Size(Vector3) as the size of the projector. The X and Y components specify its dimensions, while the Z component specifies the projection depth.Up(Vector3) as the up vector of the projector in local space with respect to the mesh.
brushConfig: { [string]: any }Brush configuration dictionary containing the following key-value pairs:AlphaBlendType(ImageAlphaType) which determines how the sampled alpha values are blended.ColorBlendType(ImageCombineType) which determines how the sampled color values are blended.FadeAngle(number) as the angle in degrees at which the projection begins to fade based on the surface normal. A value of180applies no normal-angle fade.
- Writes a rectangular region of pixels into the image.
Parameters Parameter Description position: Vector2Top-left corner of the rectangular region to draw the pixels into.size: Vector2Size of the rectangular region of pixels to write.buffer: bufferA buffer where each pixel is represented by four bytes (red, green, blue, and alpha respectively). The length of the buffer should beX * Size.Y * 4bytes.
No methods match the filters.
Events1
Object.Changed: RBXScriptSignal<( property: string)> Fires immediately after a property of the object changes, with some limitations.Parameters Parameter property: string
No events match the filters.