neft
Version:
JavaScript. Everywhere.
197 lines (155 loc) • 15.6 kB
Markdown
> [Wiki](Home) ▸ [[API Reference|API-Reference]] ▸ [[Renderer|Renderer-API]] ▸ **Device**
# Device
> [`Source`](/Neft-io/neft/blob/8b1b771764f7b63d37551418b52ff56a86d16c1f/src/renderer/types/namespace/device.litcoffee#device)
## Table of contents
* [Device](#device)
* [platform](#platform)
* [desktop](#desktop)
* [tablet](#tablet)
* [phone](#phone)
* [mobile](#mobile)
* [pixelRatio](#pixelratio)
* [pointer](#pointer)
* [onPointerPress](#onpointerpress)
* [onPointerRelease](#onpointerrelease)
* [onPointerMove](#onpointermove)
* [onPointerWheel](#onpointerwheel)
* [keyboard](#keyboard)
* [onKeyPress](#onkeypress)
* [onKeyHold](#onkeyhold)
* [onKeyRelease](#onkeyrelease)
* [onKeyInput](#onkeyinput)
* [**Class** Device.PointerEvent](#class-devicepointerevent)
* [x](#x)
* [y](#y)
* [movementX](#movementx)
* [movementY](#movementy)
* [deltaX](#deltax)
* [deltaY](#deltay)
* [**Class** Device.KeyboardEvent](#class-devicekeyboardevent)
* [visible](#visible)
* [key](#key)
* [text](#text)
* [show](#show)
* [hide](#hide)
* [Glossary](#glossary)
##platform
<dl><dt>Syntax</dt><dd><code>*Boolean* Device.platform = `'Unix'`</code></dd><dt>Static property of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-Device-API#device">Device</a></dd><dt>Type</dt><dd><i>Boolean</i></dd><dt>Default</dt><dd><code>'Unix'</code></dd></dl>
Possible values are:
- Android,
- iOS,
- BlackBerry,
- WindowsCE,
- WindowsRT,
- WindowsPhone,
- Linux,
- Windows,
- Unix,
- OSX.
```javascript
Text {
text: 'You are using: ' + Device.platform
font.pixelSize: 30
}
```
> [`Source`](/Neft-io/neft/blob/8b1b771764f7b63d37551418b52ff56a86d16c1f/src/renderer/types/namespace/device.litcoffee#platform)
##desktop
<dl><dt>Syntax</dt><dd><code>*Boolean* Device.desktop = `true`</code></dd><dt>Static property of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-Device-API#device">Device</a></dd><dt>Type</dt><dd><i>Boolean</i></dd><dt>Default</dt><dd><code>true</code></dd></dl>
> [`Source`](/Neft-io/neft/blob/8b1b771764f7b63d37551418b52ff56a86d16c1f/src/renderer/types/namespace/device.litcoffee#desktop)
##tablet
<dl><dt>Syntax</dt><dd><code>*Boolean* Device.tablet = `false`</code></dd><dt>Static property of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-Device-API#device">Device</a></dd><dt>Type</dt><dd><i>Boolean</i></dd><dt>Default</dt><dd><code>false</code></dd></dl>
> [`Source`](/Neft-io/neft/blob/8b1b771764f7b63d37551418b52ff56a86d16c1f/src/renderer/types/namespace/device.litcoffee#tablet)
##phone
<dl><dt>Syntax</dt><dd><code>*Boolean* Device.phone = `false`</code></dd><dt>Static property of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-Device-API#device">Device</a></dd><dt>Type</dt><dd><i>Boolean</i></dd><dt>Default</dt><dd><code>false</code></dd></dl>
> [`Source`](/Neft-io/neft/blob/8b1b771764f7b63d37551418b52ff56a86d16c1f/src/renderer/types/namespace/device.litcoffee#phone)
##mobile
<dl><dt>Syntax</dt><dd><code>*Boolean* Device.mobile = `false`</code></dd><dt>Static property of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-Device-API#device">Device</a></dd><dt>Type</dt><dd><i>Boolean</i></dd><dt>Default</dt><dd><code>false</code></dd></dl>
Tablet or a phone.
```javascript
Text {
text: Device.mobile ? 'Mobile' : 'Desktop'
font.pixelSize: 30
}
```
> [`Source`](/Neft-io/neft/blob/8b1b771764f7b63d37551418b52ff56a86d16c1f/src/renderer/types/namespace/device.litcoffee#mobile)
##pixelRatio
<dl><dt>Syntax</dt><dd><code>*Boolean* Device.pixelRatio = `1`</code></dd><dt>Static property of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-Device-API#device">Device</a></dd><dt>Type</dt><dd><i>Boolean</i></dd><dt>Default</dt><dd><code>1</code></dd></dl>
```javascript
Text {
text: Device.pixelRatio >= 2 ? 'Retina' : 'Non-retina'
font.pixelSize: 30
}
```
> [`Source`](/Neft-io/neft/blob/8b1b771764f7b63d37551418b52ff56a86d16c1f/src/renderer/types/namespace/device.litcoffee#pixelratio)
##pointer
<dl><dt>Syntax</dt><dd><code>ReadOnly *Device.PointerEvent* Device.pointer</code></dd><dt>Static property of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-Device-API#device">Device</a></dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Renderer-Device-API#class-devicepointerevent">Device.PointerEvent</a></dd><dt>Read Only</dt></dl>
> [`Source`](/Neft-io/neft/blob/8b1b771764f7b63d37551418b52ff56a86d16c1f/src/renderer/types/namespace/device.litcoffee#pointer)
##onPointerPress
<dl><dt>Syntax</dt><dd><code>*Signal* Device.onPointerPress(*Device.PointerEvent* event)</code></dd><dt>Static property of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-Device-API#device">Device</a></dd><dt>Parameters</dt><dd><ul><li>event — <a href="/Neft-io/neft/wiki/Renderer-Device-API#class-devicepointerevent">Device.PointerEvent</a></li></ul></dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Signal-API#class-signal">Signal</a></dd></dl>
> [`Source`](/Neft-io/neft/blob/8b1b771764f7b63d37551418b52ff56a86d16c1f/src/renderer/types/namespace/device.litcoffee#onpointerpress)
##onPointerRelease
<dl><dt>Syntax</dt><dd><code>*Signal* Device.onPointerRelease(*Device.PointerEvent* event)</code></dd><dt>Static property of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-Device-API#device">Device</a></dd><dt>Parameters</dt><dd><ul><li>event — <a href="/Neft-io/neft/wiki/Renderer-Device-API#class-devicepointerevent">Device.PointerEvent</a></li></ul></dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Signal-API#class-signal">Signal</a></dd></dl>
> [`Source`](/Neft-io/neft/blob/8b1b771764f7b63d37551418b52ff56a86d16c1f/src/renderer/types/namespace/device.litcoffee#onpointerrelease)
##onPointerMove
<dl><dt>Syntax</dt><dd><code>*Signal* Device.onPointerMove(*Device.PointerEvent* event)</code></dd><dt>Static property of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-Device-API#device">Device</a></dd><dt>Parameters</dt><dd><ul><li>event — <a href="/Neft-io/neft/wiki/Renderer-Device-API#class-devicepointerevent">Device.PointerEvent</a></li></ul></dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Signal-API#class-signal">Signal</a></dd></dl>
> [`Source`](/Neft-io/neft/blob/8b1b771764f7b63d37551418b52ff56a86d16c1f/src/renderer/types/namespace/device.litcoffee#onpointermove)
##onPointerWheel
<dl><dt>Syntax</dt><dd><code>*Signal* Device.onPointerWheel(*Device.PointerEvent* event)</code></dd><dt>Static property of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-Device-API#device">Device</a></dd><dt>Parameters</dt><dd><ul><li>event — <a href="/Neft-io/neft/wiki/Renderer-Device-API#class-devicepointerevent">Device.PointerEvent</a></li></ul></dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Signal-API#class-signal">Signal</a></dd></dl>
> [`Source`](/Neft-io/neft/blob/8b1b771764f7b63d37551418b52ff56a86d16c1f/src/renderer/types/namespace/device.litcoffee#onpointerwheel)
##keyboard
<dl><dt>Syntax</dt><dd><code>ReadOnly *Device.KeyboardEvent* Device.keyboard</code></dd><dt>Static property of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-Device-API#device">Device</a></dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Renderer-Device-API#class-devicekeyboardevent">Device.KeyboardEvent</a></dd><dt>Read Only</dt></dl>
> [`Source`](/Neft-io/neft/blob/8b1b771764f7b63d37551418b52ff56a86d16c1f/src/renderer/types/namespace/device.litcoffee#keyboard)
##onKeyPress
<dl><dt>Syntax</dt><dd><code>*Signal* Device.onKeyPress(*Device.KeyboardEvent* event)</code></dd><dt>Static property of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-Device-API#device">Device</a></dd><dt>Parameters</dt><dd><ul><li>event — <a href="/Neft-io/neft/wiki/Renderer-Device-API#class-devicekeyboardevent">Device.KeyboardEvent</a></li></ul></dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Signal-API#class-signal">Signal</a></dd></dl>
> [`Source`](/Neft-io/neft/blob/8b1b771764f7b63d37551418b52ff56a86d16c1f/src/renderer/types/namespace/device.litcoffee#onkeypress)
##onKeyHold
<dl><dt>Syntax</dt><dd><code>*Signal* Device.onKeyHold(*Device.KeyboardEvent* event)</code></dd><dt>Static property of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-Device-API#device">Device</a></dd><dt>Parameters</dt><dd><ul><li>event — <a href="/Neft-io/neft/wiki/Renderer-Device-API#class-devicekeyboardevent">Device.KeyboardEvent</a></li></ul></dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Signal-API#class-signal">Signal</a></dd></dl>
> [`Source`](/Neft-io/neft/blob/8b1b771764f7b63d37551418b52ff56a86d16c1f/src/renderer/types/namespace/device.litcoffee#onkeyhold)
##onKeyRelease
<dl><dt>Syntax</dt><dd><code>*Signal* Device.onKeyRelease(*Device.KeyboardEvent* event)</code></dd><dt>Static property of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-Device-API#device">Device</a></dd><dt>Parameters</dt><dd><ul><li>event — <a href="/Neft-io/neft/wiki/Renderer-Device-API#class-devicekeyboardevent">Device.KeyboardEvent</a></li></ul></dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Signal-API#class-signal">Signal</a></dd></dl>
> [`Source`](/Neft-io/neft/blob/8b1b771764f7b63d37551418b52ff56a86d16c1f/src/renderer/types/namespace/device.litcoffee#onkeyrelease)
##onKeyInput
<dl><dt>Syntax</dt><dd><code>*Signal* Device.onKeyInput(*Device.KeyboardEvent* event)</code></dd><dt>Static property of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-Device-API#device">Device</a></dd><dt>Parameters</dt><dd><ul><li>event — <a href="/Neft-io/neft/wiki/Renderer-Device-API#class-devicekeyboardevent">Device.KeyboardEvent</a></li></ul></dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Signal-API#class-signal">Signal</a></dd></dl>
> [`Source`](/Neft-io/neft/blob/8b1b771764f7b63d37551418b52ff56a86d16c1f/src/renderer/types/namespace/device.litcoffee#onkeyinput)
# **Class** Device.PointerEvent
> [`Source`](/Neft-io/neft/blob/8b1b771764f7b63d37551418b52ff56a86d16c1f/src/renderer/types/namespace/device.litcoffee#class-devicepointerevent)
##x
<dl><dt>Syntax</dt><dd><code>ReadOnly *Float* Device.PointerEvent::x</code></dd><dt>Static property of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-Device-API#device">Device</a></dd><dt>Prototype property of</dt><dd><i>PointerEvent</i></dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Utils-API#isfloat">Float</a></dd><dt>Read Only</dt></dl>
> [`Source`](/Neft-io/neft/blob/8b1b771764f7b63d37551418b52ff56a86d16c1f/src/renderer/types/namespace/device.litcoffee#x)
##y
<dl><dt>Syntax</dt><dd><code>ReadOnly *Float* Device.PointerEvent::y</code></dd><dt>Static property of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-Device-API#device">Device</a></dd><dt>Prototype property of</dt><dd><i>PointerEvent</i></dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Utils-API#isfloat">Float</a></dd><dt>Read Only</dt></dl>
> [`Source`](/Neft-io/neft/blob/8b1b771764f7b63d37551418b52ff56a86d16c1f/src/renderer/types/namespace/device.litcoffee#y)
##movementX
<dl><dt>Syntax</dt><dd><code>ReadOnly *Float* Device.PointerEvent::movementX</code></dd><dt>Static property of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-Device-API#device">Device</a></dd><dt>Prototype property of</dt><dd><i>PointerEvent</i></dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Utils-API#isfloat">Float</a></dd><dt>Read Only</dt></dl>
> [`Source`](/Neft-io/neft/blob/8b1b771764f7b63d37551418b52ff56a86d16c1f/src/renderer/types/namespace/device.litcoffee#movementx)
##movementY
<dl><dt>Syntax</dt><dd><code>ReadOnly *Float* Device.PointerEvent::movementY</code></dd><dt>Static property of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-Device-API#device">Device</a></dd><dt>Prototype property of</dt><dd><i>PointerEvent</i></dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Utils-API#isfloat">Float</a></dd><dt>Read Only</dt></dl>
> [`Source`](/Neft-io/neft/blob/8b1b771764f7b63d37551418b52ff56a86d16c1f/src/renderer/types/namespace/device.litcoffee#movementy)
##deltaX
<dl><dt>Syntax</dt><dd><code>ReadOnly *Float* Device.PointerEvent::deltaX</code></dd><dt>Static property of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-Device-API#device">Device</a></dd><dt>Prototype property of</dt><dd><i>PointerEvent</i></dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Utils-API#isfloat">Float</a></dd><dt>Read Only</dt></dl>
> [`Source`](/Neft-io/neft/blob/8b1b771764f7b63d37551418b52ff56a86d16c1f/src/renderer/types/namespace/device.litcoffee#deltax)
##deltaY
<dl><dt>Syntax</dt><dd><code>ReadOnly *Float* Device.PointerEvent::deltaY</code></dd><dt>Static property of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-Device-API#device">Device</a></dd><dt>Prototype property of</dt><dd><i>PointerEvent</i></dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Utils-API#isfloat">Float</a></dd><dt>Read Only</dt></dl>
> [`Source`](/Neft-io/neft/blob/8b1b771764f7b63d37551418b52ff56a86d16c1f/src/renderer/types/namespace/device.litcoffee#deltay)
#**Class** Device.KeyboardEvent
<dl><dt>Syntax</dt><dd><code>**Class** Device.KeyboardEvent()</code></dd></dl>
> [`Source`](/Neft-io/neft/blob/8b1b771764f7b63d37551418b52ff56a86d16c1f/src/renderer/types/namespace/device.litcoffee#class-devicekeyboardevent)
##visible
<dl><dt>Syntax</dt><dd><code>ReadOnly *Boolean* Device.KeyboardEvent::visible</code></dd><dt>Static property of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-Device-API#device">Device</a></dd><dt>Prototype property of</dt><dd><i>KeyboardEvent</i></dd><dt>Type</dt><dd><i>Boolean</i></dd><dt>Read Only</dt></dl>
> [`Source`](/Neft-io/neft/blob/8b1b771764f7b63d37551418b52ff56a86d16c1f/src/renderer/types/namespace/device.litcoffee#visible)
##key
<dl><dt>Syntax</dt><dd><code>ReadOnly *String* Device.KeyboardEvent::key</code></dd><dt>Static property of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-Device-API#device">Device</a></dd><dt>Prototype property of</dt><dd><i>KeyboardEvent</i></dd><dt>Type</dt><dd><i>String</i></dd><dt>Read Only</dt></dl>
> [`Source`](/Neft-io/neft/blob/8b1b771764f7b63d37551418b52ff56a86d16c1f/src/renderer/types/namespace/device.litcoffee#key)
##text
<dl><dt>Syntax</dt><dd><code>ReadOnly *String* Device.KeyboardEvent::text</code></dd><dt>Static property of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-Device-API#device">Device</a></dd><dt>Prototype property of</dt><dd><i>KeyboardEvent</i></dd><dt>Type</dt><dd><i>String</i></dd><dt>Read Only</dt></dl>
> [`Source`](/Neft-io/neft/blob/8b1b771764f7b63d37551418b52ff56a86d16c1f/src/renderer/types/namespace/device.litcoffee#text)
##show
<dl><dt>Syntax</dt><dd><code>Device.KeyboardEvent::show()</code></dd><dt>Static method of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-Device-API#device">Device</a></dd><dt>Prototype method of</dt><dd><i>KeyboardEvent</i></dd></dl>
> [`Source`](/Neft-io/neft/blob/8b1b771764f7b63d37551418b52ff56a86d16c1f/src/renderer/types/namespace/device.litcoffee#show)
##hide
<dl><dt>Syntax</dt><dd><code>Device.KeyboardEvent::hide()</code></dd><dt>Static method of</dt><dd><a href="/Neft-io/neft/wiki/Renderer-Device-API#device">Device</a></dd><dt>Prototype method of</dt><dd><i>KeyboardEvent</i></dd></dl>
> [`Source`](/Neft-io/neft/blob/8b1b771764f7b63d37551418b52ff56a86d16c1f/src/renderer/types/namespace/device.litcoffee#hide)
# Glossary
- [Device](#device)
- [Device.PointerEvent](#class-devicepointerevent)
- [Device.KeyboardEvent](#class-devicekeyboardevent)