Kinemium Docs

ViewportFrame

A GUI frame that renders an isolated Filament 3D scene.

Properties

PropertyTypeDefault
Cameraanynil
AmbientColoranyColor3.fromRGB(48, 52, 61)
LightColorColor3Color3.new(1, 1, 1)
LightDirectionVector3Vector3.new(-0.45, -0.7, -0.55)
ManualRenderbooleanfalse
ResolutionScalenumber1
MaterialShaderanynil
PostProcessShaderanynil
Namestring"ViewportFrame"
ClipsDescendantsbooleantrue

Functions


isBasePart

Arguments

object

Returns

This function returns nothing.

materialKind

Arguments

material

Returns

This function returns nothing.

destroyState

Arguments

state

Returns

This function returns nothing.

cloneShader

Arguments

value, shaderType

Returns

This function returns nothing.

syncShader

Arguments

state, value, shaderType

Returns

This function returns nothing.

syncShaders

Arguments

state, object

Returns

This function returns nothing.

ensureViewport

Arguments

state, width, height

Returns

This function returns nothing.

meshForPart

Arguments

state, props

Returns

This function returns nothing.

renderFilament

Arguments

state, object, dt

Returns

This function returns nothing.

instance:Render

Arguments

This function takes no arguments.

Returns

This function returns nothing.

instance:GetShaderError

Arguments

This function takes no arguments.

Returns

This function returns nothing.

propTable.render

Arguments

window, object, dt, renderer

Returns

This function returns nothing.

API

instance:isBasePart(object)
instance:materialKind(material)
instance:destroyState(state)
instance:cloneShader(value, shaderType)
instance:syncShader(state, value, shaderType)
instance:syncShaders(state, object)
instance:ensureViewport(state, width, height)
instance:meshForPart(state, props)
instance:renderFilament(state, object, dt)
instance:Render()
instance:GetShaderError()
instance:render(window, object, dt, renderer)

On this page