Skip to main content

CoachingOverlay.pipelineModule()

CoachingOverlay.pipelineModule()

Description​

Creates a pipeline module that, when installed, adds Coaching Overlay functionality to your absolute scale project.

Parameters​

None

Returns​

A pipeline module that adds a Coaching Overlay to your project.

Non-AFrame Example​

// Configured here
CoachingOverlay.configure({
    animationColor: '#E86FFF',
    promptText: 'To generate scale push your phone forward and then pull back',
})
XR8.addCameraPipelineModules([
  XR8.GlTextureRenderer.pipelineModule(),
  XR8.Threejs.pipelineModule(),
  XR8.XrController.pipelineModule(),
  XRExtras.FullWindowCanvas.pipelineModule(),
  XRExtras.Loading.pipelineModule(),
  XRExtras.RuntimeError.pipelineModule(),
  LandingPage.pipelineModule(),
  // Added here
  CoachingOverlay.pipelineModule(),
  ...
])