Skip to main content

CompositionLayer.Render.UpdateMode

Enum

Determines when a composition layer should be (re-)rendered.

  • Snapchat: not supported
  • SPECS: fully supported
  • Camera Kit Web: not supported
  • Camera Kit Mobile: not supported
  • SnapchatNot supported — SPECS only
  • SPECSFully supported
  • Camera Kit WebNot supported — SPECS only
  • Camera Kit MobileNot supported — SPECS only

Platform details

  • Snapchat — Not supported — SPECS only.

  • SPECS — Fully supported.

  • Camera Kit Web — Not supported — SPECS only.

  • Camera Kit Mobile — Not supported — SPECS only.

Since Lens Scripting v370

Determines when a composition layer should be (re-)rendered. Values are combinable bit flags — multiple modes can be OR'd together so the layer re-renders when any of the conditions is met.

Index

Enumeration Members

Always

Always: number

SPECS only

The composition layer is re-rendered unconditionally every frame.

Since

Lens Scripting Version 370


Interaction

Interaction: number

SPECS only

The composition layer is re-rendered when a hand targeting ray intersects its layer geometry.

Since

Lens Scripting Version 370


Manual

Manual: number

SPECS only

The composition layer is re-rendered only when explicitly requested via CompositionLayerRenderComponent#requestRender.

Since

Lens Scripting Version 370


Once

Once: number

SPECS only

The composition layer is rendered exactly once on the first frame after activation and never again unless the mode is reset.

Since

Lens Scripting Version 370


Visibility

Visibility: number

SPECS only

The composition layer is re-rendered when it is visible within the main camera's frustum.

Since

Lens Scripting Version 370