SurfaceGui
Displays a 2D UI element on a 3D surface.
Properties
| Property | Type | Default |
|---|---|---|
Name | string | "SurfaceGui" |
Enabled | boolean | true |
Adornee | any | nil |
Face | EnumItem | Enum.NormalId.Front |
CanvasSize | Vector2 | Vector2.new(800, 600) |
PixelsPerStud | number | 50 |
SizingMode | EnumItem | Enum.SurfaceGuiSizingMode.FixedSize |
AlwaysOnTop | boolean | false |
LightInfluence | number | 1 |
Brightness | number | 1 |
ZIndexBehavior | EnumItem | Enum.ZIndexBehavior.Sibling |
ZOffset | number | 0 |
Size | UDim2 | UDim2.new(0, 800, 0, 600) |
RenderOffset | Vector2 | Vector2.new(0, 0) |
Texture | any | nil |
Functions
`getAdornee`
`getFaceSize`
`getFaceCorners`
`resolveTextureSource`
`loadTextureFromPath`
`loadTextureFromEditable`
`resetRenderTexture`
`getCanvasSize`
`syncTexture`
`instance.GetRelativeMousePosition`
Gets the relative mouse position in the SurfaceGui.
getAdornee
Arguments
instanceReturns
This function returns nothing.
getFaceSize
Arguments
size, faceReturns
This function returns nothing.
getFaceCorners
Arguments
cf, size, faceReturns
This function returns nothing.
resolveTextureSource
Arguments
instanceReturns
This function returns nothing.
loadTextureFromPath
Arguments
pathReturns
This function returns nothing.
loadTextureFromEditable
Arguments
editableImageReturns
This function returns nothing.
resetRenderTexture
Arguments
width, heightReturns
This function returns nothing.
getCanvasSize
Arguments
This function takes no arguments.
Returns
This function returns nothing.
syncTexture
Arguments
forceReturns
This function returns nothing.
instance.GetRelativeMousePosition
Gets the relative mouse position in the SurfaceGui.
Arguments
This function takes no arguments.
Returns
This function returns nothing.
API
instance:getAdornee(instance)
instance:getFaceSize(size, face)
instance:getFaceCorners(cf, size, face)
instance:resolveTextureSource(instance)
instance:loadTextureFromPath(path)
instance:loadTextureFromEditable(editableImage)
instance:resetRenderTexture(width, height)
instance:getCanvasSize()
instance:syncTexture(force)
instance:GetRelativeMousePosition()