Skip to content

Commit e9d209f

Browse files
committed
build docs
1 parent 626fc14 commit e9d209f

28 files changed

+357
-301
lines changed

docs/CNAME

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/assets/js/search.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/classes/camera.html

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> active</h3>
123123
<div class="tsd-signature tsd-kind-icon">active<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div>
124124
<aside class="tsd-sources">
125125
<ul>
126-
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/ff590d0/src/index.ts#L904">index.ts:904</a></li>
126+
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/626fc14/src/index.ts#L916">index.ts:916</a></li>
127127
</ul>
128128
</aside>
129129
<div class="tsd-comment tsd-typography">
@@ -138,7 +138,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> aperture</h3>
138138
<div class="tsd-signature tsd-kind-icon">aperture<span class="tsd-signature-symbol">:</span> <a href="property.html" class="tsd-signature-type" data-tsd-kind="Class">Property</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = ...</span></div>
139139
<aside class="tsd-sources">
140140
<ul>
141-
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/ff590d0/src/index.ts#L896">index.ts:896</a></li>
141+
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/626fc14/src/index.ts#L908">index.ts:908</a></li>
142142
</ul>
143143
</aside>
144144
<div class="tsd-comment tsd-typography">
@@ -153,7 +153,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> blur<wbr>Level</h3>
153153
<div class="tsd-signature tsd-kind-icon">blur<wbr>Level<span class="tsd-signature-symbol">:</span> <a href="property.html" class="tsd-signature-type" data-tsd-kind="Class">Property</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = ...</span></div>
154154
<aside class="tsd-sources">
155155
<ul>
156-
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/ff590d0/src/index.ts#L900">index.ts:900</a></li>
156+
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/626fc14/src/index.ts#L912">index.ts:912</a></li>
157157
</ul>
158158
</aside>
159159
<div class="tsd-comment tsd-typography">
@@ -168,7 +168,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> depth<wbr>OfField</h3
168168
<div class="tsd-signature tsd-kind-icon">depth<wbr>OfField<span class="tsd-signature-symbol">:</span> <a href="property.html" class="tsd-signature-type" data-tsd-kind="Class">Property</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = ...</span></div>
169169
<aside class="tsd-sources">
170170
<ul>
171-
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/ff590d0/src/index.ts#L885">index.ts:885</a></li>
171+
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/626fc14/src/index.ts#L897">index.ts:897</a></li>
172172
</ul>
173173
</aside>
174174
<div class="tsd-comment tsd-typography">
@@ -183,7 +183,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> focus<wbr>Distance</h
183183
<div class="tsd-signature tsd-kind-icon">focus<wbr>Distance<span class="tsd-signature-symbol">:</span> <a href="property.html" class="tsd-signature-type" data-tsd-kind="Class">Property</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = ...</span></div>
184184
<aside class="tsd-sources">
185185
<ul>
186-
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/ff590d0/src/index.ts#L889">index.ts:889</a></li>
186+
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/626fc14/src/index.ts#L901">index.ts:901</a></li>
187187
</ul>
188188
</aside>
189189
<div class="tsd-comment tsd-typography">
@@ -198,7 +198,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> point<wbr>OfInterest<
198198
<div class="tsd-signature tsd-kind-icon">point<wbr>OfInterest<span class="tsd-signature-symbol">:</span> <a href="property.html" class="tsd-signature-type" data-tsd-kind="Class">Property</a><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#vector3d" class="tsd-signature-type" data-tsd-kind="Type alias">Vector3D</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = ...</span></div>
199199
<aside class="tsd-sources">
200200
<ul>
201-
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/ff590d0/src/index.ts#L874">index.ts:874</a></li>
201+
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/626fc14/src/index.ts#L886">index.ts:886</a></li>
202202
</ul>
203203
</aside>
204204
<div class="tsd-comment tsd-typography">
@@ -213,7 +213,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> zoom</h3>
213213
<div class="tsd-signature tsd-kind-icon">zoom<span class="tsd-signature-symbol">:</span> <a href="property.html" class="tsd-signature-type" data-tsd-kind="Class">Property</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = ...</span></div>
214214
<aside class="tsd-sources">
215215
<ul>
216-
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/ff590d0/src/index.ts#L881">index.ts:881</a></li>
216+
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/626fc14/src/index.ts#L893">index.ts:893</a></li>
217217
</ul>
218218
</aside>
219219
<div class="tsd-comment tsd-typography">

docs/classes/comp.html

Lines changed: 34 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,7 @@ <h3>Properties</h3>
9292
<li class="tsd-kind-property tsd-parent-kind-class"><a href="comp.html#duration" class="tsd-kind-icon">duration</a></li>
9393
<li class="tsd-kind-property tsd-parent-kind-class"><a href="comp.html#frameduration" class="tsd-kind-icon">frame<wbr>Duration</a></li>
9494
<li class="tsd-kind-property tsd-parent-kind-class"><a href="comp.html#height" class="tsd-kind-icon">height</a></li>
95+
<li class="tsd-kind-property tsd-parent-kind-class"><a href="comp.html#marker" class="tsd-kind-icon">marker</a></li>
9596
<li class="tsd-kind-property tsd-parent-kind-class"><a href="comp.html#name" class="tsd-kind-icon">name</a></li>
9697
<li class="tsd-kind-property tsd-parent-kind-class"><a href="comp.html#ntscdropframe" class="tsd-kind-icon">ntsc<wbr>Drop<wbr>Frame</a></li>
9798
<li class="tsd-kind-property tsd-parent-kind-class"><a href="comp.html#numlayers" class="tsd-kind-icon">num<wbr>Layers</a></li>
@@ -134,7 +135,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> active<wbr>Camera</h3
134135
<div class="tsd-signature tsd-kind-icon">active<wbr>Camera<span class="tsd-signature-symbol">:</span> <a href="camera.html" class="tsd-signature-type" data-tsd-kind="Class">Camera</a><span class="tsd-signature-symbol"> = ...</span></div>
135136
<aside class="tsd-sources">
136137
<ul>
137-
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/ff590d0/src/index.ts#L130">index.ts:130</a></li>
138+
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/626fc14/src/index.ts#L138">index.ts:138</a></li>
138139
</ul>
139140
</aside>
140141
<div class="tsd-comment tsd-typography">
@@ -149,7 +150,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> bg<wbr>Color</h3>
149150
<div class="tsd-signature tsd-kind-icon">bg<wbr>Color<span class="tsd-signature-symbol">:</span> <a href="../index.html#color" class="tsd-signature-type" data-tsd-kind="Type alias">Color</a><span class="tsd-signature-symbol"> = ...</span></div>
150151
<aside class="tsd-sources">
151152
<ul>
152-
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/ff590d0/src/index.ts#L162">index.ts:162</a></li>
153+
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/626fc14/src/index.ts#L174">index.ts:174</a></li>
153154
</ul>
154155
</aside>
155156
<div class="tsd-comment tsd-typography">
@@ -164,7 +165,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> display<wbr>Start<wbr
164165
<div class="tsd-signature tsd-kind-icon">display<wbr>Start<wbr>Time<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></div>
165166
<aside class="tsd-sources">
166167
<ul>
167-
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/ff590d0/src/index.ts#L150">index.ts:150</a></li>
168+
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/626fc14/src/index.ts#L162">index.ts:162</a></li>
168169
</ul>
169170
</aside>
170171
<div class="tsd-comment tsd-typography">
@@ -179,7 +180,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> duration</h3>
179180
<div class="tsd-signature tsd-kind-icon">duration<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 10</span></div>
180181
<aside class="tsd-sources">
181182
<ul>
182-
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/ff590d0/src/index.ts#L142">index.ts:142</a></li>
183+
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/626fc14/src/index.ts#L154">index.ts:154</a></li>
183184
</ul>
184185
</aside>
185186
<div class="tsd-comment tsd-typography">
@@ -194,7 +195,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> frame<wbr>Duration</h
194195
<div class="tsd-signature tsd-kind-icon">frame<wbr>Duration<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0.04</span></div>
195196
<aside class="tsd-sources">
196197
<ul>
197-
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/ff590d0/src/index.ts#L154">index.ts:154</a></li>
198+
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/626fc14/src/index.ts#L166">index.ts:166</a></li>
198199
</ul>
199200
</aside>
200201
<div class="tsd-comment tsd-typography">
@@ -209,7 +210,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> height</h3>
209210
<div class="tsd-signature tsd-kind-icon">height<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1080</span></div>
210211
<aside class="tsd-sources">
211212
<ul>
212-
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/ff590d0/src/index.ts#L138">index.ts:138</a></li>
213+
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/626fc14/src/index.ts#L150">index.ts:150</a></li>
213214
</ul>
214215
</aside>
215216
<div class="tsd-comment tsd-typography">
@@ -218,13 +219,28 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> height</h3>
218219
</div>
219220
</div>
220221
</section>
222+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
223+
<a name="marker" class="tsd-anchor"></a>
224+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> marker</h3>
225+
<div class="tsd-signature tsd-kind-icon">marker<span class="tsd-signature-symbol">:</span> <a href="markerproperty.html" class="tsd-signature-type" data-tsd-kind="Class">MarkerProperty</a><span class="tsd-signature-symbol"> = ...</span></div>
226+
<aside class="tsd-sources">
227+
<ul>
228+
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/626fc14/src/index.ts#L142">index.ts:142</a></li>
229+
</ul>
230+
</aside>
231+
<div class="tsd-comment tsd-typography">
232+
<div class="lead">
233+
<p>The marker property group object</p>
234+
</div>
235+
</div>
236+
</section>
221237
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
222238
<a name="name" class="tsd-anchor"></a>
223239
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> name</h3>
224240
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;Comp Base&quot;</span></div>
225241
<aside class="tsd-sources">
226242
<ul>
227-
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/ff590d0/src/index.ts#L122">index.ts:122</a></li>
243+
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/626fc14/src/index.ts#L130">index.ts:130</a></li>
228244
</ul>
229245
</aside>
230246
<div class="tsd-comment tsd-typography">
@@ -239,7 +255,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> ntsc<wbr>Drop<wbr>Fra
239255
<div class="tsd-signature tsd-kind-icon">ntsc<wbr>Drop<wbr>Frame<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div>
240256
<aside class="tsd-sources">
241257
<ul>
242-
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/ff590d0/src/index.ts#L146">index.ts:146</a></li>
258+
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/626fc14/src/index.ts#L158">index.ts:158</a></li>
243259
</ul>
244260
</aside>
245261
<div class="tsd-comment tsd-typography">
@@ -254,7 +270,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> num<wbr>Layers</h3>
254270
<div class="tsd-signature tsd-kind-icon">num<wbr>Layers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1</span></div>
255271
<aside class="tsd-sources">
256272
<ul>
257-
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/ff590d0/src/index.ts#L126">index.ts:126</a></li>
273+
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/626fc14/src/index.ts#L134">index.ts:134</a></li>
258274
</ul>
259275
</aside>
260276
<div class="tsd-comment tsd-typography">
@@ -269,7 +285,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> pixel<wbr>Aspect</h3>
269285
<div class="tsd-signature tsd-kind-icon">pixel<wbr>Aspect<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1</span></div>
270286
<aside class="tsd-sources">
271287
<ul>
272-
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/ff590d0/src/index.ts#L166">index.ts:166</a></li>
288+
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/626fc14/src/index.ts#L178">index.ts:178</a></li>
273289
</ul>
274290
</aside>
275291
<div class="tsd-comment tsd-typography">
@@ -284,7 +300,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> shutter<wbr>Angle</h3
284300
<div class="tsd-signature tsd-kind-icon">shutter<wbr>Angle<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 180</span></div>
285301
<aside class="tsd-sources">
286302
<ul>
287-
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/ff590d0/src/index.ts#L158">index.ts:158</a></li>
303+
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/626fc14/src/index.ts#L170">index.ts:170</a></li>
288304
</ul>
289305
</aside>
290306
<div class="tsd-comment tsd-typography">
@@ -299,7 +315,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> width</h3>
299315
<div class="tsd-signature tsd-kind-icon">width<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1920</span></div>
300316
<aside class="tsd-sources">
301317
<ul>
302-
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/ff590d0/src/index.ts#L134">index.ts:134</a></li>
318+
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/626fc14/src/index.ts#L146">index.ts:146</a></li>
303319
</ul>
304320
</aside>
305321
<div class="tsd-comment tsd-typography">
@@ -323,7 +339,7 @@ <h3>layer</h3>
323339
<li class="tsd-description">
324340
<aside class="tsd-sources">
325341
<ul>
326-
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/ff590d0/src/index.ts#L173">index.ts:173</a></li>
342+
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/626fc14/src/index.ts#L185">index.ts:185</a></li>
327343
</ul>
328344
</aside>
329345
<div class="tsd-comment tsd-typography">
@@ -343,7 +359,7 @@ <h4 class="tsd-returns-title">Returns <a href="layer.html" class="tsd-signature-
343359
<li class="tsd-description">
344360
<aside class="tsd-sources">
345361
<ul>
346-
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/ff590d0/src/index.ts#L174">index.ts:174</a></li>
362+
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/626fc14/src/index.ts#L186">index.ts:186</a></li>
347363
</ul>
348364
</aside>
349365
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -357,7 +373,7 @@ <h4 class="tsd-returns-title">Returns <a href="layer.html" class="tsd-signature-
357373
<li class="tsd-description">
358374
<aside class="tsd-sources">
359375
<ul>
360-
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/ff590d0/src/index.ts#L175">index.ts:175</a></li>
376+
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/626fc14/src/index.ts#L187">index.ts:187</a></li>
361377
</ul>
362378
</aside>
363379
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -414,6 +430,9 @@ <h4 class="tsd-returns-title">Returns <a href="layer.html" class="tsd-signature-
414430
<li class=" tsd-kind-property tsd-parent-kind-class">
415431
<a href="comp.html#height" class="tsd-kind-icon">height</a>
416432
</li>
433+
<li class=" tsd-kind-property tsd-parent-kind-class">
434+
<a href="comp.html#marker" class="tsd-kind-icon">marker</a>
435+
</li>
417436
<li class=" tsd-kind-property tsd-parent-kind-class">
418437
<a href="comp.html#name" class="tsd-kind-icon">name</a>
419438
</li>

docs/classes/effect.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ <h3>active</h3>
123123
<div class="tsd-signature tsd-kind-icon">active<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div>
124124
<aside class="tsd-sources">
125125
<ul>
126-
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/ff590d0/src/index.ts#L807">index.ts:807</a></li>
126+
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/626fc14/src/index.ts#L819">index.ts:819</a></li>
127127
</ul>
128128
</aside>
129129
<div class="tsd-comment tsd-typography">
@@ -145,7 +145,7 @@ <h3>param</h3>
145145
<li class="tsd-description">
146146
<aside class="tsd-sources">
147147
<ul>
148-
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/ff590d0/src/index.ts#L812">index.ts:812</a></li>
148+
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/626fc14/src/index.ts#L824">index.ts:824</a></li>
149149
</ul>
150150
</aside>
151151
<h4 class="tsd-parameters-title">Parameters</h4>

0 commit comments

Comments
 (0)