Method Detail

• Capturable

  @Deprecated(message = This Composable method has been deprecated & will be removed in the future releases. Use Modifier `capturable()` directly., level = DeprecationLevel.WARNING)@Composable() final static Unit Capturable(CaptureController controller, Modifier modifier, Function2<ImageBitmap, Throwable, Unit> onCaptured, Function0<Unit> content)

  Deprecated: Use Modifier.capturable for replacement.

  A composable with content which supports to capture ImageBitmap from a content.

  Example usage:

  val captureController = rememberCaptureController()
  Capturable(
      controller = captureController,
      onCaptured = { bitmap, error ->
          // Do something with [bitmap]
          // Handle [error] if required
      }
  ) {
      // Composable content
  }
  
  Button(onClick = {
      // Capture content
      captureController.capture()
  }) { ... }

  Parameters:

  controller - A CaptureController which gives control to capture the content.

  modifier - The Modifier to be applied to the layout.

  onCaptured - The callback which gives back ImageBitmap after composable is captured.

  content - Composable content to be captured.

• capturable

   final static Modifier capturable(Modifier $self, CaptureController controller)

  Adds a capture-ability on the Composable which can draw Bitmap from the Composable component.

  Example usage:

  val captureController = rememberCaptureController()
  val uiScope = rememberCoroutineScope()
  
  // The content to be captured in to Bitmap
  Column(
      modifier = Modifier.capturable(captureController),
  ) {
      // Composable content
  }
  
  Button(onClick = {
      // Capture content
      val bitmapAsync = captureController.captureAsync()
      try {
          val bitmap = bitmapAsync.await()
          // Do something with `bitmap`.
      } catch (error: Throwable) {
          // Error occurred, do something.
      }
  }) { ... }

  Parameters:

  controller - A CaptureController which gives control to capture the Composable content.