Lens Scripting API
    Preparing search index...

    Class CompositionLayerRenderComponentWearable Only

    Controls the rendering behavior of a composition layer, including when it should be re-rendered and adaptive resolution settings.

    Lens Scripting Version 370

    Hierarchy (View Summary)

    Index

    Properties

    adaptiveResolutionEnabled adaptiveResolutionRoundingMultiple adaptiveResolutionScaler enabled isBeingDestroyed isEnabledInHierarchy sceneObject uniqueIdentifier updateModes

    Methods

    destroy getSceneObject getTransform getTypeName getTypeName isOfType isSame requestRender

    Properties

    adaptiveResolutionEnabled: boolean

    If true, the composition layer's render resolution is dynamically scaled based on the projected screen-space size of the layer in the main camera's view.

    Lens Scripting Version 370

    false
    @wearableOnly
    adaptiveResolutionRoundingMultiple: number

    The final render resolution will be rounded to the nearest higher multiple of this value. Only used if adaptiveResolutionEnabled is true.

    Lens Scripting Version 370

    32
    @wearableOnly
    adaptiveResolutionScaler: number

    The scaler for adaptive resolution. The final render resolution will be the composition layer's screen size multiplied by this scaler. Only used if adaptiveResolutionEnabled is true.

    Lens Scripting Version 370

    1
    @wearableOnly
    enabled: boolean

    If disabled, the Component will stop enacting its behavior.

    true
    isBeingDestroyed: boolean

    Returns true if this Component is currently being destroyed. Becomes true as soon as destruction begins via Component#destroy or destruction of its owning SceneObject, before any OnDestroyEvent callbacks fire.

    Lens Scripting Version 364

    if (!script.isBeingDestroyed) {
        // Component is still fully alive
    }
    isEnabledInHierarchy: boolean

    Returns true if this Component, its SceneObject, and all of that SceneObjects parents are enabled.

    sceneObject: SceneObject

    The SceneObject this component is on.

    uniqueIdentifier: string

    Lens Scripting Version 176

    updateModes: number

    Controls when the composition layer should be (re-)rendered - by default Visibility.

    Lens Scripting Version 370

    CompositionLayer.Render.UpdateMode.Visibility
    @wearableOnly

    Methods

    • Destroys the component.

      Returns void

    • Wearable Only

      Returns the fully-qualified JavaScript type name for this class (for example, "Component.Camera"). This is a static accessor (no instance required) and returns the same value as the instance getTypeName().

      Returns string

      Lens Scripting Version 370

    • Returns the name of this object's type.

      Returns string

    • Returns true if the object matches or derives from the passed in type.

      Parameters

      • type: string

      Returns boolean

    • Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

      Parameters

      Returns boolean

    • Wearable Only

      Requests the composition layer to be re-rendered on the next frame. Only meaningful when updateModes includes Manual.

      Returns void

      Lens Scripting Version 370

    Settings

    Member Visibility

    On This Page

    Properties
    Methods