UNPKG

20.8 kBHTMLView Raw
1<!DOCTYPE html>
2
3<html lang="en">
4<head>
5 <meta charset="utf-8">
6 <meta name="viewport" content="width=device-width">
7 <title>CrossBrowdy API documentation Namespace: CB_Device</title>
8
9 <!--[if lt IE 9]>
10 <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
11 <![endif]-->
12 <link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
13
14 <link type="text/css" rel="stylesheet" href="styles/site.cosmo.css">
15
16</head>
17
18<body style="min-width:800px; overflow-wrap:break-word; word-wrap:break-word; word-break:break-word; line-break:strict; hyphens:none; -webkit-hyphens:none; -moz-hyphens:none;">
19
20<div class="navbar navbar-default navbar-fixed-top ">
21<div class="container">
22 <div class="navbar-header">
23 <a class="navbar-brand" href="index.html">CrossBrowdy API documentation</a>
24 <button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
25 <span class="icon-bar"></span>
26 <span class="icon-bar"></span>
27 <span class="icon-bar"></span>
28 </button>
29 </div>
30 <div class="navbar-collapse collapse" id="topNavigation">
31 <ul class="nav navbar-nav">
32
33 <li class="dropdown">
34 <a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b class="caret"></b></a>
35 <ul class="dropdown-menu inline">
36 <li><a href="CB_Arrays.html">CB_Arrays</a></li><li><a href="CB_AudioDetector.html">CB_AudioDetector</a></li><li><a href="CB_Client.html">CB_Client</a></li><li><a href="CB_Collisions.html">CB_Collisions</a></li><li><a href="CB_Configuration.html">CB_Configuration</a></li><li><a href="CB_Configuration.CrossBase.html">CB_Configuration.CrossBase</a></li><li><a href="CB_Configuration.CrossBrowdy.html">CB_Configuration.CrossBrowdy</a></li><li><a href="CB_Controllers.html">CB_Controllers</a></li><li><a href="CB_Controllers_Proprietary.html">CB_Controllers_Proprietary</a></li><li><a href="CB_Controllers_Proprietary.WII.html">CB_Controllers_Proprietary.WII</a></li><li><a href="CB_Controllers_Proprietary.WII_U.html">CB_Controllers_Proprietary.WII_U</a></li><li><a href="CB_Device.html">CB_Device</a></li><li><a href="CB_Device.AmbientLight.html">CB_Device.AmbientLight</a></li><li><a href="CB_Device.Battery.html">CB_Device.Battery</a></li><li><a href="CB_Device.Location.html">CB_Device.Location</a></li><li><a href="CB_Device.Motion.html">CB_Device.Motion</a></li><li><a href="CB_Device.Orientation.html">CB_Device.Orientation</a></li><li><a href="CB_Device.Proximity.html">CB_Device.Proximity</a></li><li><a href="CB_Device.Vibration.html">CB_Device.Vibration</a></li><li><a href="CB_Elements.html">CB_Elements</a></li><li><a href="CB_Events.html">CB_Events</a></li><li><a href="CB_Keyboard.html">CB_Keyboard</a></li><li><a href="CB_Keyboard.chars.html">CB_Keyboard.chars</a></li><li><a href="CB_Keyboard.extended.html">CB_Keyboard.extended</a></li><li><a href="CB_Keyboard.keys.html">CB_Keyboard.keys</a></li><li><a href="CB_Modules.html">CB_Modules</a></li><li><a href="CB_Mouse.html">CB_Mouse</a></li><li><a href="CB_Mouse.CursorImage.html">CB_Mouse.CursorImage</a></li><li><a href="CB_Net.html">CB_Net</a></li><li><a href="CB_Net.Fetch.html">CB_Net.Fetch</a></li><li><a href="CB_Net.REST.html">CB_Net.REST</a></li><li><a href="CB_Net.Sockets.html">CB_Net.Sockets</a></li><li><a href="CB_Net.Sockets.SockJS.html">CB_Net.Sockets.SockJS</a></li><li><a href="CB_Net.XHR.html">CB_Net.XHR</a></li><li><a href="CB_Pointer.html">CB_Pointer</a></li><li><a href="CB_Screen.html">CB_Screen</a></li><li><a href="CB_Speaker.html">CB_Speaker</a></li><li><a href="CB_Touch.html">CB_Touch</a></li><li><a href="CB_baseSymbols.html">CB_baseSymbols</a></li>
37 </ul>
38 </li>
39
40 <li class="dropdown">
41 <a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a>
42 <ul class="dropdown-menu inline">
43 <li><a href="CB_AudioFile.html">CB_AudioFile</a></li><li><a href="CB_AudioFileCache.html">CB_AudioFileCache</a></li><li><a href="CB_AudioFileSprites.html">CB_AudioFileSprites</a></li><li><a href="CB_AudioFileSpritesPool.html">CB_AudioFileSpritesPool</a></li><li><a href="CB_AudioFile_API.AAPI.html">CB_AudioFile_API.AAPI</a></li><li><a href="CB_AudioFile_API.ACMP.html">CB_AudioFile_API.ACMP</a></li><li><a href="CB_AudioFile_API.SM2.html">CB_AudioFile_API.SM2</a></li><li><a href="CB_AudioFile_API.WAAPI.html">CB_AudioFile_API.WAAPI</a></li><li><a href="CB_Canvas.html">CB_Canvas</a></li><li><a href="CB_GraphicSprites.html">CB_GraphicSprites</a></li><li><a href="CB_GraphicSpritesScene.html">CB_GraphicSpritesScene</a></li>
44 </ul>
45 </li>
46
47 <li class="dropdown">
48 <a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a>
49 <ul class="dropdown-menu inline">
50 <li><a href="global.html#CB_BASE_NAME">CB_BASE_NAME</a></li><li><a href="global.html#CB_CREDITS_DEFAULT">CB_CREDITS_DEFAULT</a></li><li><a href="global.html#CB_NAME">CB_NAME</a></li><li><a href="global.html#CB_OPTIONS">CB_OPTIONS</a></li><li><a href="global.html#CB_VERSION">CB_VERSION</a></li><li><a href="global.html#CB_addCredits">CB_addCredits</a></li><li><a href="global.html#CB_baseToBase">CB_baseToBase</a></li><li><a href="global.html#CB_baseToInt">CB_baseToInt</a></li><li><a href="global.html#CB_br2nl">CB_br2nl</a></li><li><a href="global.html#CB_brToNl">CB_brToNl</a></li><li><a href="global.html#CB_combineArraysOrObjects">CB_combineArraysOrObjects</a></li><li><a href="global.html#CB_combineAutomatically">CB_combineAutomatically</a></li><li><a href="global.html#CB_combineJSON">CB_combineJSON</a></li><li><a href="global.html#CB_combineURIParameters">CB_combineURIParameters</a></li><li><a href="global.html#CB_combineURLParameters">CB_combineURLParameters</a></li><li><a href="global.html#CB_console">CB_console</a></li><li><a href="global.html#CB_copyObject">CB_copyObject</a></li><li><a href="global.html#CB_countDecimalDigits">CB_countDecimalDigits</a></li><li><a href="global.html#CB_countDecimalPart">CB_countDecimalPart</a></li><li><a href="global.html#CB_countDecimals">CB_countDecimals</a></li><li><a href="global.html#CB_countIntegerDigits">CB_countIntegerDigits</a></li><li><a href="global.html#CB_countIntegerPart">CB_countIntegerPart</a></li><li><a href="global.html#CB_credits">CB_credits</a></li><li><a href="global.html#CB_forEach">CB_forEach</a></li><li><a href="global.html#CB_forceString">CB_forceString</a></li><li><a href="global.html#CB_getBase64StringObject">CB_getBase64StringObject</a></li><li><a href="global.html#CB_getCookie">CB_getCookie</a></li><li><a href="global.html#CB_getDatum">CB_getDatum</a></li><li><a href="global.html#CB_getJSONPropertyValue">CB_getJSONPropertyValue</a></li><li><a href="global.html#CB_getLZStringObject">CB_getLZStringObject</a></li><li><a href="global.html#CB_getValueIndex">CB_getValueIndex</a></li><li><a href="global.html#CB_getValuePath">CB_getValuePath</a></li><li><a href="global.html#CB_includeJSFile">CB_includeJSFile</a></li><li><a href="global.html#CB_indexOf">CB_indexOf</a></li><li><a href="global.html#CB_init">CB_init</a></li><li><a href="global.html#CB_intToBase">CB_intToBase</a></li><li><a href="global.html#CB_isArray">CB_isArray</a></li><li><a href="global.html#CB_isEmail">CB_isEmail</a></li><li><a href="global.html#CB_isFileLocal">CB_isFileLocal</a></li><li><a href="global.html#CB_isString">CB_isString</a></li><li><a href="global.html#CB_lastIndexOf">CB_lastIndexOf</a></li><li><a href="global.html#CB_ltrim">CB_ltrim</a></li><li><a href="global.html#CB_nl2br">CB_nl2br</a></li><li><a href="global.html#CB_nlToBr">CB_nlToBr</a></li><li><a href="global.html#CB_numberFormat">CB_numberFormat</a></li><li><a href="global.html#CB_numberOfDecimalDigits">CB_numberOfDecimalDigits</a></li><li><a href="global.html#CB_numberOfDecimals">CB_numberOfDecimals</a></li><li><a href="global.html#CB_numberOfIntegerDigits">CB_numberOfIntegerDigits</a></li><li><a href="global.html#CB_parseJSON">CB_parseJSON</a></li><li><a href="global.html#CB_parseString">CB_parseString</a></li><li><a href="global.html#CB_regularExpressionString">CB_regularExpressionString</a></li><li><a href="global.html#CB_renderString">CB_renderString</a></li><li><a href="global.html#CB_replaceAll">CB_replaceAll</a></li><li><a href="global.html#CB_rtrim">CB_rtrim</a></li><li><a href="global.html#CB_scriptPath">CB_scriptPath</a></li><li><a href="global.html#CB_scriptPathCalculate">CB_scriptPathCalculate</a></li><li><a href="global.html#CB_setCookie">CB_setCookie</a></li><li><a href="global.html#CB_setDatum">CB_setDatum</a></li><li><a href="global.html#CB_sizeOf">CB_sizeOf</a></li><li><a href="global.html#CB_sizeof">CB_sizeof</a></li><li><a href="global.html#CB_stringifyJSON">CB_stringifyJSON</a></li><li><a href="global.html#CB_symmetricCall">CB_symmetricCall</a></li><li><a href="global.html#CB_symmetricCallClear">CB_symmetricCallClear</a></li><li><a href="global.html#CB_this">CB_this</a></li><li><a href="global.html#CB_trim">CB_trim</a></li>
51 </ul>
52 </li>
53
54 </ul>
55
56 <div class="col-sm-3 col-md-3">
57 <form class="navbar-form" role="search">
58 <div class="input-group">
59 <input type="text" class="form-control" placeholder="Search" name="q" id="search-input">
60 <div class="input-group-btn">
61 <button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button>
62 </div>
63 </div>
64 </form>
65 </div>
66
67 </div>
68
69</div>
70</div>
71
72
73<div class="container" id="toc-content" style="width:100%;">
74<div class="row" style="width:100%;">
75
76
77 <div class="col-md-8" style="width:85%;">
78
79 <div id="main">
80
81
82
83 <h1 class="page-title">Namespace: CB_Device</h1>
84
85<section>
86
87<header>
88
89 <h2>
90 CB_Device
91 </h2>
92
93
94</header>
95
96
97<article>
98 <div class="container-overview">
99
100
101 <div class="description"><p>Static class to manage the device. It will return itself if it is tried to be instantiated.</p></div>
102
103
104
105<dl class="details">
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 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
136 <dd class="tag-source">
137 <ul class="dummy">
138 <li>
139 <a href="CrossBase_device_CB_Device.js.html">CrossBase/device/CB_Device.js</a>,
140 <a href="CrossBase_device_CB_Device.js.html#sunlight-1-line-13">line 13</a>
141 </li>
142 </ul>
143 </dd>
144
145
146
147
148
149
150
151 <dt class="tag-todo method-doc-label method-doc-details-label">To Do:</dt>
152 <dd class="tag-todo">
153 <ul>
154 <li>Think about defining a parameter on many of the events to disable automatic normalization of the event object.</li>
155 </ul>
156 </dd>
157
158</dl>
159
160
161
162
163 </div>
164
165
166
167
168
169
170
171
172
173
174 <h3 class="subsection-title">Namespaces</h3>
175
176 <dl>
177 <dt><a href="namespaces.html#CB_Device.AmbientLight"><a href="CB_Device.AmbientLight.html">AmbientLight</a></a></dt>
178 <dd></dd>
179
180 <dt><a href="namespaces.html#CB_Device.Battery"><a href="CB_Device.Battery.html">Battery</a></a></dt>
181 <dd></dd>
182
183 <dt><a href="namespaces.html#CB_Device.Location"><a href="CB_Device.Location.html">Location</a></a></dt>
184 <dd></dd>
185
186 <dt><a href="namespaces.html#CB_Device.Motion"><a href="CB_Device.Motion.html">Motion</a></a></dt>
187 <dd></dd>
188
189 <dt><a href="namespaces.html#CB_Device.Orientation"><a href="CB_Device.Orientation.html">Orientation</a></a></dt>
190 <dd></dd>
191
192 <dt><a href="namespaces.html#CB_Device.Proximity"><a href="CB_Device.Proximity.html">Proximity</a></a></dt>
193 <dd></dd>
194
195 <dt><a href="namespaces.html#CB_Device.Vibration"><a href="CB_Device.Vibration.html">Vibration</a></a></dt>
196 <dd></dd>
197 </dl>
198
199
200
201
202
203 <h3 class="subsection-title">Methods</h3>
204
205 <dl>
206
207<hr>
208<dt>
209 <h4 class="name" id=".getTime"><span class="type-signature">&lt;static> </span>getTime<span class="signature">()</span><span class="type-signature"> &rarr; {integer}</span></h4>
210
211
212</dt>
213<dd>
214
215
216 <div class="description">
217 <p>Gets a timestamp in milliseconds (elapsed since 1st of January 1970 00:00:00 UTC) representing the current time. Using high precision if the <a href="CB_Configuration.CrossBase.html#.CB_Device_getTime_HIGH_PRECISION"><code>CB_Configuration.CrossBase.CB_Device_getTime_HIGH_PRECISION</code></a> option is true (it would return '<a href="https://developer.mozilla.org/en-US/docs/Web/API/PerformanceTiming/navigationStart">window.performance.timing.navigationStart</a> + <a href="https://developer.mozilla.org/en-US/docs/Web/API/Performance/now">window.performance.now</a>()', where '<a href="https://developer.mozilla.org/en-US/docs/Web/API/Performance/now">window.performance.now</a>' could be polyfilled) or normal precision otherwise (it would return '<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/now">Date.now</a>()', where '<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/now">Date.now</a>' could be polyfilled).</p>
218 </div>
219
220
221
222
223
224
225
226
227
228
229<dl class="details">
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
260 <dd class="tag-source">
261 <ul class="dummy">
262 <li>
263 <a href="CrossBase_device_CB_Device.js.html">CrossBase/device/CB_Device.js</a>,
264 <a href="CrossBase_device_CB_Device.js.html#sunlight-1-line-47">line 47</a>
265 </li>
266 </ul>
267 </dd>
268
269
270
271
272
273
274
275</dl>
276
277
278
279
280
281
282
283
284
285
286
287
288
289 <h5>Returns:</h5>
290
291
292<div class="param-desc">
293 <p>Returns a timestamp in milliseconds (elapsed since 1st of January 1970 00:00:00 UTC) representing the current time or zero (0) if it was not possible.</p>
294</div>
295
296
297
298<dl>
299 <dt>
300 Type
301 </dt>
302 <dd>
303
304<span class="param-type">integer</span>
305
306
307
308 </dd>
309</dl>
310
311
312
313
314
315</dd>
316
317
318
319<hr>
320<dt>
321 <h4 class="name" id=".getTiming"><span class="type-signature">&lt;static> </span>getTiming<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
322
323
324</dt>
325<dd>
326
327
328 <div class="description">
329 <p>Gets the time elapsed since the <a href="https://developer.mozilla.org/en-US/docs/Web/API/DOMHighResTimeStamp#The_time_origin">time origin</a>. If possible, it uses <a href="https://developer.mozilla.org/en-US/docs/Web/API/Performance/now">window.performance.now</a>, which could be polyfilled (if it is polyfilled it will not have high precision timing but, if it is not, time precision/resolution will depend on the client).</p>
330 </div>
331
332
333
334
335
336
337
338
339
340
341<dl class="details">
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371 <dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
372 <dd class="tag-source">
373 <ul class="dummy">
374 <li>
375 <a href="CrossBase_device_CB_Device.js.html">CrossBase/device/CB_Device.js</a>,
376 <a href="CrossBase_device_CB_Device.js.html#sunlight-1-line-58">line 58</a>
377 </li>
378 </ul>
379 </dd>
380
381
382
383
384
385
386
387</dl>
388
389
390
391
392
393
394
395
396
397
398
399
400
401 <h5>Returns:</h5>
402
403
404<div class="param-desc">
405 <p>Returns the time elapsed since the <a href="https://developer.mozilla.org/en-US/docs/Web/API/DOMHighResTimeStamp#The_time_origin">time origin</a>. If possible, it uses <a href="https://developer.mozilla.org/en-US/docs/Web/API/Performance/now">window.performance.now</a>, which could be polyfilled (if it is polyfilled it will not have high precision timing but, if it is not, time precision/resolution will depend on the client).</p>
406</div>
407
408
409
410<dl>
411 <dt>
412 Type
413 </dt>
414 <dd>
415
416<span class="param-type">number</span>
417
418
419
420 </dd>
421</dl>
422
423
424
425
426
427</dd>
428
429 </dl>
430
431
432
433
434
435</article>
436
437</section>
438
439
440
441
442 </div>
443 </div>
444
445 <div class="clearfix"></div>
446
447
448 <div class="col-md-3">
449 <div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
450 </div>
451
452
453</div>
454</div>
455
456
457 <div class="modal fade" id="searchResults">
458 <div class="modal-dialog">
459 <div class="modal-content">
460 <div class="modal-header">
461 <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>
462 <h4 class="modal-title">Search results</h4>
463 </div>
464 <div class="modal-body"></div>
465 <div class="modal-footer">
466 <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
467 </div>
468 </div><!-- /.modal-content -->
469 </div><!-- /.modal-dialog -->
470 </div>
471
472
473<footer>
474
475
476 <span class="copyright">
477 <a href="printable/" target="_blank">See a more printer-friendly version</a><hr /><span style="color:#000000">© <address style="display:inline; font-style:normal;"><a href="https://crossbrowdy.com/" target="_blank">CrossBrowdy</a> API documentation</address> by <a href="https://joanalbamaldonado.com/" target="_blank">Joan Alba Maldonado</a> - <a href="https://creativecommons.org/licenses/by/4.0/" target="_blank">Creative Commons Attribution 4.0 International</a><br />DocStrap Copyright © 2012-2015 The contributors to the JSDoc3 and DocStrap projects.</span>
478 </span>
479
480<span class="jsdoc-message">
481 Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a>
482
483 on Wed Mar 22nd 2023
484
485 using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
486</span>
487</footer>
488
489<script src="scripts/docstrap.lib.js"></script>
490<script src="scripts/toc.js"></script>
491
492 <script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>
493
494
495<script>
496$( function () {
497 $( "[id*='$']" ).each( function () {
498 var $this = $( this );
499
500 $this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
501 } );
502
503 $( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
504 var $this = $( this );
505
506 var example = $this.find( "code" );
507 exampleText = example.html();
508 var lang = /{@lang (.*?)}/.exec( exampleText );
509 if ( lang && lang[1] ) {
510 exampleText = exampleText.replace( lang[0], "" );
511 example.html( exampleText );
512 lang = lang[1];
513 } else {
514 var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
515 lang = langClassMatch ? langClassMatch[1] : "javascript";
516 }
517
518 if ( lang ) {
519
520 $this
521 .addClass( "sunlight-highlight-" + lang )
522 .addClass( "linenums" )
523 .html( example.html() );
524
525 }
526 } );
527
528 Sunlight.highlightAll( {
529 lineNumbers : true,
530 showMenu : true,
531 enableDoclinks : true
532 } );
533
534 $.catchAnchorLinks( {
535 navbarOffset: 10
536 } );
537 $( "#toc" ).toc( {
538 anchorName : function ( i, heading, prefix ) {
539 return $( heading ).attr( "id" ) || ( prefix + i );
540 },
541 selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
542 showAndHide : false,
543 smoothScrolling: true
544 } );
545
546 $( "#main span[id^='toc']" ).addClass( "toc-shim" );
547 $( '.dropdown-toggle' ).dropdown();
548
549 $( "table" ).each( function () {
550 var $this = $( this );
551 $this.addClass('table');
552 } );
553
554} );
555</script>
556
557
558
559<!--Navigation and Symbol Display-->
560
561<script>
562 $( function () {
563 $( '#main' ).localScroll( {
564 offset : { top : 60 } //offset by the height of your header (give or take a few px, see what works for you)
565 } );
566 $( "dt.name" ).each( function () {
567 var $this = $( this ).find("h4");
568 var icon = $( "<i/>" ).addClass( "icon-plus-sign" ).addClass( "pull-right" ).addClass( "icon-white" );
569 var dt = $(this);
570 var children = dt.next( "dd" );
571
572 dt.prepend( icon ).css( {cursor : "pointer"} );
573 dt.addClass( "member-collapsed" ).addClass( "member" );
574
575
576 children.hide();
577
578 dt.children().on( "click", function () {
579 children = dt.next( "dd" );
580 children.slideToggle( "fast", function () {
581
582 if ( children.is( ":visible" ) ) {
583 icon.addClass( "icon-minus-sign" ).removeClass( "icon-plus-sign" ).removeClass( "icon-white" );
584 dt.addClass( "member-open" ).animate( "member-collapsed" );
585 } else {
586 icon.addClass( "icon-plus-sign" ).removeClass( "icon-minus-sign" ).addClass( "icon-white" );
587 dt.addClass( "member-collapsed" ).removeClass( "member-open" );
588 }
589 } );
590 } );
591
592 } );
593 } );
594</script>
595
596
597<!--Google Analytics-->
598
599
600
601 <script type="text/javascript">
602 $(document).ready(function() {
603 SearcherDisplay.init();
604 });
605 </script>
606
607
608</body>
609</html>
\No newline at end of file