Skip to content

Commit 51d87c1

Browse files
committed
chore: update docs
1 parent c8e1447 commit 51d87c1

26 files changed

+342
-315
lines changed

docs/assets/js/search.js

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/classes/camera.html

+7-7
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/e9d209f/src/index.ts#L916">index.ts:916</a></li>
126+
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/c8e1447/src/index.ts#L930">index.ts:930</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/e9d209f/src/index.ts#L908">index.ts:908</a></li>
141+
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/c8e1447/src/index.ts#L922">index.ts:922</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/e9d209f/src/index.ts#L912">index.ts:912</a></li>
156+
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/c8e1447/src/index.ts#L926">index.ts:926</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/e9d209f/src/index.ts#L897">index.ts:897</a></li>
171+
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/c8e1447/src/index.ts#L911">index.ts:911</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/e9d209f/src/index.ts#L901">index.ts:901</a></li>
186+
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/c8e1447/src/index.ts#L915">index.ts:915</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/e9d209f/src/index.ts#L886">index.ts:886</a></li>
201+
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/c8e1447/src/index.ts#L900">index.ts:900</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/e9d209f/src/index.ts#L893">index.ts:893</a></li>
216+
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/c8e1447/src/index.ts#L907">index.ts:907</a></li>
217217
</ul>
218218
</aside>
219219
<div class="tsd-comment tsd-typography">

docs/classes/comp.html

+16-16
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> active<wbr>Camera</h3
135135
<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>
136136
<aside class="tsd-sources">
137137
<ul>
138-
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/e9d209f/src/index.ts#L138">index.ts:138</a></li>
138+
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/c8e1447/src/index.ts#L138">index.ts:138</a></li>
139139
</ul>
140140
</aside>
141141
<div class="tsd-comment tsd-typography">
@@ -150,7 +150,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> bg<wbr>Color</h3>
150150
<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>
151151
<aside class="tsd-sources">
152152
<ul>
153-
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/e9d209f/src/index.ts#L174">index.ts:174</a></li>
153+
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/c8e1447/src/index.ts#L174">index.ts:174</a></li>
154154
</ul>
155155
</aside>
156156
<div class="tsd-comment tsd-typography">
@@ -165,7 +165,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> display<wbr>Start<wbr
165165
<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>
166166
<aside class="tsd-sources">
167167
<ul>
168-
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/e9d209f/src/index.ts#L162">index.ts:162</a></li>
168+
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/c8e1447/src/index.ts#L162">index.ts:162</a></li>
169169
</ul>
170170
</aside>
171171
<div class="tsd-comment tsd-typography">
@@ -180,7 +180,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> duration</h3>
180180
<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>
181181
<aside class="tsd-sources">
182182
<ul>
183-
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/e9d209f/src/index.ts#L154">index.ts:154</a></li>
183+
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/c8e1447/src/index.ts#L154">index.ts:154</a></li>
184184
</ul>
185185
</aside>
186186
<div class="tsd-comment tsd-typography">
@@ -195,7 +195,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> frame<wbr>Duration</h
195195
<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>
196196
<aside class="tsd-sources">
197197
<ul>
198-
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/e9d209f/src/index.ts#L166">index.ts:166</a></li>
198+
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/c8e1447/src/index.ts#L166">index.ts:166</a></li>
199199
</ul>
200200
</aside>
201201
<div class="tsd-comment tsd-typography">
@@ -210,7 +210,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> height</h3>
210210
<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>
211211
<aside class="tsd-sources">
212212
<ul>
213-
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/e9d209f/src/index.ts#L150">index.ts:150</a></li>
213+
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/c8e1447/src/index.ts#L150">index.ts:150</a></li>
214214
</ul>
215215
</aside>
216216
<div class="tsd-comment tsd-typography">
@@ -225,7 +225,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag
225225
<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>
226226
<aside class="tsd-sources">
227227
<ul>
228-
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/e9d209f/src/index.ts#L142">index.ts:142</a></li>
228+
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/c8e1447/src/index.ts#L142">index.ts:142</a></li>
229229
</ul>
230230
</aside>
231231
<div class="tsd-comment tsd-typography">
@@ -240,7 +240,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> name</h3>
240240
<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>
241241
<aside class="tsd-sources">
242242
<ul>
243-
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/e9d209f/src/index.ts#L130">index.ts:130</a></li>
243+
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/c8e1447/src/index.ts#L130">index.ts:130</a></li>
244244
</ul>
245245
</aside>
246246
<div class="tsd-comment tsd-typography">
@@ -255,7 +255,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> ntsc<wbr>Drop<wbr>Fra
255255
<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>
256256
<aside class="tsd-sources">
257257
<ul>
258-
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/e9d209f/src/index.ts#L158">index.ts:158</a></li>
258+
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/c8e1447/src/index.ts#L158">index.ts:158</a></li>
259259
</ul>
260260
</aside>
261261
<div class="tsd-comment tsd-typography">
@@ -270,7 +270,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> num<wbr>Layers</h3>
270270
<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>
271271
<aside class="tsd-sources">
272272
<ul>
273-
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/e9d209f/src/index.ts#L134">index.ts:134</a></li>
273+
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/c8e1447/src/index.ts#L134">index.ts:134</a></li>
274274
</ul>
275275
</aside>
276276
<div class="tsd-comment tsd-typography">
@@ -285,7 +285,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> pixel<wbr>Aspect</h3>
285285
<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>
286286
<aside class="tsd-sources">
287287
<ul>
288-
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/e9d209f/src/index.ts#L178">index.ts:178</a></li>
288+
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/c8e1447/src/index.ts#L178">index.ts:178</a></li>
289289
</ul>
290290
</aside>
291291
<div class="tsd-comment tsd-typography">
@@ -300,7 +300,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> shutter<wbr>Angle</h3
300300
<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>
301301
<aside class="tsd-sources">
302302
<ul>
303-
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/e9d209f/src/index.ts#L170">index.ts:170</a></li>
303+
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/c8e1447/src/index.ts#L170">index.ts:170</a></li>
304304
</ul>
305305
</aside>
306306
<div class="tsd-comment tsd-typography">
@@ -315,7 +315,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> width</h3>
315315
<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>
316316
<aside class="tsd-sources">
317317
<ul>
318-
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/e9d209f/src/index.ts#L146">index.ts:146</a></li>
318+
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/c8e1447/src/index.ts#L146">index.ts:146</a></li>
319319
</ul>
320320
</aside>
321321
<div class="tsd-comment tsd-typography">
@@ -339,7 +339,7 @@ <h3>layer</h3>
339339
<li class="tsd-description">
340340
<aside class="tsd-sources">
341341
<ul>
342-
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/e9d209f/src/index.ts#L185">index.ts:185</a></li>
342+
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/c8e1447/src/index.ts#L185">index.ts:185</a></li>
343343
</ul>
344344
</aside>
345345
<div class="tsd-comment tsd-typography">
@@ -359,7 +359,7 @@ <h4 class="tsd-returns-title">Returns <a href="layer.html" class="tsd-signature-
359359
<li class="tsd-description">
360360
<aside class="tsd-sources">
361361
<ul>
362-
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/e9d209f/src/index.ts#L186">index.ts:186</a></li>
362+
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/c8e1447/src/index.ts#L186">index.ts:186</a></li>
363363
</ul>
364364
</aside>
365365
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -373,7 +373,7 @@ <h4 class="tsd-returns-title">Returns <a href="layer.html" class="tsd-signature-
373373
<li class="tsd-description">
374374
<aside class="tsd-sources">
375375
<ul>
376-
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/e9d209f/src/index.ts#L187">index.ts:187</a></li>
376+
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/c8e1447/src/index.ts#L187">index.ts:187</a></li>
377377
</ul>
378378
</aside>
379379
<h4 class="tsd-parameters-title">Parameters</h4>

docs/classes/effect.html

+2-2
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/e9d209f/src/index.ts#L819">index.ts:819</a></li>
126+
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/c8e1447/src/index.ts#L833">index.ts:833</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/e9d209f/src/index.ts#L824">index.ts:824</a></li>
148+
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/c8e1447/src/index.ts#L838">index.ts:838</a></li>
149149
</ul>
150150
</aside>
151151
<h4 class="tsd-parameters-title">Parameters</h4>

docs/classes/effects.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ <h3>constructor</h3>
111111
<aside class="tsd-sources">
112112
<p>Inherited from <a href="propertygroup.html">PropertyGroup</a>.<a href="propertygroup.html#constructor">constructor</a></p>
113113
<ul>
114-
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/e9d209f/src/index.ts#L204">index.ts:204</a></li>
114+
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/c8e1447/src/index.ts#L204">index.ts:204</a></li>
115115
</ul>
116116
</aside>
117117
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -134,7 +134,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> name</h3>
134134
<aside class="tsd-sources">
135135
<p>Inherited from <a href="propertygroup.html">PropertyGroup</a>.<a href="propertygroup.html#name">name</a></p>
136136
<ul>
137-
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/e9d209f/src/index.ts#L200">index.ts:200</a></li>
137+
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/c8e1447/src/index.ts#L200">index.ts:200</a></li>
138138
</ul>
139139
</aside>
140140
<div class="tsd-comment tsd-typography">
@@ -150,7 +150,7 @@ <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> num<wbr>Properties</h
150150
<aside class="tsd-sources">
151151
<p>Inherited from <a href="propertygroup.html">PropertyGroup</a>.<a href="propertygroup.html#numproperties">numProperties</a></p>
152152
<ul>
153-
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/e9d209f/src/index.ts#L204">index.ts:204</a></li>
153+
<li>Defined in <a href="https://github.com/timhaywood/expression-globals-typescript/blob/c8e1447/src/index.ts#L204">index.ts:204</a></li>
154154
</ul>
155155
</aside>
156156
<div class="tsd-comment tsd-typography">

0 commit comments

Comments
 (0)