Web Components API Reference - v0.2.5
    Preparing search index...

    Class CameraComponentElement

    The CameraComponentElement interface provides properties and methods for manipulating <pc-camera> elements. The CameraComponentElement interface also inherits the properties and methods of the HTMLElement interface.

    Hierarchy (View Summary)

    Index

    Accessors

    • get enabled(): boolean

      Gets the enabled state of the component.

      Returns boolean

      The enabled state of the component.

    • set enabled(value: boolean): void

      Sets the enabled state of the component.

      Parameters

      • value: boolean

        The enabled state of the component.

      Returns void

    • get horizontalFov(): boolean

      Gets whether the camera's field of view (fov) is horizontal or vertical.

      Returns boolean

      Whether the camera's field of view is horizontal.

    • set horizontalFov(value: boolean): void

      Sets whether the camera's field of view (fov) is horizontal or vertical. Defaults to false (meaning it is vertical be default).

      Parameters

      • value: boolean

        Whether the camera's field of view is horizontal.

      Returns void

    • get tonemap(): | "none"
      | "linear"
      | "filmic"
      | "hejl"
      | "aces"
      | "aces2"
      | "neutral"

      Gets the tone mapping of the camera.

      Returns "none" | "linear" | "filmic" | "hejl" | "aces" | "aces2" | "neutral"

      The tone mapping.

    • set tonemap(
          value:
              | "none"
              | "linear"
              | "filmic"
              | "hejl"
              | "aces"
              | "aces2"
              | "neutral",
      ): void

      Sets the tone mapping of the camera.

      Parameters

      • value: "none" | "linear" | "filmic" | "hejl" | "aces" | "aces2" | "neutral"

        The tone mapping.

      Returns void

    Methods

    • Starts the camera in XR mode.

      Parameters

      • type: "immersive-ar" | "immersive-vr"

        The type of XR mode to start.

      • space: "bounded-floor" | "local" | "local-floor" | "unbounded" | "viewer"

        The space to start the camera in.

      Returns void