Skip to content

Commit

Permalink
Dokka docs - sceneview-android
Browse files Browse the repository at this point in the history
  • Loading branch information
ThomasGorisse committed Dec 11, 2023
1 parent 9339c0d commit 20aea40
Show file tree
Hide file tree
Showing 259 changed files with 10,120 additions and 4,061 deletions.
18 changes: 18 additions & 0 deletions api/sceneview-android/arsceneview/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,24 @@ <h2 class="">Packages</h2>
<div></div>
</div>
</div>
<a data-name="-1196072453%2FPackages%2F1238612933" anchor-label="io.github.sceneview.ar.light" id="-1196072453%2FPackages%2F1238612933" data-filterable-set=":arsceneview:dokkaHtmlPartial/release"></a>
<div class="table-row" data-filterable-current=":arsceneview:dokkaHtmlPartial/release" data-filterable-set=":arsceneview:dokkaHtmlPartial/release">
<div>
<div class="main-subrow ">
<div class=""><span class="inline-flex">
<div><a href="io.github.sceneview.ar.light/index.html">io.github.sceneview.ar.light</a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1196072453%2FPackages%2F1238612933"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div class="pull-right">
<div class="platform-tags no-gutters">
<div class="platform-tag jvm-like">androidJvm</div>
</div>
</div>
</div>
<div></div>
</div>
</div>
<a data-name="90867841%2FPackages%2F1238612933" anchor-label="io.github.sceneview.ar.node" id="90867841%2FPackages%2F1238612933" data-filterable-set=":arsceneview:dokkaHtmlPartial/release"></a>
<div class="table-row" data-filterable-current=":arsceneview:dokkaHtmlPartial/release" data-filterable-set=":arsceneview:dokkaHtmlPartial/release">
<div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -83,21 +83,6 @@ <h2 class="">Types</h2>
</div>
</div>
</div>
<a data-name="-1034800475%2FClasslikes%2F1238612933" anchor-label="LightEstimator" id="-1034800475%2FClasslikes%2F1238612933" data-filterable-set=":arsceneview:dokkaHtmlPartial/release"></a>
<div class="table-row" data-filterable-current=":arsceneview:dokkaHtmlPartial/release" data-filterable-set=":arsceneview:dokkaHtmlPartial/release">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-light-estimator/index.html"><span>Light</span><wbr><span><span>Estimator</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1034800475%2FClasslikes%2F1238612933"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":arsceneview:dokkaHtmlPartial/release"><div class="symbol monospace"><span class="token keyword">class </span><a href="-light-estimator/index.html">LightEstimator</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">val </span>engine<span class="token operator">: </span><span data-unresolved-link="com.google.android.filament/Engine///PointingToDeclaration/">Engine</span><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>iblPrefilter<span class="token operator">: </span><a href="../../sceneview/io.github.sceneview.environment/-i-b-l-prefilter/index.html">IBLPrefilter</a></span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Per frame AR light estimation</p></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
<div data-togglable="EXTENSION_PROPERTY">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,12 +58,12 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageids="arsceneview::io.github.sceneview.ar.camera/ARCameraStream/ARCameraStream/#com.google.android.filament.Engine#io.github.sceneview.loaders.MaterialLoader#kotlin.String#kotlin.String/PointingToDeclaration//1238612933">
<div class="main-content" data-page-type="member" id="content" pageids="arsceneview::io.github.sceneview.ar.camera/ARCameraStream/ARCameraStream/#io.github.sceneview.loaders.MaterialLoader#kotlin.String#kotlin.String/PointingToDeclaration//1238612933">
<div class="breadcrumbs"><a href="../../index.html">arsceneview</a><span class="delimiter">/</span><a href="../index.html">io.github.sceneview.ar.camera</a><span class="delimiter">/</span><a href="index.html">ARCameraStream</a><span class="delimiter">/</span><span class="current">ARCameraStream</span></div>
<div class="cover ">
<h1 class="cover"><span>ARCamera</span><wbr><span><span>Stream</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":arsceneview:dokkaHtmlPartial/release"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">engine<span class="token operator">: </span><span data-unresolved-link="com.google.android.filament/Engine///PointingToDeclaration/">Engine</span><span class="token punctuation">, </span></span><span class="parameter ">materialLoader<span class="token operator">: </span><a href="../../../sceneview/io.github.sceneview.loaders/-material-loader/index.html">MaterialLoader</a><span class="token punctuation">, </span></span><span class="parameter ">standardMaterialFile<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator"> = </span><span class="token string">"materials/camera_stream_flat.filamat"</span><span class="token punctuation">, </span></span><span class="parameter ">depthOcclusionMaterialFile<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator"> = </span><span class="token string">"materials/camera_stream_depth.filamat"</span></span></span><span class="token punctuation">)</span></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":arsceneview:dokkaHtmlPartial/release"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">materialLoader<span class="token operator">: </span><a href="../../../sceneview/io.github.sceneview.loaders/-material-loader/index.html">MaterialLoader</a><span class="token punctuation">, </span></span><span class="parameter ">standardMaterialFile<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator"> = </span><span class="token string">"materials/camera_stream_flat.filamat"</span><span class="token punctuation">, </span></span><span class="parameter ">depthOcclusionMaterialFile<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator"> = </span><span class="token string">"materials/camera_stream_depth.filamat"</span></span></span><span class="token punctuation">)</span></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 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>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,24 +62,24 @@
<div class="breadcrumbs"><a href="../../index.html">arsceneview</a><span class="delimiter">/</span><a href="../index.html">io.github.sceneview.ar.camera</a><span class="delimiter">/</span><span class="current">ARCameraStream</span></div>
<div class="cover ">
<h1 class="cover"><span>ARCamera</span><wbr><span><span>Stream</span></span></h1>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":arsceneview:dokkaHtmlPartial/release"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">class </span><a href="index.html">ARCameraStream</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">val </span>engine<span class="token operator">: </span><span data-unresolved-link="com.google.android.filament/Engine///PointingToDeclaration/">Engine</span><span class="token punctuation">, </span></span><span class="parameter ">materialLoader<span class="token operator">: </span><a href="../../../sceneview/io.github.sceneview.loaders/-material-loader/index.html">MaterialLoader</a><span class="token punctuation">, </span></span><span class="parameter ">standardMaterialFile<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator"> = </span><span class="token string">"materials/camera_stream_flat.filamat"</span><span class="token punctuation">, </span></span><span class="parameter ">depthOcclusionMaterialFile<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator"> = </span><span class="token string">"materials/camera_stream_depth.filamat"</span></span></span><span class="token punctuation">)</span> : <a href="../../../sceneview/io.github.sceneview.components/-renderable-component/index.html">RenderableComponent</a></div><p class="paragraph">Displays the Camera stream using Filament.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":arsceneview:dokkaHtmlPartial/release"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">class </span><a href="index.html">ARCameraStream</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">materialLoader<span class="token operator">: </span><a href="../../../sceneview/io.github.sceneview.loaders/-material-loader/index.html">MaterialLoader</a><span class="token punctuation">, </span></span><span class="parameter ">standardMaterialFile<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator"> = </span><span class="token string">"materials/camera_stream_flat.filamat"</span><span class="token punctuation">, </span></span><span class="parameter ">depthOcclusionMaterialFile<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator"> = </span><span class="token string">"materials/camera_stream_depth.filamat"</span></span></span><span class="token punctuation">)</span> : <a href="../../../sceneview/io.github.sceneview.components/-renderable-component/index.html">RenderableComponent</a></div><p class="paragraph">Displays the Camera stream using Filament.</p></div></div>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>
<div class="tabs-section-body">
<div data-togglable="CONSTRUCTOR">
<h2 class="">Constructors</h2>
<div class="table"><a data-name="303867769%2FConstructors%2F1238612933" anchor-label="ARCameraStream" id="303867769%2FConstructors%2F1238612933" data-filterable-set=":arsceneview:dokkaHtmlPartial/release"></a>
<div class="table"><a data-name="199484541%2FConstructors%2F1238612933" anchor-label="ARCameraStream" id="199484541%2FConstructors%2F1238612933" data-filterable-set=":arsceneview:dokkaHtmlPartial/release"></a>
<div class="table-row" data-togglable="CONSTRUCTOR" data-filterable-current=":arsceneview:dokkaHtmlPartial/release" data-filterable-set=":arsceneview:dokkaHtmlPartial/release">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-a-r-camera-stream.html"><span>ARCamera</span><wbr><span><span>Stream</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="303867769%2FConstructors%2F1238612933"></span>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="199484541%2FConstructors%2F1238612933"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":arsceneview:dokkaHtmlPartial/release"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">engine<span class="token operator">: </span><span data-unresolved-link="com.google.android.filament/Engine///PointingToDeclaration/">Engine</span><span class="token punctuation">, </span></span><span class="parameter ">materialLoader<span class="token operator">: </span><a href="../../../sceneview/io.github.sceneview.loaders/-material-loader/index.html">MaterialLoader</a><span class="token punctuation">, </span></span><span class="parameter ">standardMaterialFile<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator"> = </span><span class="token string">"materials/camera_stream_flat.filamat"</span><span class="token punctuation">, </span></span><span class="parameter ">depthOcclusionMaterialFile<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator"> = </span><span class="token string">"materials/camera_stream_depth.filamat"</span></span></span><span class="token punctuation">)</span></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":arsceneview:dokkaHtmlPartial/release"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">materialLoader<span class="token operator">: </span><a href="../../../sceneview/io.github.sceneview.loaders/-material-loader/index.html">MaterialLoader</a><span class="token punctuation">, </span></span><span class="parameter ">standardMaterialFile<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator"> = </span><span class="token string">"materials/camera_stream_flat.filamat"</span><span class="token punctuation">, </span></span><span class="parameter ">depthOcclusionMaterialFile<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator"> = </span><span class="token string">"materials/camera_stream_depth.filamat"</span></span></span><span class="token punctuation">)</span></div></div></div>
</div>
</div>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ <h2 class="">Types</h2>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":arsceneview:dokkaHtmlPartial/release"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">class </span><a href="-a-r-camera-stream/index.html">ARCameraStream</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">val </span>engine<span class="token operator">: </span><span data-unresolved-link="com.google.android.filament/Engine///PointingToDeclaration/">Engine</span><span class="token punctuation">, </span></span><span class="parameter ">materialLoader<span class="token operator">: </span><a href="../../sceneview/io.github.sceneview.loaders/-material-loader/index.html">MaterialLoader</a><span class="token punctuation">, </span></span><span class="parameter ">standardMaterialFile<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator"> = </span><span class="token string">"materials/camera_stream_flat.filamat"</span><span class="token punctuation">, </span></span><span class="parameter ">depthOcclusionMaterialFile<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator"> = </span><span class="token string">"materials/camera_stream_depth.filamat"</span></span></span><span class="token punctuation">)</span> : <a href="../../sceneview/io.github.sceneview.components/-renderable-component/index.html">RenderableComponent</a></div><div class="brief "><p class="paragraph">Displays the Camera stream using Filament.</p></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":arsceneview:dokkaHtmlPartial/release"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">class </span><a href="-a-r-camera-stream/index.html">ARCameraStream</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">materialLoader<span class="token operator">: </span><a href="../../sceneview/io.github.sceneview.loaders/-material-loader/index.html">MaterialLoader</a><span class="token punctuation">, </span></span><span class="parameter ">standardMaterialFile<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator"> = </span><span class="token string">"materials/camera_stream_flat.filamat"</span><span class="token punctuation">, </span></span><span class="parameter ">depthOcclusionMaterialFile<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator"> = </span><span class="token string">"materials/camera_stream_depth.filamat"</span></span></span><span class="token punctuation">)</span> : <a href="../../sceneview/io.github.sceneview.components/-renderable-component/index.html">RenderableComponent</a></div><div class="brief "><p class="paragraph">Displays the Camera stream using Filament.</p></div></div></div>
</div>
</div>
</div>
Expand Down
Loading

0 comments on commit 20aea40

Please sign in to comment.