Animation Module

Classes

ClassDescription

AnimationModule

The AnimationModule class implements object animation.

ArrayOfScalarSamplers

The ArrayOfScalarSamplers class describes an array of scalar samplers.

ArrayOfScalarSignals

The ArrayOfScalarSignals class describes an array of scalar signals.

ColorSampler

The ColorSampler class encapsulates a color sampler.

Driver

The Driver class encapsulates an animation driver.

SamplerFactory

The SamplerFactory class creates different types of animation samplers.

ScalarSampler

The ScalarSampler class encapsulates a scalar value sampler.

TimeDriver

The TimeDriver class controls an animation.

ValueDriver

The ValueDriver class controls an animation value.

Audio Module

Classes

ClassDescription

AudioModule

The AudioModule class enables sound effects.

Camera Info Module

Classes

ClassDescription

CameraInfoModule

The CameraInfoModule class provides access to details about the device camera.

Enums

EnumDescription

CameraPosition

The CameraPosition enum describes the direction the camera is facing.

Camera Share Module

Classes

ClassDescription

CameraShareModule

The CameraShareModule class exposes methods and properties to allow an external app to send data to an effect.

Device Motion Module

Classes

ClassDescription

DeviceMotionModule

The DeviceMotionModule class enables device movement detection.

Diagnostics Module

Classes

ClassDescription

DiagnosticsModule

The DiagnosticsModule class enables diagnostic logging.

Face Gestures Module

Classes

ClassDescription

FaceGesturesModule

The FaceGesturesModule class enables face orientation detection.

Face Tracking Module

Classes

ClassDescription

Cheek

The Cheek class exposes the details of a detected cheek.

Chin

The Chin class exposes the details of a detected chin.

Eye

The Eye class exposes the details of a detected eye.

Eyebrow

The Eyebrow class exposes the details of a detected eyebrow.

Face

The Face class exposes details of a detected face.

FaceTrackingModule

The FaceTrackingModule class enables facial movement and expression detection.

Forehead

The Forehead class exposes the details of a detected forehead.

Mouth

The Mouth class exposes the details of a detected mouth.

Nose

The Nose class exposes the details of a detected nose.

Fonts Module

Classes

ClassDescription

FontId

The FontsId class identifies a font in an effect.

FontsModule

The FontsModule class is used for working with custom fonts in effects.

Live Streaming Module

Classes

ClassDescription

LiveStreamingComments

The LiveStreamingComments class provides access to the Facebook Live comments stream.

LiveStreamingModule

The LiveStreamingModule class exposes Facebook Live functionality to an effect.

LiveStreamingReactions

The LiveStreamingReactions class provides access to the Facebook Live reactions stream.

Enums

EnumDescription

State

The State enum describes the state of a live stream.

Locale Module

Classes

ClassDescription

LocaleModule

The LocaleModule class exposes device locale information.

Materials Module

Classes

ClassDescription

BlendedMaterial

The BlendedMaterial class encapsulates materials blended from multiple textures.

ColorPaintMaterial

The ColorPaintMaterial class encapsulates a face-paint material.

DefaultMaterial

The DefaultMaterial class encapsulates an image-based material.

MaterialBase

The MaterialBase class exposes properties common to all material types.

MaterialsModule

The MaterialsModule class enables working with textures and making adjustments to qualities like opacity and reflectivity.

TextureTransform

The TextureTransform class exposes the coordinates transform of a specific texture

Networking Module

Classes

ClassDescription

NetworkingModule

The NetworkingModule class enables effects to fetch information from a network.

Prefabs Module

Classes

ClassDescription

Prefab

The Prefab class represents a downloadable prefab mesh.

PrefabGltf

The PrefabGltf class represents a GLTF prefab mesh.

PrefabsModule

The PrefabsModule module provides functionality for working with external meshes.

Enums

EnumDescription

State

The State enum describes the state of a prefab mesh.

Reactive Module

Classes

ClassDescription

BoolSignal

The BoolSignal class monitors a boolean value.

BoolValue

The BoolValue class contains a Boolean value.

ColorSignal

The ColorSignal class monitors a color.

EventSource

The EventSource class provides methods for monitoring signals.

HsvaSignal

The HsvaSignal class monitors a HSVA color value.

PixelPointSignal

The PixelPointSignal class monitors a 2D coordinate.

PixelSizeSignal

The PixelSizeSignal class monitors the pixel size of the camera info preview.

Point2D

The Point2D class contains a 2D coordinate.

Point3D

The Point3D class contains a 3D coordinate.

PointSignal

The PointSignal class monitors a 3D coordinate.

ReactiveModule

The ReactiveModule class exposes methods for reactive programming.

RgbaSignal

The RgbaSignal class monitors a RGBA color value.

ScalarSignal

The ScalarSignal class monitors a numerical value.

ScalarValue

The ScalarValue class contains a scalar value.

StringSignal

The StringSignal class monitors a string value.

StringValue

The StringValue class contains a string value.

Subscription

The Subscription class implements object value monitoring.

TransformSignal

The TransformSignal class monitors a scene transform.

VectorSignal

The VectorSignal class monitors a vector.

Scene Module

Classes

ClassDescription

AmbientLightSource

The AmbientLightSource class describes an ambient lighting source.

AudioSource

The AudioSource class encapsulates an audio source for a scene.

Bounds2D

The Bounds2D class describes the bounds of a scene element.

Camera

The Camera class exposes details about the device camera focal area.

CameraVisibility

The CameraVisibility class describes whether or not an object is visible from various camera views.

Canvas

The Canvas class describes a scene canvas.

DirectionalLightSource

The DirectionalLightSource class describes a directional light source.

FaceMesh

The FaceMesh class describes a face mesh.

FocalPlane

The FocalPlane class exposes details about the focal plane of the device camera.

Mesh

The Mesh class describes a scene mesh.

ParticleSystem

The ParticleSystem class implements the particle management system for the scene.

ParticleTypeDescription

The ParticleTypeDescription class provides functionality for setting particle sprite densities in the scene.

ParticleTypeDescriptions

The ParticleTypeDescriptions class provides a container for particle type descriptions.

PlanarDiv

The PlanarDiv class describes a div on a plane.

PlanarFlexContainer

The PlanarFlexContainer class describes a flex container on a plane.

PlanarFlexItem

The PlanarFlexItem class describes a flex item on a plane.

PlanarImage

The PlanarImage class describes an image rendered on a plane.

PlanarObject

The PlanarObject class describes an object on a plane.

PlanarText

The PlanarText class describes text on a plane.

Plane

The Plane class describes a plane.

PointLightSource

The PointLightSource class describes a point light source.

Scene

The Scene class implements properties and methods to access the objects in a scene.

SceneModule

The SceneModule class exposes properties and methods to access the objects in a scene.

SceneObject

The SceneObject class describes an object in a scene.

SceneObjectBase

The SceneObjectBase class describes a scene object.

ScreenPlane

The ScreenPlane class describes a screen plane.

SpotLightSource

The SpotLightSource class describes a spot light source.

SvgImage

The SvgImage class describes an SVG image.

TextAlignmentWrapper

The TextAlignmentWrapper class contains text alignment details.

Transform

The Transform class describes an object transform for a scene.

Enums

EnumDescription

HorizontalAlignment

The HorizontalAlignment enum describes how an element is aligned horizontally.

RenderMode

The RenderMode enum describes how to render a scene object.

ScalingOption

The ScalingOption enum describes how an element is scaled.

TextAlignment

The TextAlignment enum describes how a text element is aligned horizontally.

VerticalAlignment

The VerticalAlignment enum describes how an element is aligned vertically.

VerticalTextAlignment

The VerticalTextAlignment enum describes how a text element is aligned vertically.

Scene Understanding Module

Classes

ClassDescription

SceneCategory

The SceneCategory class encapsulates details of recognized real-world objects

Enums

EnumDescription

SceneCategories

The SceneCategories enum lists possible objects that can be recognized in a scene by the SceneUnderstanding module

Textures Module

Classes

ClassDescription

CanvasTexture

The CanvasTexture class represents a texture brush.

ColorTexture

The ColorTexture class encapsulates a texture that has a color (including alpha channel).

DeepLinkTexture

The DeepLinkTexture class represents an image texture passed in via the sharing SDK.

ExternalTexture

The ExternalTexture class encapsulates a visual asset that is downloaded over the network.

ImageTexture

The ImageTexture class encapsulates an image that may be used to form materials for rendering in the scene.

SequenceTexture

The SequenceTexture class is a collection of still images that form an animation.

SubTexture

The SubTexture class exposes details of a texture in UV coordinates.

TextureBase

The TextureBase class describes a texture.

TexturesModule

The TexturesModule class enables images, animation sequences, videos, colors, and other visual artifacts to be combined to form materials.

Enums

EnumDescription

State

The State enum describes the download state of an ExternalTexture.

Time Module

Classes

ClassDescription

TimeModule

The TimeModule class enables time-based events.

Touch Gestures Module

Classes

ClassDescription

Gesture

The Gesture class encapsulates details of a detected gesture.

LongPressGesture

The LongPressGesture class contains the details of a detected long-press gesture.

PanGesture

The PanGesture class contains the details of a detected pan gesture.

PinchGesture

The PinchGesture class contains the details of a detected pinch gesture.

RotateGesture

The RotateGesture class contains the details of a detected rotate gesture.

TapGesture

The TapGesture class contains the details of a detected tap gesture.

TouchGesturesModule

The TouchGesturesModule class enables touch gesture detection.

Enums

EnumDescription

State

The State enum describes the state of a Gesture.

Type

The Type enum describes a touch gesture.

Units Module

Classes

ClassDescription

UnitsModule

The UnitsModule class provides functionality for converting values into world-space units.

Enums

EnumDescription

WorldUnits

The WorldUnit enum describes the unit of measurement used in world-space.

Weather Module

Classes

ClassDescription

WeatherModule

The WeatherModule class provides information about the current weather