Skip to main content

ScreenRegionType

Enum

Types of screen regions that can be used with ScreenRegionComponent.

  • Available on all platforms
Platform details: Snapchat, SPECS, Camera Kit Web, Camera Kit Mobile fully supported.

Platform details

  • Snapchat — Fully supported.

  • SPECS — Fully supported.

  • Camera Kit Web — Fully supported.

  • Camera Kit Mobile — Fully supported.

Since Lens Scripting v272

Index

Example

// @input Component.ScreenRegionComponent screenRegionComponent

script.screenRegionComponent.region = ScreenRegionType.Capture;

Enumeration Members

Capture

Capture: number

The screen area shown to the user when recording. On some devices, this region is a subset of FullFrame region.

Since

Lens Scripting Version 272


FullFrame

FullFrame: number

The entire screen area of the device.

Since

Lens Scripting Version 272


Preview

Preview: number

The screen area shown to the user when previewing a Snap. On some devices, this region is a subset of Capture region.

Since

Lens Scripting Version 272


RoundButton

RoundButton: number

The screen area where the round "Snap" button is drawn.

Since

Lens Scripting Version 272


SafeRender

SafeRender: number

A screen area that will be visible on all devices and won't overlap Snapchat UI. Safe area to place any UI elements.

Since

Lens Scripting Version 272