-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathapi.html
More file actions
229 lines (216 loc) · 19.9 KB
/
api.html
File metadata and controls
229 lines (216 loc) · 19.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
<title>API Reference — SceneView</title>
<meta name="description" content="SceneView API reference documentation for Android — SceneView 3D and ArSceneView AR."/>
<link rel="icon" href="icon.png"/>
<link rel="stylesheet" href="css/styles.css"/>
<style>
/* Inline fallback — ensures styles render when external CSS can't load */
@import url('https://fonts.googleapis.com/css2?family=Roboto:wght@400;500;700&display=swap');
*,*::before,*::after{box-sizing:border-box;margin:0;padding:0}
:root{--bg:#ffffff;--bg-soft:#f8f9fa;--bg-muted:#f1f3f4;--surface:#ffffff;--border:#dadce0;--border-light:#e8eaed;--text:#202124;--text-secondary:#5f6368;--text-muted:#80868b;--accent:#1a73e8;--accent-soft:#e8f0fe;--accent-hover:#1765cc;--accent-text:#ffffff;--green:#1e8e3e;--green-soft:#e6f4ea;--cyan:#129eaf;--cyan-soft:#e4f7fb;--font-sans:'Roboto',system-ui,-apple-system,'Segoe UI',sans-serif;--font-head:'Google Sans Display','Roboto',system-ui,sans-serif;--font-mono:'Roboto Mono','Fira Code',ui-monospace,monospace;--section-gap:clamp(3.5rem,8vw,5.5rem);--container:1140px;--radius:8px;--radius-lg:12px;--radius-xl:16px;--shadow-sm:0 1px 2px 0 rgba(60,64,67,0.1);--shadow:0 1px 2px 0 rgba(60,64,67,0.3),0 1px 3px 1px rgba(60,64,67,0.15);--shadow-md:0 1px 3px 0 rgba(60,64,67,0.3),0 4px 8px 3px rgba(60,64,67,0.15);--ease:cubic-bezier(0.4,0,0.2,1)}
html{scroll-behavior:smooth;-webkit-text-size-adjust:100%}body{font-family:var(--font-sans);font-size:15px;line-height:1.6;color:var(--text);background:var(--bg);-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale;overflow-x:hidden}
img{display:block;max-width:100%;height:auto}a{color:inherit;text-decoration:none}
code{font-family:var(--font-mono);font-size:0.875em;background:var(--bg-muted);padding:2px 6px;border-radius:4px}
h1,h2,h3,h4{font-family:var(--font-head);font-weight:500;line-height:1.25;letter-spacing:-0.01em;color:var(--text)}
.text-gradient{background:linear-gradient(135deg,var(--accent) 0%,#34a853 100%);-webkit-background-clip:text;-webkit-text-fill-color:transparent;background-clip:text}
.section{padding:var(--section-gap) 0;max-width:var(--container);margin:0 auto;padding-left:clamp(1.5rem,4vw,3rem);padding-right:clamp(1.5rem,4vw,3rem)}
.section__header{text-align:center;margin-bottom:2.5rem}
.section__label{display:inline-flex;align-items:center;gap:6px;font-family:var(--font-head);font-size:0.75rem;font-weight:500;letter-spacing:0.1em;text-transform:uppercase;color:var(--accent);margin-bottom:0.625rem}
.section__label::before{content:'';width:5px;height:5px;border-radius:50%;background:var(--accent)}
.section__title{font-size:clamp(1.625rem,3.5vw,2.25rem);font-weight:500;margin-bottom:0.625rem}
.section__subtitle{font-size:1rem;color:var(--text-secondary);max-width:560px;margin:0 auto;line-height:1.65}
.grid-2{display:grid;grid-template-columns:repeat(2,1fr);gap:1.25rem}
.grid-3{display:grid;grid-template-columns:repeat(3,1fr);gap:1.25rem}
@media(max-width:900px){.grid-3{grid-template-columns:repeat(2,1fr)}}
@media(max-width:600px){.grid-2{grid-template-columns:1fr}.grid-3{grid-template-columns:1fr}}
.nav{position:sticky;top:0;z-index:100;display:flex;align-items:center;gap:0.75rem;max-width:var(--container);margin:0 auto;padding:0.75rem clamp(1.5rem,4vw,3rem);background:rgba(255,255,255,0.92);backdrop-filter:blur(12px);-webkit-backdrop-filter:blur(12px);border-bottom:1px solid var(--border-light)}
.nav__logo{display:flex;align-items:center;gap:8px;font-family:var(--font-head);font-weight:500;font-size:1.0625rem;color:var(--text);flex-shrink:0}.nav__logo img{width:28px;height:28px;border-radius:6px}
.nav__links{display:flex;list-style:none;gap:0;margin-left:auto}
.nav__links a{display:block;padding:0.4375rem 0.75rem;font-size:0.875rem;font-weight:500;color:var(--text-secondary);border-radius:var(--radius);transition:color .15s var(--ease),background .15s var(--ease)}
.nav__links a:hover{color:var(--text);background:var(--bg-muted)}.nav__links a.active{color:var(--accent);background:var(--accent-soft)}
.nav__github{display:inline-flex;align-items:center;gap:5px;padding:0.4375rem 0.875rem;margin-left:0.25rem;font-size:0.8125rem;font-weight:500;color:var(--text-secondary);background:var(--bg-muted);border-radius:var(--radius);transition:background .15s var(--ease);flex-shrink:0}.nav__github:hover{background:var(--border)}
.nav__menu-btn{display:none;background:none;border:none;padding:0.4375rem;cursor:pointer;color:var(--text);border-radius:var(--radius);margin-left:auto}.nav__menu-btn:hover{background:var(--bg-muted)}
.nav__mobile{display:none;position:fixed;top:0;left:0;right:0;bottom:0;z-index:99;background:var(--bg);padding:4.5rem 1.5rem 1.5rem;flex-direction:column;gap:0.125rem}
.nav__mobile.open{display:flex}.nav__mobile a{display:block;padding:0.875rem 1rem;font-size:1rem;font-weight:500;color:var(--text-secondary);border-radius:var(--radius-lg)}.nav__mobile a:hover{background:var(--bg-muted)}.nav__mobile a.active{color:var(--accent);background:var(--accent-soft)}
@media(max-width:768px){.nav__links{display:none}.nav__github{display:none}.nav__menu-btn{display:block}}
.btn{display:inline-flex;align-items:center;gap:6px;padding:0.625rem 1.375rem;font-family:var(--font-head);font-size:0.875rem;font-weight:500;border-radius:var(--radius);border:none;cursor:pointer;transition:all .15s var(--ease);white-space:nowrap;letter-spacing:0.01em}
.btn--primary{background:var(--accent);color:var(--accent-text);box-shadow:var(--shadow-sm)}.btn--primary:hover{background:var(--accent-hover);box-shadow:var(--shadow)}
.btn--outline{background:var(--bg);color:var(--text);border:1px solid var(--border)}.btn--outline:hover{background:var(--bg-soft)}
.btn--sm{padding:0.4375rem 0.875rem;font-size:0.8125rem}
.tag{display:inline-block;padding:2px 8px;font-size:0.6875rem;font-weight:500;border-radius:4px;background:var(--bg-muted);color:var(--text-secondary);letter-spacing:0.01em}
.tag--accent{background:var(--accent-soft);color:var(--accent)}.tag--cyan{background:var(--cyan-soft);color:var(--cyan)}.tag--green{background:var(--green-soft);color:var(--green)}
.page-hero{text-align:center;padding:clamp(2.5rem,6vw,4rem) clamp(1.5rem,4vw,3rem) clamp(1.5rem,3vw,2.5rem);max-width:660px;margin:0 auto}
.page-hero__title{font-size:clamp(1.75rem,4.5vw,2.5rem);font-weight:500;letter-spacing:-0.02em;margin-bottom:0.75rem}
.page-hero__subtitle{font-size:1rem;color:var(--text-secondary);line-height:1.65;max-width:520px;margin:0 auto}
.feature-item{display:grid;grid-template-columns:1fr 1fr;gap:2.5rem;align-items:center;padding:2.5rem 0;border-bottom:1px solid var(--border-light)}
.feature-item:last-child{border-bottom:none}.feature-item:nth-child(even) .feature-item__media{order:-1}
.feature-item__badge{display:inline-block;padding:3px 10px;font-family:var(--font-head);font-size:0.6875rem;font-weight:500;letter-spacing:0.06em;text-transform:uppercase;border-radius:4px;background:var(--accent-soft);color:var(--accent);margin-bottom:0.75rem}
.feature-item__title{font-size:1.375rem;font-weight:500;letter-spacing:-0.01em;margin-bottom:0.625rem}
.feature-item__desc{font-size:0.875rem;color:var(--text-secondary);line-height:1.65}
.feature-item__media{border-radius:var(--radius-lg);overflow:hidden;border:1px solid var(--border-light);box-shadow:var(--shadow-sm)}
.feature-item__media img{width:100%;aspect-ratio:16/9;object-fit:cover}
@media(max-width:768px){.feature-item{grid-template-columns:1fr;gap:1.25rem}.feature-item:nth-child(even) .feature-item__media{order:0}}
.api-card{display:flex;flex-direction:column;gap:0.875rem;background:var(--surface);border:1px solid var(--border-light);border-radius:var(--radius-lg);padding:1.75rem;transition:border-color .15s var(--ease),box-shadow .15s var(--ease)}
.api-card:hover{border-color:var(--accent);box-shadow:var(--shadow-md)}
.api-card__title{font-family:var(--font-mono);font-weight:500;font-size:1.0625rem}
.api-card__desc{font-size:0.875rem;color:var(--text-secondary);line-height:1.6}
.card{background:var(--surface);border:1px solid var(--border-light);border-radius:var(--radius-lg);padding:1.5rem;display:flex;flex-direction:column;transition:border-color .15s var(--ease),box-shadow .15s var(--ease)}.card:hover{border-color:var(--border);box-shadow:var(--shadow-md)}
.card__icon{font-size:1.5rem;margin-bottom:0.875rem;line-height:1}.card__title{font-family:var(--font-head);font-weight:500;font-size:1rem;margin-bottom:0.375rem}.card__body{font-size:0.875rem;color:var(--text-secondary);line-height:1.6;flex:1}
.card__link{display:inline-flex;align-items:center;gap:3px;margin-top:1rem;font-size:0.8125rem;font-weight:500;color:var(--accent);transition:gap .15s var(--ease)}.card__link:hover{gap:6px}
.contribute-block{display:flex;flex-direction:column;gap:0.625rem;background:var(--surface);border:1px solid var(--border-light);border-radius:var(--radius-lg);padding:1.75rem;transition:border-color .15s var(--ease),box-shadow .15s var(--ease)}
.contribute-block:hover{border-color:var(--border);box-shadow:var(--shadow-md)}
.contribute-block__title{font-family:var(--font-head);font-size:1.125rem;font-weight:500}
.contribute-block__body{font-size:0.875rem;color:var(--text-secondary);line-height:1.65}
.info-box{padding:1.5rem;background:var(--accent-soft);border:1px solid rgba(26,115,232,0.15);border-radius:var(--radius-lg)}
.sponsors-grid{display:flex;flex-wrap:wrap;justify-content:center;gap:1rem;padding:0.75rem 0}
.sponsor-item{display:flex;align-items:center;justify-content:center;width:128px;height:64px;padding:0.875rem;background:var(--bg-soft);border:1px solid var(--border-light);border-radius:var(--radius-lg);transition:border-color .15s var(--ease),box-shadow .15s var(--ease)}
.sponsor-item:hover{border-color:var(--border);box-shadow:var(--shadow)}.sponsor-item img{max-width:100%;max-height:100%;object-fit:contain;filter:grayscale(100%) opacity(0.5);transition:filter .15s var(--ease)}.sponsor-item:hover img{filter:grayscale(0%) opacity(1)}
.footer{display:flex;align-items:center;justify-content:space-between;gap:1rem;max-width:var(--container);margin:0 auto;padding:1.75rem clamp(1.5rem,4vw,3rem);border-top:1px solid var(--border-light);flex-wrap:wrap}
.footer__left{display:flex;align-items:center;gap:8px;font-size:0.875rem;font-weight:500;font-family:var(--font-head)}.footer__left img{width:22px;height:22px;border-radius:5px}
.footer__copy{font-family:var(--font-sans);font-weight:400;color:var(--text-muted);font-size:0.8125rem}
.footer__links{display:flex;align-items:center;gap:1rem}.footer__links a{display:inline-flex;align-items:center;gap:5px;font-size:0.8125rem;font-weight:500;color:var(--text-muted);transition:color .15s var(--ease)}.footer__links a:hover{color:var(--text)}
.social-icon{width:16px;height:16px}
.reveal{opacity:1;transform:none}
</style>
</head>
<body>
<!-- ── Nav ────────────────────────────────────── -->
<nav class="nav">
<a class="nav__logo" href="index.html">
<img src="logo.png" alt="SceneView logo"/>
<span>SceneView</span>
</a>
<ul class="nav__links" role="list">
<li><a href="features.html">Features</a></li>
<li><a href="api.html" class="active">API</a></li>
<li><a href="contribute.html">Contribute</a></li>
</ul>
<a class="nav__github" href="https://github.com/SceneView" target="_blank" rel="noopener">
<svg width="16" height="16" viewBox="0 0 24 24" fill="currentColor"><path d="M12 2C6.477 2 2 6.477 2 12c0 4.418 2.865 8.166 6.839 9.489.5.092.682-.217.682-.482 0-.237-.009-.866-.013-1.7-2.782.604-3.369-1.34-3.369-1.34-.454-1.156-1.11-1.463-1.11-1.463-.908-.62.069-.608.069-.608 1.003.07 1.531 1.03 1.531 1.03.892 1.529 2.341 1.087 2.91.831.092-.646.35-1.086.636-1.336-2.22-.253-4.555-1.11-4.555-4.943 0-1.091.39-1.984 1.029-2.683-.103-.253-.446-1.27.098-2.647 0 0 .84-.269 2.75 1.025A9.578 9.578 0 0 1 12 6.836c.85.004 1.705.114 2.504.336 1.909-1.294 2.747-1.025 2.747-1.025.546 1.377.202 2.394.1 2.647.64.699 1.028 1.592 1.028 2.683 0 3.842-2.339 4.687-4.566 4.935.359.309.678.919.678 1.852 0 1.336-.012 2.415-.012 2.743 0 .267.18.578.688.48C19.138 20.163 22 16.418 22 12c0-5.523-4.477-10-10-10z"/></svg>
GitHub
</a>
<button class="nav__menu-btn" aria-label="Open menu" aria-expanded="false">
<svg width="22" height="22" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round">
<line x1="3" y1="6" x2="21" y2="6"/><line x1="3" y1="12" x2="21" y2="12"/><line x1="3" y1="18" x2="21" y2="18"/>
</svg>
</button>
</nav>
<div class="nav__mobile">
<a href="index.html">Home</a>
<a href="features.html">Features</a>
<a href="api.html" class="active">API</a>
<a href="contribute.html">Contribute</a>
<a href="https://github.com/SceneView" target="_blank" rel="noopener">GitHub ↗</a>
</div>
<!-- ── Main ───────────────────────────────────── -->
<main>
<!-- Page hero -->
<div class="page-hero">
<div class="section__label" style="justify-content:center; margin-bottom:1rem;">Docs</div>
<h1 class="page-hero__title"><span class="text-gradient">API</span> Reference</h1>
<p class="page-hero__subtitle">
Full KDoc API documentation generated from source for all SceneView Android modules.
</p>
</div>
<!-- API Modules -->
<section class="section" style="padding-top:0">
<div class="section__header">
<div class="section__label">Android</div>
<h2 class="section__title">Android Modules</h2>
<p class="section__subtitle">Choose the module that matches your use case. Start with SceneView for pure 3D, or ArSceneView for full AR.</p>
</div>
<div class="grid-2">
<a class="api-card reveal" href="api/sceneview-android/sceneview" target="_blank" rel="noopener">
<div style="display:flex;align-items:center;gap:12px;">
<div style="width:48px;height:48px;border-radius:12px;background:var(--accent-soft);display:flex;align-items:center;justify-content:center;font-size:1.5rem;flex-shrink:0;">🎲</div>
<div>
<div style="font-size:0.75rem;font-weight:600;letter-spacing:0.08em;text-transform:uppercase;color:var(--accent);margin-bottom:2px;">Module</div>
<div class="api-card__title">sceneview</div>
</div>
</div>
<div class="api-card__desc">
The core 3D rendering module. Build rich 3D scenes with glTF models, PBR materials,
lighting, animations and gestures — no AR required. Powered by Google Filament.
</div>
<div style="display:flex;gap:6px;flex-wrap:wrap;">
<span class="tag">3D Only</span>
<span class="tag">Filament</span>
<span class="tag">glTF</span>
<span class="tag tag--cyan">Compose</span>
</div>
<div style="display:flex;align-items:center;justify-content:space-between;padding-top:0.75rem;border-top:1px solid var(--border-light);">
<span style="font-size:0.875rem;color:var(--text-muted);">SceneView Android — 3D</span>
<span class="card__link" style="margin:0;">
Open Docs
<svg width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2.5" stroke-linecap="round" stroke-linejoin="round"><polyline points="9 18 15 12 9 6"/></svg>
</span>
</div>
</a>
<a class="api-card reveal" href="api/sceneview-android/arsceneview" target="_blank" rel="noopener">
<div style="display:flex;align-items:center;gap:12px;">
<div style="width:48px;height:48px;border-radius:12px;background:var(--cyan-soft);display:flex;align-items:center;justify-content:center;font-size:1.5rem;flex-shrink:0;">📡</div>
<div>
<div style="font-size:0.75rem;font-weight:600;letter-spacing:0.08em;text-transform:uppercase;color:var(--cyan);margin-bottom:2px;">Module</div>
<div class="api-card__title">arsceneview</div>
</div>
</div>
<div class="api-card__desc">
The full AR module extending sceneview with ARCore support. Enables plane detection,
hit-testing, augmented images and faces, depth, cloud anchors and environmental lighting.
</div>
<div style="display:flex;gap:6px;flex-wrap:wrap;">
<span class="tag">3D + AR</span>
<span class="tag">ARCore</span>
<span class="tag">Plane Detection</span>
<span class="tag tag--cyan">Depth API</span>
</div>
<div style="display:flex;align-items:center;justify-content:space-between;padding-top:0.75rem;border-top:1px solid var(--border-light);">
<span style="font-size:0.875rem;color:var(--text-muted);">ArSceneView Android — 3D & AR</span>
<span class="card__link" style="margin:0;color:var(--cyan);">
Open Docs
<svg width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2.5" stroke-linecap="round" stroke-linejoin="round"><polyline points="9 18 15 12 9 6"/></svg>
</span>
</div>
</a>
</div>
<!-- Quick start hint -->
<div class="reveal info-box" style="margin-top:2.5rem;">
<div style="display:flex;gap:1rem;align-items:flex-start;">
<div style="width:40px;height:40px;border-radius:10px;background:var(--accent-soft);display:flex;align-items:center;justify-content:center;font-size:1.2rem;flex-shrink:0;">💡</div>
<div>
<div style="font-family:var(--font-head);font-weight:600;margin-bottom:0.5rem;">Not sure where to start?</div>
<div style="color:var(--text-secondary);font-size:0.9375rem;line-height:1.65;margin-bottom:1rem;">
Use <code>sceneview</code> if you just need to display 3D models without the camera.
Use <code>arsceneview</code> if you need the live camera view with AR features like plane detection or image tracking.
</div>
<div style="display:flex;gap:0.75rem;flex-wrap:wrap;">
<a class="btn btn--primary btn--sm" href="https://github.com/SceneView/sceneview-android" target="_blank" rel="noopener">View Source on GitHub</a>
<a class="btn btn--outline btn--sm" href="https://discord.gg/UbNDDBTNqb" target="_blank" rel="noopener">Ask on Discord</a>
</div>
</div>
</div>
</div>
</section>
</main>
<!-- ── Footer ─────────────────────────────────── -->
<footer class="footer">
<div class="footer__left">
<img src="logo.png" alt="SceneView"/>
<span>SceneView</span>
<span class="footer__copy">— Open Source, GPL Licensed</span>
</div>
<div class="footer__links">
<a href="https://github.com/SceneView" target="_blank" rel="noopener">
<svg class="social-icon" viewBox="0 0 24 24" fill="currentColor"><path d="M12 2C6.477 2 2 6.477 2 12c0 4.418 2.865 8.166 6.839 9.489.5.092.682-.217.682-.482 0-.237-.009-.866-.013-1.7-2.782.604-3.369-1.34-3.369-1.34-.454-1.156-1.11-1.463-1.11-1.463-.908-.62.069-.608.069-.608 1.003.07 1.531 1.03 1.531 1.03.892 1.529 2.341 1.087 2.91.831.092-.646.35-1.086.636-1.336-2.22-.253-4.555-1.11-4.555-4.943 0-1.091.39-1.984 1.029-2.683-.103-.253-.446-1.27.098-2.647 0 0 .84-.269 2.75 1.025A9.578 9.578 0 0 1 12 6.836c.85.004 1.705.114 2.504.336 1.909-1.294 2.747-1.025 2.747-1.025.546 1.377.202 2.394.1 2.647.64.699 1.028 1.592 1.028 2.683 0 3.842-2.339 4.687-4.566 4.935.359.309.678.919.678 1.852 0 1.336-.012 2.415-.012 2.743 0 .267.18.578.688.48C19.138 20.163 22 16.418 22 12c0-5.523-4.477-10-10-10z"/></svg>
GitHub
</a>
<a href="https://discord.gg/UbNDDBTNqb" target="_blank" rel="noopener">Discord</a>
</div>
</footer>
<script src="js/main.js"></script>
</body>
</html>