ViewportFrame
CreatorHub

GuiObject that renders 3D objects inside its bounds.

Memory category	Gui

Member index 8

History		Member
726		Ambient: Color3
726		CurrentCamera: Camera
726		ImageColor3: Color3
726		ImageTransparency: float
726		IsMirrored: bool
726		LightColor: Color3
726		LightDirection: Vector3
645		CaptureSnapshotAsync(): ContentId
55 members inherited from GuiObject
726		Active: bool
726		AnchorPoint: Vector2
726		AutomaticSize: AutomaticSize
726		BackgroundColor: BrickColor
726		BackgroundColor3: Color3
726		BackgroundTransparency: float
726		BorderColor: BrickColor
726		BorderColor3: Color3
726		BorderMode: BorderMode
726		BorderSizePixel: int
726		ClipsDescendants: bool
726		Draggable: bool
726		GuiState: GuiState
726		InputSink: InputSink
726		Interactable: bool
726		LayoutOrder: int
726		NextSelectionDown: GuiObject
726		NextSelectionLeft: GuiObject
726		NextSelectionRight: GuiObject
726		NextSelectionUp: GuiObject
726		Position: UDim2
726		Rotation: float
726		Selectable: bool
726		SelectionImageObject: GuiObject
726		SelectionOrder: int
726		SelectionRect2D: Rect
726		Size: UDim2
726		SizeConstraint: SizeConstraint
726		Transparency: float
726		Visible: bool
726		ZIndex: int
462		TweenPosition(endPosition: UDim2, easingDirection: EasingDirection = Out, easingStyle: EasingStyle = Quad, time: float = 1, override: bool = false, callback: Function = nil): bool
713		TweenPositionInternal(endPosition: UDim2, easingDirection: EasingDirection = Out, easingStyle: EasingStyle = Quad, time: float = 1, override: bool = false, callback: Function = nil): bool
462		TweenSize(endSize: UDim2, easingDirection: EasingDirection = Out, easingStyle: EasingStyle = Quad, time: float = 1, override: bool = false, callback: Function = nil): bool
462		TweenSizeAndPosition(endSize: UDim2, endPosition: UDim2, easingDirection: EasingDirection = Out, easingStyle: EasingStyle = Quad, time: float = 1, override: bool = false, callback: Function = nil): bool
713		TweenSizeAndPositionInternal(endSize: UDim2, endPosition: UDim2, easingDirection: EasingDirection = Out, easingStyle: EasingStyle = Quad, time: float = 1, override: bool = false, callback: Function = nil): bool
713		TweenSizeInternal(endSize: UDim2, easingDirection: EasingDirection = Out, easingStyle: EasingStyle = Quad, time: float = 1, override: bool = false, callback: Function = nil): bool
462		DragBegin(initialPosition: UDim2)
462		DragStopped(x: int, y: int)
483		InputBegan(input: InputObject)
483		InputChanged(input: InputObject)
483		InputEnded(input: InputObject)
462		MouseEnter(x: int, y: int)
462		MouseLeave(x: int, y: int)
462		MouseMoved(x: int, y: int)
462		MouseWheelBackward(x: int, y: int)
462		MouseWheelForward(x: int, y: int)
462		SelectionGained()
462		SelectionLost()
462		TouchLongPress(touchPositions: Array, state: UserInputState)
462		TouchPan(touchPositions: Array, totalTranslation: Vector2, velocity: Vector2, state: UserInputState)
462		TouchPinch(touchPositions: Array, scale: float, velocity: float, state: UserInputState)
462		TouchRotate(touchPositions: Array, rotation: float, velocity: float, state: UserInputState)
462		TouchSwipe(swipeDirection: SwipeDirection, numberOfTouches: int)
462		TouchTap(touchPositions: Array)
16 members inherited from GuiBase2d
726		AbsolutePosition: Vector2
726		AbsoluteRotation: float
726		AbsoluteSize: Vector2
726		AutoLocalize: bool
726		ClippedRect: Rect
726		IsNotOccluded: bool
726		Localize: bool
726		RawRect2D: Rect
726		RootLocalizationTable: LocalizationTable
726		SelectionBehaviorDown: SelectionBehavior
726		SelectionBehaviorLeft: SelectionBehavior
726		SelectionBehaviorRight: SelectionBehavior
726		SelectionBehaviorUp: SelectionBehavior
726		SelectionGroup: bool
726		TotalGroupScale: float
525		SelectionChanged(amISelected: bool, previousSelection: GuiObject, newSelection: GuiObject)
60 members inherited from Instance
726		Archivable: bool
726		Capabilities: SecurityCapabilities
726		DataCost: int
726		IsInSandbox: bool
726		Name: string
726		Parent: Instance
726		PredictionMode: PredictionMode
726		RobloxLocked: bool
726		Sandboxed: bool
726		SourceAssetId: int64
726		UniqueId: UniqueId
726		archivable: bool
576		AddTag(tag: string): null
573		ClearAllChildren(): null
462		Clone(): Instance
573		Destroy(): null
486		FindFirstAncestor(name: string): Instance
486		FindFirstAncestorOfClass(className: string): Instance
486		FindFirstAncestorWhichIsA(className: string): Instance
486		FindFirstChild(name: string, recursive: bool = false): Instance
486		FindFirstChildOfClass(className: string): Instance
486		FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486		FindFirstDescendant(name: string): Instance
563		GetActor(): Actor
486		GetAttribute(attribute: string): Variant
462		GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631		GetAttributes(): Dictionary
648		GetChildren(): Instances
462		GetDebugId(scopeLength: int = 4): string
707		GetDescendants(): Instances
486		GetFullName(): string
706		GetStyled(name: string, selector: string?): Variant
657		GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576		GetTags(): Array
576		HasTag(tag: string): bool
486		IsAncestorOf(descendant: Instance): bool
486		IsDescendantOf(ancestor: Instance): bool
664		IsPropertyModified(property: string): bool
698		QueryDescendants(selector: string): Instances
573		Remove(): null
576		RemoveTag(tag: string): null
664		ResetPropertyToDefault(property: string): null
573		SetAttribute(attribute: string, value: Variant): null
462		WaitForChild(childName: string, timeOut: double): Instance
726		children(): Instances
726		clone(): Instance
726		destroy(): null
726		findFirstChild(name: string, recursive: bool = false): Instance
726		getChildren(): Instances
726		isDescendantOf(ancestor: Instance): bool
726		remove(): null
462		AncestryChanged(child: Instance, parent: Instance)
462		AttributeChanged(attribute: string)
462		ChildAdded(child: Instance)
462		ChildRemoved(child: Instance)
462		DescendantAdded(descendant: Instance)
462		DescendantRemoving(descendant: Instance)
500		Destroying()
657		StyledPropertiesChanged()
726		childAdded(child: Instance)
6 members inherited from Object
726		ClassName: string
726		className: string
647		GetPropertyChangedSignal(property: string): RBXScriptSignal
647		IsA(className: string): bool
726		isA(className: string): bool
647		Changed(property: string)

Removed member index 2

History		Member
726		CameraCFrame: CFrame
726		CameraFieldOfView: float

Description

ViewportFrame is a GuiObject that renders 3D objects inside its bounds, offering a way to display 3D objects in a 2D space like a ScreenGui. This object has the following caveats:

No shadows or post-processing effects are rendered.
Material.Neon and Material.Glass materials render at the lowest quality.
Nested GuiObjects aren't supported.
By default, lighting inside a ViewportFrame acts as if Lighting.EnvironmentSpecularScale and Lighting.EnvironmentDiffuseScale are both set to 0, so properties that rely on these fields, such as SurfaceAppearance.MetalnessMap, may look different.
This object can use a Sky child as a cubemap for reflections, in which case only the Sky object's six Skybox[…] properties are used. Assuming these properties are valid, lighting inside the ViewportFrame acts similarly to if Lighting.EnvironmentSpecularScale and Lighting.EnvironmentDiffuseScale are both set to 1. For details, see here.

History 45
Hide member changes

726 Change Default of LightDirection from Vector3(-1, -1, -1) to
726 Change Default of LightColor from Color3(0.54902, 0.54902, 0.54902) to
726 Change Default of IsMirrored from false to
726 Change Default of ImageTransparency from 0 to
726 Change Default of ImageColor3 from Color3(1, 1, 1) to
726 Change Default of CurrentCamera from to
726 Remove CameraFieldOfView
726 Remove CameraCFrame
726 Change Default of Ambient from Color3(0.784314, 0.784314, 0.784314) to
705 Change Default of CameraCFrame from to CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1)
705 Change Default of CameraCFrame from CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1) to
702 Change Default of CameraCFrame from to CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1)
645 Change ReturnType of CaptureSnapshotAsync from Content to ContentId
599 Add CaptureSnapshotAsync
553 Change Default of LightDirection from to Vector3(-1, -1, -1)
553 Change Default of LightColor from to Color3(0.54902, 0.54902, 0.54902)
553 Change Default of IsMirrored from to false
553 Change Default of ImageTransparency from to 0
553 Change Default of ImageColor3 from to Color3(1, 1, 1)
553 Change Default of CurrentCamera from to
553 Add CameraFieldOfView
553 Add CameraCFrame
553 Change Default of Ambient from to Color3(0.784314, 0.784314, 0.784314)
540 Add IsMirrored
486 Change ThreadSafety of LightDirection from ReadOnly to ReadSafe
486 Change ThreadSafety of LightColor from ReadOnly to ReadSafe
486 Change ThreadSafety of ImageTransparency from ReadOnly to ReadSafe
486 Change ThreadSafety of ImageColor3 from ReadOnly to ReadSafe
486 Change ThreadSafety of CurrentCamera from ReadOnly to ReadSafe
486 Change ThreadSafety of Ambient from ReadOnly to ReadSafe
462 Change ThreadSafety of LightDirection from to ReadOnly
462 Change ThreadSafety of LightColor from to ReadOnly
462 Change ThreadSafety of ImageTransparency from to ReadOnly
462 Change ThreadSafety of ImageColor3 from to ReadOnly
462 Change ThreadSafety of CurrentCamera from to ReadOnly
462 Change ThreadSafety of Ambient from to ReadOnly
384 Add LightDirection
384 Add LightColor
384 Add Ambient
367 Add ImageTransparency
367 Add ImageColor3
363 Change CanSave of CurrentCamera from true to false
363 Change Tags of CurrentCamera from [] to [NotReplicated]
361 Add CurrentCamera
361 Add ViewportFrame

Members 8

Ambient
CreatorHub

Type		Default
Color3

This property determines the lighting hue applied to the area within the ViewportFrame. Defaults to Color3.fromRGB(200, 200, 200) (ghost grey).

Thread safety	ReadSafe
Category	Appearance
Loaded/Saved	true

History 5

726 Change Default of Ambient from Color3(0.784314, 0.784314, 0.784314) to
553 Change Default of Ambient from to Color3(0.784314, 0.784314, 0.784314)
486 Change ThreadSafety of Ambient from ReadOnly to ReadSafe
462 Change ThreadSafety of Ambient from to ReadOnly
384 Add Ambient

CaptureSnapshotAsync
CreatorHub

Parameters (0)
No parameters.
Returns (1)
ContentId

It will block the calling thread until completion.

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 2

645 Change ReturnType of CaptureSnapshotAsync from Content to ContentId
599 Add CaptureSnapshotAsync

Tags: [Yields]

CurrentCamera
CreatorHub

Type		Default
Camera

Camera instance that is used to render children objects. Defaults to nil.

The Camera object does not replicate so the ViewportFrame.CurrentCamera won't replicate either. When you set this property, Camera.CFrame and Camera.FieldOfView will be saved and replicate with the ViewportFrame internally so the client can render the frame without a Camera object.

Its interface does not cross the network boundary.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	true/false

History 7

726 Change Default of CurrentCamera from to
553 Change Default of CurrentCamera from to
486 Change ThreadSafety of CurrentCamera from ReadOnly to ReadSafe
462 Change ThreadSafety of CurrentCamera from to ReadOnly
363 Change CanSave of CurrentCamera from true to false
363 Change Tags of CurrentCamera from [] to [NotReplicated]
361 Add CurrentCamera

Tags: [NotReplicated]

ImageColor3
CreatorHub

Type		Default
Color3

This property determines how the rendered viewport image will be colorized, allowing you to change the color without directly modifying the rendered object. The default colorization value is Color3.new(1, 1, 1) (white) at which no color modification occurs.

See also ImageTransparency which determines the transparency of the rendered image.

Thread safety	ReadSafe
Category	Image
Loaded/Saved	true

History 5

726 Change Default of ImageColor3 from Color3(1, 1, 1) to
553 Change Default of ImageColor3 from to Color3(1, 1, 1)
486 Change ThreadSafety of ImageColor3 from ReadOnly to ReadSafe
462 Change ThreadSafety of ImageColor3 from to ReadOnly
367 Add ImageColor3

ImageTransparency
CreatorHub

Type		Default
float

This property determines the transparency of the rendered viewport image, allowing you to change the transparency without directly modifying the rendered object. A value of 0 (default) is completely opaque and a value of 1 is completely transparent (invisible).

See also ImageColor3 which determines how the rendered image will be colorized.

Thread safety	ReadSafe
Category	Image
Loaded/Saved	true

History 5

726 Change Default of ImageTransparency from 0 to
553 Change Default of ImageTransparency from to 0
486 Change ThreadSafety of ImageTransparency from ReadOnly to ReadSafe
462 Change ThreadSafety of ImageTransparency from to ReadOnly
367 Add ImageTransparency

IsMirrored
CreatorHub

Type		Default
bool

Its interface does not cross the network boundary.

It is not meant to be used, and may have unresolved issues.

Security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Appearance
Loaded/Saved	false

History 3

726 Change Default of IsMirrored from false to
553 Change Default of IsMirrored from to false
540 Add IsMirrored

Tags: [Hidden, NotReplicated]

LightColor
CreatorHub

Type		Default
Color3

The color of the emitted light. Defaults to Color3.fromRGB(140, 140, 140) (silver).

Thread safety	ReadSafe
Category	Appearance
Loaded/Saved	true

History 5

726 Change Default of LightColor from Color3(0.54902, 0.54902, 0.54902) to
553 Change Default of LightColor from to Color3(0.54902, 0.54902, 0.54902)
486 Change ThreadSafety of LightColor from ReadOnly to ReadSafe
462 Change ThreadSafety of LightColor from to ReadOnly
384 Add LightColor

LightDirection
CreatorHub

Type		Default
Vector3

A Vector3 representing the direction of the light source from position (0, 0, 0). Defaults to Vector3.new(-1, -1, -1).

Thread safety	ReadSafe
Category	Appearance
Loaded/Saved	true

History 5

726 Change Default of LightDirection from Vector3(-1, -1, -1) to
553 Change Default of LightDirection from to Vector3(-1, -1, -1)
486 Change ThreadSafety of LightDirection from ReadOnly to ReadSafe
462 Change ThreadSafety of LightDirection from to ReadOnly
384 Add LightDirection

Removed members 2

CameraCFrame
CreatorHub

Type		Default
CFrame		0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1

It cannot be accessed by script code.

It is not meant to be used, and may have unresolved issues.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 5

726 Remove CameraCFrame
705 Change Default of CameraCFrame from to CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1)
705 Change Default of CameraCFrame from CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1) to
702 Change Default of CameraCFrame from to CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1)
553 Add CameraCFrame

Tags: [Hidden, NotScriptable]

CameraFieldOfView
CreatorHub

Type		Default
float		1.22173059

It cannot be accessed by script code.

It is not meant to be used, and may have unresolved issues.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 2

726 Remove CameraFieldOfView
553 Add CameraFieldOfView

Tags: [Hidden, NotScriptable]

Reference API Roblox

Engine API

Website

Related

Reference API Roblox

ViewportFrame
CreatorHub

Member index 8

Removed member index 2

Description

History 45
Hide member changes

Members 8

Ambient
CreatorHub

History 5

CaptureSnapshotAsync
CreatorHub

History 2

CurrentCamera
CreatorHub

History 7

ImageColor3
CreatorHub

History 5

ImageTransparency
CreatorHub

History 5

IsMirrored
CreatorHub

History 3

LightColor
CreatorHub

History 5

LightDirection
CreatorHub

History 5

Removed members 2

CameraCFrame
CreatorHub

History 5

CameraFieldOfView
CreatorHub

History 2

Settings