Camera

Lens Studio v1.0.0+

Scripting Name: Component.Camera

Inherits from Component

Description

Renders the scene to an output texture. A Camera will only render a SceneObject if the SceneObject’s render layer is enabled on the Camera. For more information, see the Camera and Layers guide.

Methods

---

addRenderLayer(Number id) : void

Adds layer id to the list of layers the Camera will render.

---

checkRenderLayer(Number id) : Boolean

Returns whether rendering layer id is enabled for the Camera.

---

getAllRenderLayers() : Number[]

Returns a list of 32 numbers, one for every render layer. Values will either be 0 or 1, 0 meaning the Camera won’t render the layer and 1 meaning it will.

---

getOrthographicSize() : vec2

For orthographic cameras, returns the camera size as (width, height).

---

project(vec3 worldSpacePoint) : vec3

Converts a world space position to a raw screen space position. The screen space position will be returned as a vec3 with x,y representing normalized screen space, and z representing a raw depth value not directly convertible to world units. This returned value will mostly be useful for passing into unproject().

---

removeRenderLayer(Number id) : void

Removes layer id from the list of layers the Camera will render.

---

screenSpaceToWorldSpace(vec2 normalizedScreenSpacePoint, Number absoluteDepth) : vec3

Converts a screen space position to a world space position, given an absolute depth. The screen space position should be provided as a vec2 in the range ([0-1], [0-1]), (0,0) being the top-left of the screen and (1,1) being the bottom-right. The returned world space position will be the point absoluteDepth units away from the Camera’s near plane at the point specified in screen space.

---

unproject(vec3 clipSpacePoint) : vec3

Converts a raw screen space position to a world space position. clipSpacePoint should be a vec3 returned from a previous project() call, since the z value represents a raw depth value not directly convertible to world units.

---

worldSpaceToScreenSpace(vec3 worldSpacePoint) : vec2

Converts the world space position worldSpacePoint to a screen space position. Screen positions are represented in the range ([0-1], [0-1]), (0,0) being the top-left of the screen and (1,1) being the bottom-right.

Properties

---

aspect : Number

The aspect ratio of the camera (width/height).

---

far : Number

The distance of the far clipping plane.

---

fov : Number

The Camera’s field of view in degrees.

---

isPhysical : Boolean

If true, the camera FOV will be overridden to match the device’s physical camera FOV.

---

maskTexture : Texture

A texture controlling which parts of the output texture the camera will draw to. The “red” value of each pixel determines how strongly the camera will draw to that part of the image. For example, a completely black section will cause the camera to not draw there at all. A completely white (or red) section will cause the camera to draw normally. Colors in between, like gray, will be semitransparent.

---

near : Number

The distance of the near clipping plane.

---

renderOrder : Number

The sorting order the Camera renders in. Every frame, Cameras render in ascending order determined by their renderOrder properties.

---

size : Number

The orthographic size of the camera.

Inherited Methods

---

destroy() : void

Destroys the component.

---

getSceneObject() : SceneObject

Returns the SceneObject the component is attached to.

---

getTransform() : Transform

Returns the Transform this component is attached to.

---

getTypeName() : String

Returns the name of this object’s type.

Inherited Properties

---

enabled : Boolean

If disabled, the Component will stop enacting its behavior.

Examples

// Stops the camera from rendering the layer of dontRenderTarget
//@input Component.Camera camera
//@input SceneObject dontRenderTarget

var layer = script.dontRenderTarget.getRenderLayer();
script.camera.removeRenderLayer(layer);