admin/AndroidJetpack
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
main
AndroidJetpack/Capturable/docs/capturable/dev.shreyaspatil.capturable/-capturable-kt/-capturable.html
T
coco 723ce1af5c a
2026-07-03 15:12:48 +08:00

39 lines
8.5 KiB
HTML
Raw Permalink Blame History

This file contains invisible Unicode characters
This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>Capturable</title>
<link href="../../../images/logo-icon.svg" rel="icon" type="image/svg"><script>var pathToRoot = "../../../";</script><script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async="async"></script><link href="../../../styles/style.css" rel="Stylesheet"><link href="../../../styles/logo-styles.css" rel="Stylesheet"><link href="../../../styles/jetbrains-mono.css" rel="Stylesheet"><link href="../../../styles/main.css" rel="Stylesheet"><script type="text/javascript" src="../../../scripts/clipboard.js" async="async"></script><script type="text/javascript" src="../../../scripts/navigation-loader.js" async="async"></script><script type="text/javascript" src="../../../scripts/platform-content-handler.js" async="async"></script><script type="text/javascript" src="../../../scripts/main.js" async="async"></script> </head>
<body>
<div id="container">
<div id="leftColumn"><a href="../../../index.html">
<div id="logo"></div>
</a>
<div id="paneSearch"></div>
<div id="sideMenu"></div>
</div>
<div id="main">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<script type="text/javascript" src="../../../scripts/main.js"></script> <div class="main-content" id="content" pageIds="capturable::dev.shreyaspatil.capturable/CapturableKt/Capturable/#dev.shreyaspatil.capturable.controller.CaptureController#androidx.compose.ui.Modifier#kotlin.Function2[androidx.compose.ui.graphics.ImageBitmap?,kotlin.Throwable?,kotlin.Unit]#kotlin.Function0[kotlin.Unit]/PointingToDeclaration//936064587">
<div class="navigation-wrapper" id="navigation-wrapper">
<div class="breadcrumbs"><a href="../../../index.html">capturable</a>/<a href="../index.html">dev.shreyaspatil.capturable</a>/<a href="index.html">CapturableKt</a>/<a href="-capturable.html">Capturable</a></div>
<div class="pull-right d-flex">
<div id="searchBar"></div>
</div>
</div>
<div class="cover ">
<h1 class="cover"><span><span>Capturable</span></span></h1>
</div>
<div class="divergent-group" data-filterable-current=":capturable:dokkaHtml/release" data-filterable-set=":capturable:dokkaHtml/release"><div class="with-platform-tags"><span class="pull-right"></span></div>
<div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":capturable:dokkaHtml/release"><div class="symbol monospace block"><div class="block"><div class="block">@<span data-unresolved-link="androidx.compose.runtime/Composable///PointingToDeclaration/">Composable</span>()</div></div>final static <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a> <a href="-capturable.html">Capturable</a>(<a href="../../dev.shreyaspatil.capturable.controller/-capture-controller/index.html">CaptureController</a> controller, <span data-unresolved-link="androidx.compose.ui/Modifier///PointingToDeclaration/">Modifier</span> modifier, <span data-unresolved-link="kotlin.jvm.functions/Function2///PointingToDeclaration/">Function2</span>&lt;<span data-unresolved-link="androidx.compose.ui.graphics/ImageBitmap///PointingToDeclaration/">ImageBitmap</span>, <a href="https://developer.android.com/reference/kotlin/java/lang/Throwable.html">Throwable</a>, <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a>&gt; onCaptured, <span data-unresolved-link="kotlin.jvm.functions/Function0///PointingToDeclaration/">Function0</span>&lt;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a>&gt; content)<span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
</div>
<p class="paragraph">A composable with <span data-unresolved-link="dev.shreyaspatil.capturable//Capturable/#dev.shreyaspatil.capturable.controller.CaptureController#androidx.compose.ui.Modifier#kotlin.Function2[androidx.compose.ui.graphics.ImageBitmap?,kotlin.Throwable?,kotlin.Unit]#kotlin.Function0[kotlin.Unit]/PointingToCallableParameters(3)/">content</span> which supports to capture <span data-unresolved-link="androidx.compose.ui.graphics/ImageBitmap///PointingToDeclaration/">ImageBitmap</span> from a <span data-unresolved-link="dev.shreyaspatil.capturable//Capturable/#dev.shreyaspatil.capturable.controller.CaptureController#androidx.compose.ui.Modifier#kotlin.Function2[androidx.compose.ui.graphics.ImageBitmap?,kotlin.Throwable?,kotlin.Unit]#kotlin.Function0[kotlin.Unit]/PointingToCallableParameters(3)/">content</span>.</p><p class="paragraph">Example usage:</p><div class="sample-container"><code class="" theme="idea"><pre>val captureController = rememberCaptureController()<br>Capturable(<br> controller = captureController,<br> onCaptured = { bitmap -&gt;<br> // Do something with [bitmap]<br> }<br>) {<br> // Composable content<br>}<br><br>Button(onClick = {<br> // Capture content<br> captureController.capture()<br>}) { ... }</pre></code></div><h2 class="">Parameters</h2><div data-togglable="Parameters"><div class="platform-hinted WithExtraAttributes" data-platform-hinted="data-platform-hinted" data-togglable="Parameters"><div class="content sourceset-depenent-content" data-active="" data-togglable=":capturable:dokkaHtml/release"><div data-togglable="Parameters"><div class="table" data-togglable="Parameters"><div class="table-row" data-filterable-current=":capturable:dokkaHtml/release" data-filterable-set=":capturable:dokkaHtml/release"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><span><span>controller</span></span></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">A <a href="../../dev.shreyaspatil.capturable.controller/-capture-controller/index.html">CaptureController</a> which gives control to capture the <span data-unresolved-link="dev.shreyaspatil.capturable//Capturable/#dev.shreyaspatil.capturable.controller.CaptureController#androidx.compose.ui.Modifier#kotlin.Function2[androidx.compose.ui.graphics.ImageBitmap?,kotlin.Throwable?,kotlin.Unit]#kotlin.Function0[kotlin.Unit]/PointingToCallableParameters(3)/">content</span>.</p></div></div></div></div></div><div class="table-row" data-filterable-current=":capturable:dokkaHtml/release" data-filterable-set=":capturable:dokkaHtml/release"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><span><span>modifier</span></span></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">The <span data-unresolved-link="androidx.compose.ui/Modifier///PointingToDeclaration/">Modifier</span> to be applied to the layout.</p></div></div></div></div></div><div class="table-row" data-filterable-current=":capturable:dokkaHtml/release" data-filterable-set=":capturable:dokkaHtml/release"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><span>on</span><wbr></wbr><span><span>Captured</span></span></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">The callback which gives back <span data-unresolved-link="androidx.compose.ui.graphics/ImageBitmap///PointingToDeclaration/">ImageBitmap</span> after composable is captured. If any error is occurred while capturing bitmap, <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html">Throwable</a> is provided.</p></div></div></div></div></div><div class="table-row" data-filterable-current=":capturable:dokkaHtml/release" data-filterable-set=":capturable:dokkaHtml/release"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><span><span>content</span></span></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph"><span data-unresolved-link="androidx.compose.runtime/Composable///PointingToDeclaration/">Composable</span> content to be captured.</p></div></div></div></div></div></div></div></div></div></div></div>
</div>
<div class="footer"><span class="go-to-top-icon"><a href="#content"></a></span><span>© 2022 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span></div>
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink