Skip to content
Docs
Open Promoeyes

portal

set 0× in templates and rigs

A vertical slit of light that tears open into a glowing rim on a real view of the scene, through a linked exit or from a fixed camera, then squeezes shut; one extra scene render while it is open and on screen.

portal(clarity=1 core=#ffffff exit="0 0 0")

Attributes

claritynumber0×
corecolour #rrggbbThe rim's white-hot inner edge.0×
exit"x y z"`x y z`: the view is the camera carried through an exit there, a true window with parallax.0×
exit-facing"x y z"With `exit`: the way you look out of it, `x y z` or a yaw in degrees; by default the way you look in.0×
fadenumber0×
heightnumberThe open ellipse's height in mm.0×
holdnumber0×
lighttrue / false0×
light-decaynumber0×
light-distancenumber0×
light-intensitynumber0×
opacitynumber0×
position"x y z"0×
resolutionnumberThe view's target as a fraction of the drawing buffer, 0.5 by default; its cost follows it.0×
rimcolour #rrggbbThe rim's saturated colour.0×
rim-glownumberEmissive gain on the rim and its filaments.0×
ripplenumber0×
seednumber0×
startnumber0×
tearnumberHow far the rim wobbles.0×
travelnumber0×
twistnumber0×
view-fovnumber0×
view-from"x y z"`x y z`: the view comes from a fixed camera here instead, centred on the membrane, without parallax.0×
view-look"x y z"With `view-from`: the point that camera looks at.0×
widthnumberThe open ellipse's width in mm.0×