# @kmamal/sdl [![Package](https://img.shields.io/npm/v/%2540kmamal%252Fsdl)](https://www.npmjs.com/package/@kmamal/sdl) [![Dependencies](https://img.shields.io/librariesio/release/npm/@kmamal/sdl)](https://libraries.io/npm/@kmamal%2Fsdl) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) SDL bindings for Node.js. Provides access to systems that are not normally available to Node.js applications: - ๐Ÿ’ป Window management - โŒจ Keyboard - ๐Ÿ–ฑ Mouse - ๐Ÿ•น Joysticks - ๐ŸŽฎ Controllers - ๐Ÿ”ˆ Audio playback - ๐ŸŽค Audio recording - ๐Ÿ“‹ Clipboard manipulation - ๐Ÿ”‹ Battery status - ๐Ÿงญ Sensors Also allows using Canvas2D, WebGL, and WebGPU without a browser, through these libraries: - __Canvas2D:__ [@napi-rs/canvas](https://www.npmjs.com/package/@napi-rs/canvas). In my experience, this is the fastest library out of the many available on npm. - __WebGL:__ [@kmamal/gl](https://github.com/kmamal/headless-gl#readme). This is a fork of [headless-gl](https://github.com/stackgl/headless-gl#readme) that I've modified to render directly to SDL windows. - __WebGPU:__ [@kmamal/gpu](https://github.com/kmamal/gpu#readme). This is a fork of [Google Dawn](https://dawn.googlesource.com/dawn/+/refs/heads/main/src/dawn/node/) that I've modified to render directly to SDL windows. Officially supports Linux (x64, arm64), Mac (x64, arm64), and Windows (x64). Should theoretically work on any system supported by both SDL and Node.js, but I haven't tried any others. Prebuilt binaries are available for the supported architectures. ## Installation This package is self-contained. Just run: ```bash npm install @kmamal/sdl ``` You do __not__ have to manually install any other libs or DLLs to your system. A compatible version of SDL will be automatically downloaded by the install script and placed inside `node_modules` along with this lib's prebuilt binding binaries. (But if the install script fails, have a look at the instructions for [building the package manually](#building-from-source)) ## Examples ### "Hello, World!" ```js import sdl from '@kmamal/sdl' const window = sdl.video.createWindow({ title: "Hello, World!" }) window.on('*', console.log) ``` ### Canvas2D ```js import sdl from '@kmamal/sdl' import { createCanvas } from '@napi-rs/canvas' // Setup const window = sdl.video.createWindow({ title: "Canvas2D" }) const { pixelWidth: width, pixelHeight: height } = window const canvas = createCanvas(width, height) const ctx = canvas.getContext('2d') // Clear screen to red ctx.fillStyle = 'red' ctx.fillRect(0, 0, width, height) // Render to window const buffer = Buffer.from(ctx.getImageData(0, 0, width, height).data) window.render(width, height, width * 4, 'rgba32', buffer) ``` ### WebGL ```js import sdl from '@kmamal/sdl' import createContext from '@kmamal/gl' // Setup const window = sdl.video.createWindow({ title: "WebGL", opengl: true }) const { pixelWidth: width, pixelHeight: height, native } = window const gl = createContext(width, height, { window: native }) // Clear screen to red gl.clearColor(1, 0, 0, 1) gl.clear(gl.COLOR_BUFFER_BIT) // Render to window gl.swap() ``` ### WebGPU ```js import sdl from '@kmamal/sdl' import gpu from '@kmamal/gpu' // Setup const window = sdl.video.createWindow({ title: "WebGPU", webgpu: true }) const instance = gpu.create([]) const adapter = await instance.requestAdapter() const device = await adapter.requestDevice() const renderer = gpu.renderGPUDeviceToWindow({ device, window }) // Clear screen to red const commandEncoder = device.createCommandEncoder() const renderPass = commandEncoder.beginRenderPass({ colorAttachments: [ { view: renderer.getCurrentTextureView(), clearValue: { r: 1.0, g: 0.0, b: 0.0, a: 1.0 }, loadOp: 'clear', storeOp: 'store', }, ], }) renderPass.end() device.queue.submit([ commandEncoder.finish() ]) // Render to window renderer.swap() ``` ### More examples Check the [`examples/`](https://github.com/kmamal/node-sdl/tree/master/examples#readme) folder. # API Reference ## Contents - [sdl](#sdl) - [sdl.info](#sdlinfo) - [sdl.video](#sdlvideo) - [Image data](#image-data) - [High-DPI](#high-dpi) - [Pixel formats](#pixel-formats) - [Event: 'displayAdd'](#event-displayadd) - [Event: 'displayRemove'](#event-displayremove) - [Event: 'displayOrient'](#event-displayorient) - [Event: 'displayMove'](#event-displaymove) - [sdl.video.displays](#sdlvideodisplays) - [sdl.video.windows](#sdlvideowindows) - [sdl.video.focused](#sdlvideofocused) - [sdl.video.hovered](#sdlvideohovered) - [sdl.video.createWindow([options])](#sdlvideocreatewindowoptions) - [class Window](#class-window) - [Event: 'show'](#event-show) - [Event: 'hide'](#event-hide) - [Event: 'expose'](#event-expose) - [Event: 'minimize'](#event-minimize) - [Event: 'maximize'](#event-maximize) - [Event: 'restore'](#event-restore) - [Event: 'move'](#event-move) - [Event: 'resize'](#event-resize) - [Event: 'displayChange'](#event-displaychange) - [Event: 'focus'](#event-focus) - [Event: 'blur'](#event-blur) - [Event: 'hover'](#event-hover) - [Event: 'leave'](#event-leave) - [Event: 'beforeClose'](#event-beforeclose) - [Event: 'close'](#event-close) - [Event: 'keyDown'](#event-keydown) - [Event: 'keyUp'](#event-keyup) - [Event: 'textInput'](#event-textinput) - [Event: 'mouseButtonDown'](#event-mousebuttondown) - [Event: 'mouseButtonUp'](#event-mousebuttonup) - [Event: 'mouseMove'](#event-mousemove) - [Event: 'mouseWheel'](#event-mousewheel) - [Event: 'fingerDown'](#event-fingerdown) - [Event: 'fingerUp'](#event-fingerup) - [Event: 'fingerMove'](#event-fingermove) - [Event: 'dropBegin'](#event-dropbegin) - [Event: 'dropText'](#event-droptext) - [Event: 'dropFile'](#event-dropfile) - [Event: 'dropComplete'](#event-dropcomplete) - [window.id](#windowid) - [window.title](#windowtitle) - [window.setTitle(title)](#windowsettitletitle) - [window.x](#windowx) - [window.y](#windowy) - [window.setPosition(x, y)](#windowsetpositionx-y) - [window.width](#windowwidth) - [window.height](#windowheight) - [window.pixelWidth](#windowpixelwidth) - [window.pixelHeight](#windowpixelheight) - [window.setSize(width, height)](#windowsetsizewidth-height) - [window.setSizeInPixels(pixelWidth, pixelHeight)](#windowsetsizeinpixelspixelwidth-pixelheight) - [window.display](#windowdisplay) - [window.visible](#windowvisible) - [window.show([show])](#windowshowshow) - [window.hide()](#windowhide) - [window.fullscreen](#windowfullscreen) - [window.setFullscreen(fullscreen)](#windowsetfullscreenfullscreen) - [window.resizable](#windowresizable) - [window.setResizable(resizable)](#windowsetresizableresizable) - [window.borderless](#windowborderless) - [window.setBorderless(borderless)](#windowsetborderlessborderless) - [window.alwaysOnTop](#windowalwaysontop) - [window.accelerated](#windowaccelerated) - [window.setAccelerated(accelerated)](#windowsetacceleratedaccelerated) - [window.vsync](#windowvsync) - [window.setVsync(vsync)](#windowsetvsyncvsync) - [window.opengl](#windowopengl) - [window.webgpu](#windowwebgpu) - [window.native](#windownative) - [window.maximized](#windowmaximized) - [window.maximize()](#windowmaximize) - [window.minimized](#windowminimized) - [window.minimize()](#windowminimize) - [window.restore()](#windowrestore) - [window.focused](#windowfocused) - [window.focus()](#windowfocus) - [window.hovered](#windowhovered) - [window.skipTaskbar](#windowskiptaskbar) - [window.popupMenu](#windowpopupmenu) - [window.tooltip](#windowtooltip) - [window.utility](#windowutility) - [window.render(width, height, stride, format, buffer[, options])](#windowrenderwidth-height-stride-format-buffer-options) - [window.setIcon(width, height, stride, format, buffer)](#windowseticonwidth-height-stride-format-buffer) - [window.flash([untilFocused])](#windowflashuntilfocused) - [window.stopFlashing()](#windowstopflashing) - [window.destroyed](#windowdestroyed) - [window.destroy()](#windowdestroy) - [window.destroyGently()](#windowdestroygently) - [sdl.keyboard](#sdlkeyboard) - [Virtual keys](#virtual-keys) - [Enum: SCANCODE](#enum-scancode) - [Event: 'keymapChange'](#event-keymapchange) - [sdl.keyboard.getKey(scancode)](#sdlkeyboardgetkeyscancode) - [sdl.keyboard.getScancode(key)](#sdlkeyboardgetscancodekey) - [sdl.keyboard.getState()](#sdlkeyboardgetstate) - [sdl.mouse](#sdlmouse) - [Enum: BUTTON](#enum-button) - [sdl.mouse.getButton(button)](#sdlmousegetbuttonbutton) - [sdl.mouse.position](#sdlmouseposition) - [sdl.mouse.setPosition(x, y)](#sdlmousesetpositionx-y) - [sdl.mouse.setCursor(cursor)](#sdlmousesetcursorcursor) - [sdl.mouse.resetCursor()](#sdlmouseresetcursor) - [sdl.mouse.setCursorImage(width, height, stride, format, buffer, x, y)](#sdlmousesetcursorimagewidth-height-stride-format-buffer-x-y) - [sdl.mouse.showCursor([show])](#sdlmouseshowcursorshow) - [sdl.mouse.hideCursor()](#sdlmousehidecursor) - [sdl.mouse.redrawCursor()](#sdlmouseredrawcursor) - [sdl.mouse.capture([capture])](#sdlmousecapturecapture) - [sdl.mouse.uncapture()](#sdlmouseuncapture) - [sdl.joystick](#sdljoystick) - [Hat positions](#hat-positions) - [Power levels](#power-levels) - [Event: 'deviceAdd'](#joystick-event-deviceadd) - [Event: 'deviceRemove'](#joystick-event-deviceremove) - [sdl.joystick.devices](#sdljoystickdevices) - [sdl.joystick.openDevice(device)](#sdljoystickopendevicedevice) - [class JoystickInstance](#class-joystickinstance) - [Event: 'axisMotion'](#joystick-instance-event-axismotion) - [Event: 'ballMotion'](#event-ballmotion) - [Event: 'buttonDown'](#joystick-instance-event-buttondown) - [Event: 'buttonUp'](#joystick-instance-event-buttonup) - [Event: 'hatMotion'](#event-hatmotion) - [Event: 'powerUpdate'](#joystick-instance-event-power-update) - [Event: 'close'](#joystick-instance-event-close) - [joystickInstance.device](#joystickinstancedevice) - [joystickInstance.firmwareVersion](#joystickinstancefirmwareversion) - [joystickInstance.serialNumber](#joystickinstanceserialnumber) - [joystickInstance.axes](#joystickinstanceaxes) - [joystickInstance.balls](#joystickinstanceballs) - [joystickInstance.buttons](#joystickinstancebuttons) - [joystickInstance.hats](#joystickinstancehats) - [joystickInstance.power](#joystickinstancepower) - [joystickInstance.setPlayer(index)](#joystickinstancesetplayerindex) - [joystickInstance.resetPlayer()](#joystickinstanceresetplayer) - [joystickInstance.hasLed](#joystickinstancehasled) - [joystickInstance.setLed(red, green, blue)](#joystickinstancesetledred-green-blue) - [joystickInstance.hasRumble](#joystickinstancehasrumble) - [joystickInstance.rumble([low[, high[, duration]]])](#joystickinstancerumblelow-high-duration) - [joystickInstance.stopRumble()](#joystickinstancestoprumble) - [joystickInstance.hasRumbleTriggers](#joystickinstancehasrumbletriggers) - [joystickInstance.rumbleTriggers([left[, right[, duration]]])](#joystickinstancerumbletriggersleft-right-duration) - [joystickInstance.stopRumbleTriggers()](#joystickinstancestoprumbletriggers) - [joystickInstance.closed](#joystickinstanceclosed) - [joystickInstance.close()](#joystickinstanceclose) - [sdl.controller](#sdlcontroller) - [Event: 'deviceAdd'](#controller-event-deviceadd) - [Event: 'deviceRemove'](#controller-event-deviceremove) - [sdl.controller.addMappings(mappings)](#sdlcontrolleraddmappingsmappings) - [sdl.controller.devices](#sdlcontrollerdevices) - [sdl.controller.openDevice(device)](#sdlcontrolleropendevicedevice) - [class ControllerInstance](#class-controllerinstance) - [Event: 'axisMotion'](#controller-instance-event-axismotion) - [Event: 'buttonDown'](#controller-instance-event-buttondown) - [Event: 'buttonUp'](#controller-instance-event-buttonup) - [Event: 'powerUpdate'](#controller-instance-event-power-update) - [Event: 'steamHandleUpdate'](#event-steamhandleupdate) - [Event: 'remap'](#event-remap) - [Event: 'close'](#controller-instance-event-close) - [controllerInstance.device](#controllerinstancedevice) - [controllerInstance.firmwareVersion](#controllerinstancefirmwareversion) - [controllerInstance.serialNumber](#controllerinstanceserialnumber) - [controllerInstance.steamHandle](#controllerinstancesteamhandle) - [controllerInstance.axes](#controllerinstanceaxes) - [controllerInstance.buttons](#controllerinstancebuttons) - [controllerInstance.power](#controllerinstancepower) - [controllerInstance.setPlayer(index)](#controllerinstancesetplayerindex) - [controllerInstance.resetPlayer()](#controllerinstanceresetplayer) - [controllerInstance.hasLed](#controllerinstancehasled) - [controllerInstance.setLed(red, green, blue)](#controllerinstancesetledred-green-blue) - [controllerInstance.hasRumble](#controllerinstancehasrumble) - [controllerInstance.rumble([low[, high[, duration]]])](#controllerinstancerumblelow-high-duration) - [controllerInstance.stopRumble()](#controllerinstancestoprumble) - [controllerInstance.hasRumbleTriggers](#controllerinstancehasrumbletriggers) - [controllerInstance.rumbleTriggers([left[, right[, duration]]])](#controllerinstancerumbletriggersleft-right-duration) - [controllerInstance.stopRumbleTriggers()](#controllerinstancestoprumbletriggers) - [controllerInstance.closed](#controllerinstanceclosed) - [controllerInstance.close()](#controllerinstanceclose) - [sdl.sensor](#sdlsensor) - [sdl.sensor.STANDARD_GRAVITY](#sdlsensorstandard_gravity) - [sdl.sensor.devices](#sdlsensordevices) - [sdl.sensor.openDevice(device)](#sdlsensoropendevicedevice) - [class SensorInstance](#class-sensorinstance) - [Event: 'update'](#sensor-instance-event-update) - [sensorInstance.device](#sensorinstancedevice) - [sensorInstance.data](#sensorinstancedata) - [sensorInstance.closed](#sensorinstanceclosed) - [sensorInstance.close()](#sensorinstanceclose) - [sdl.audio](#sdlaudio) - [Audio data](#audio-data) - [Sample formats](#sample-formats) - [Event: 'deviceAdd'](#audio-event-deviceadd) - [Event: 'deviceRemove'](#audio-event-deviceremove) - [sdl.audio.bytesPerSample(format)](#sdlaudiobytespersampleformat) - [sdl.audio.minSampleValue(format)](#sdlaudiominsamplevalueformat) - [sdl.audio.maxSampleValue(format)](#sdlaudiomaxsamplevalueformat) - [sdl.audio.zeroSampleValue(format)](#sdlaudiozerosamplevalueformat) - [sdl.audio.readSample(format, buffer[, offset])](#sdlaudioreadsampleformat-buffer-offset) - [sdl.audio.writeSample(format, buffer, value[, offset])](#sdlaudiowritesampleformat-buffer-value-offset) - [sdl.audio.devices](#sdlaudiodevices) - [sdl.audio.openDevice(device[, options])](#sdlaudioopendevicedevice-options) - [class AudioInstance](#class-audioinstance) - [Event: 'close'](#audio-instance-event-close) - [audioInstance.id](#audioinstanceid) - [audioInstance.channels](#audioinstancechannels) - [audioInstance.frequency](#audioinstancefrequency) - [audioInstance.format](#audioinstanceformat) - [audioInstance.bytesPerSample](#audioinstancebytespersample) - [audioInstance.minSampleValue](#audioinstanceminsamplevalue) - [audioInstance.maxSampleValue](#audioinstancemaxsamplevalue) - [audioInstance.zeroSampleValue](#audioinstancezerosamplevalue) - [audioInstance.readSample(buffer[, offset])](#audioinstancereadsamplebuffer-offset) - [audioInstance.writeSample(buffer, value[, offset])](#audioinstancewritesamplebuffer-value-offset) - [audioInstance.buffered](#audioinstancebuffered) - [audioInstance.playing](#audioinstanceplaying) - [audioInstance.play([play])](#audioinstanceplayplay) - [audioInstance.pause()](#audioinstancepause) - [audioInstance.queued](#audioinstancequeued) - [audioInstance.clearQueue()](#audioinstanceclearqueue) - [audioInstance.closed](#audioinstanceclosed) - [audioInstance.close()](#audioinstanceclose) - [class AudioPlaybackInstance extends AudioInstance](#class-audioplaybackinstance-extends-audioinstance) - [playbackInstance.enqueue(buffer[, bytes])](#playbackinstanceenqueuebuffer-bytes) - [class AudioRecordingInstance extends AudioInstance](#class-audiorecordinginstance-extends-audioinstance) - [recordingInstance.dequeue(buffer[, bytes])](#recordinginstancedequeuebuffer-bytes) - [sdl.clipboard](#sdlclipboard) - [Event: 'update'](#clipboard-event-update) - [sdl.clipboard.text](#sdlclipboardtext) - [sdl.clipboard.setText(text)](#sdlclipboardsettexttext) - [sdl.power](#sdlpower) - [sdl.power.info](#sdlpowerinfo) - [helpers](#helpers) ## sdl ### sdl.info - `` - `version: ` - `compile: ` The version of the SDL library that this package was compiled against. - `major, minor, patch: ` The components of the version. - `runtime: ` The version of the SDL library that was found and loaded at runtime. - `major, minor, patch: ` The components of the version. - `platform: ` The name of the platform we are running on. Possible values are: `'Linux'`, `'Windows'`, and `'Mac OS X'`. - `drivers: ` - `video: ` - `all: []` A list of all video drivers. - `current: |` The video driver that is currently selected. - `audio: ` - `all: []` A list of all audio drivers. - `current: |` The audio driver that is currently selected. - `initialized: ` - `video: `: Is `true` if the video subsystem was successfully initialized, or `false` otherwise. - `audio: `: Is `true` if the audio subsystem was successfully initialized, or `false` otherwise. - `joystick: `: Is `true` if the joystick subsystem was successfully initialized, or `false` otherwise. - `controller: `: Is `true` if the controller subsystem was successfully initialized, or `false` otherwise. - `haptic: `: Is `true` if the haptic subsystem was successfully initialized, or `false` otherwise. - `sensor: `: Is `true` if the sensor subsystem was successfully initialized, or `false` otherwise. The `sdl.info` object is filled with information produced during the initialization of SDL. All the values remain constant throughout the execution of the program. To initialize SDL with video/audio drivers other than the default ones, set the appropriate [environment variables](https://wiki.libsdl.org/FAQUsingSDL) to the desired value. Note that the `current` video or audio driver may be `null`. This usually happens on systems that don't have any compatible devices, such as on a CI pipeline. Sample data for Ubuntu: ```js { version: { compile: { major: 2, minor: 0, patch: 10 }, runtime: { major: 2, minor: 0, patch: 10 }, }, platform: 'Linux', drivers: { video: { all: [ 'x11', 'wayland', 'dummy' ], current: 'x11', }, audio: { all: [ 'pulseaudio', 'alsa', 'sndio', 'dsp', 'disk', 'dummy' ], current: 'pulseaudio', }, }, initialized: { video: true, audio: true, joystick: true, controller: true, haptic: true, sensor: true, }, } ``` ## sdl.video ### Image data There are 3 places in the API where you must provide an image to the library: - [`window.render()`](#windowrenderwidth-height-stride-format-buffer-options) - [`window.setIcon()`](#windowseticonwidth-height-stride-format-buffer) - [`mouse.setCursorImage()`](#sdlmousesetcursorimagewidth-height-stride-format-buffer-x-y) All three of these functions accept the image as a series of arguments: - `width: ` The width of the image in pixels. - `height: ` The height of the image in pixels. - `stride: ` How many bytes each row of the image takes up in the buffer. Usually equal to `width * bytesPerPixel`, but may be larger if the rows of the buffer are padded to always be some multiple of bytes. - `format: `[``](#pixel-formats) The binary representation of the data in the buffer. - `buffer: ` Holds the actual pixel data for the image, in the format and layout specified by all the above arguments. So, for example, to fill the window with a red+green gradient you could do: ```js const { pixelWidth: width, pixelHeight: height } = window const stride = width * 4 const buffer = Buffer.alloc(stride * height) let offset = 0 for (let i = 0; i < height; i++) { for (let j = 0; j < width; j++) { buffer[offset++] = Math.floor(256 * i / height) // R buffer[offset++] = Math.floor(256 * j / width) // G buffer[offset++] = 0 // B buffer[offset++] = 255 // A } } window.render(width, height, stride, 'rgba32', buffer) ``` ### High-DPI On a high-dpi display, windows have more pixels than their `width` and `height` would indicate. On such systems `width` and `height` (and all other measurements such as `x` and `y`) are measured in "points" instead of pixels. Points are an abstract unit of measurement and don't necessarily correspond to pixels. If you need to work with pixels, you can use the window's `pixelWidth` and `pixelHeight` properties. You usually need these values when creating a "surface" that will be displayed on the window, such as a Buffer, Canvas, or 3D rendering viewport. I recommend that in these cases you always use `pixelWidth` and `pixelHeight`, since you don't know beforehand if your program will be running on a high-dpi system or not. ### Pixel formats String values used to represent how the pixels of an image are stored in a Buffer. | Value | Corresponding `SDL_PixelFormatEnum` | Comment | | --- | --- | --- | | `'rgb332'` | `SDL_PIXELFORMAT_RGB332` | | | `'rgb444'` | `SDL_PIXELFORMAT_RGB444` | | | `'rgb555'` | `SDL_PIXELFORMAT_RGB555` | | | `'bgr555'` | `SDL_PIXELFORMAT_BGR555` | | | `'argb4444'` | `SDL_PIXELFORMAT_ARGB4444` | | | `'rgba4444'` | `SDL_PIXELFORMAT_RGBA4444` | | | `'abgr4444'` | `SDL_PIXELFORMAT_ABGR4444` | | | `'bgra4444'` | `SDL_PIXELFORMAT_BGRA4444` | | | `'argb1555'` | `SDL_PIXELFORMAT_ARGB1555` | | | `'rgba5551'` | `SDL_PIXELFORMAT_RGBA5551` | | | `'abgr1555'` | `SDL_PIXELFORMAT_ABGR1555` | | | `'bgra5551'` | `SDL_PIXELFORMAT_BGRA5551` | | | `'rgb565'` | `SDL_PIXELFORMAT_RGB565` | | | `'bgr565'` | `SDL_PIXELFORMAT_BGR565` | | | `'rgb24'` | `SDL_PIXELFORMAT_RGB24` | | | `'bgr24'` | `SDL_PIXELFORMAT_BGR24` | | | `'rgb888'` | `SDL_PIXELFORMAT_RGB888` | | | `'rgbx8888'` | `SDL_PIXELFORMAT_RGBX8888` | | | `'bgr888'` | `SDL_PIXELFORMAT_BGR888` | | | `'bgrx8888'` | `SDL_PIXELFORMAT_BGRX8888` | | | `'argb8888'` | `SDL_PIXELFORMAT_ARGB8888` | | | `'rgba8888'` | `SDL_PIXELFORMAT_RGBA8888` | | | `'abgr8888'` | `SDL_PIXELFORMAT_ABGR8888` | | | `'bgra8888'` | `SDL_PIXELFORMAT_BGRA8888` | | | `'argb2101010'` | `SDL_PIXELFORMAT_ARGB2101010` | | | `'rgba32'` | `SDL_PIXELFORMAT_RGBA32` | alias for `'rgba8888'` on big endian machines and for `'abgr8888'` on little endian machines | | `'argb32'` | `SDL_PIXELFORMAT_ARGB32` | alias for `'argb8888'` on big endian machines and for `'bgra8888'` on little endian machines | | `'bgra32'` | `SDL_PIXELFORMAT_BGRA32` | alias for `'bgra8888'` on big endian machines and for `'argb8888'` on little endian machines | | `'abgr32'` | `SDL_PIXELFORMAT_ABGR32` | alias for `'abgr8888'` on big endian machines and for `'rgba8888'` on little endian machines | | `'yv12'` | `SDL_PIXELFORMAT_YV12` | planar mode: Y + V + U (3 planes) | | `'iyuv'` | `SDL_PIXELFORMAT_IYUV` | planar mode: Y + U + V (3 planes) | | `'yuy2'` | `SDL_PIXELFORMAT_YUY2` | packed mode: Y0+U0+Y1+V0 (1 plane) | | `'uyvy'` | `SDL_PIXELFORMAT_UYVY` | packed mode: U0+Y0+V0+Y1 (1 plane) | | `'yvyu'` | `SDL_PIXELFORMAT_YVYU` | packed mode: Y0+V0+Y1+U0 (1 plane) | | `'nv12'` | `SDL_PIXELFORMAT_NV12` | planar mode: Y + U/V interleaved (2 planes) | | `'nv21'` | `SDL_PIXELFORMAT_NV21` | planar mode: Y + V/U interleaved (2 planes) | ### Event: 'displayAdd' - `device: `: An object from [`sdl.video.displays`](#sdlvideodisplays) indicating the display that caused the event. Fired when a display is added to the system. Check [`sdl.video.displays`](#sdlvideodisplays) to get the new list of displays. ### Event: 'displayRemove' - `device: `: An object from [`sdl.video.displays`](#sdlvideodisplays) indicating the display that caused the event. Fired when a display is removed from the system. Check [`sdl.video.displays`](#sdlvideodisplays) to get the new list of displays. ### Event: 'displayOrient' - `device: `: An object from [`sdl.video.displays`](#sdlvideodisplays) indicating the display that caused the event. - `orientation: `: The display's new orientation. Fired when a display changes orientation. ### Event: 'displayMove' - `device: `: An object from [`sdl.video.displays`](#sdlvideodisplays) indicating the display that caused the event. Fired when a display changes position. ### sdl.video.displays - `[]` - `name: |` The name of the display, or `null` if it can't be determined. - `format: `[``](#pixel-formats) The pixel format of the display. - `frequency: ` The refresh rate of the display. - `geometry: ` The desktop region represented by the display. - `x, y, width, height: ` The position and size of the display's geometry. - `usable: ` Similar to `geometry`, but excludes areas taken up by the OS or window manager such as menus, docks, e.t.c. - `x, y, width, height: ` The position and size of the display's usable region. - `dpi: |` Return pixel density for the display in dots/pixels-per-inch units. Might be `null` on some devices if DPI info can't be retrieved. - `horizontal: ` The horizontal density. - `vertical: ` The vertical density. - `diagonal: ` The diagonal density. - `orientation: |` The orientation of the display. A list of all detected displays. Possible values for `orientation` are `null` if it is unknown, or one of: | Value | Corresponding `SDL_DisplayOrientation` | | --- | --- | | `'landscape'` | `SDL_ORIENTATION_LANDSCAPE` | | `'landscapeFlipped'` | `SDL_ORIENTATION_LANDSCAPE_FLIPPED` | | `'portrait'` | `SDL_ORIENTATION_PORTRAIT` | | `'portraitFlipped'` | `SDL_ORIENTATION_PORTRAIT_FLIPPED` | Sample output for two side-to-side monitors is below. Notice how the geometries don't overlap: ```js [ { name: '0', format: 'rgb888', frequency: 60, geometry: { x: 0, y: 0, width: 1920, height: 1080 }, usable: { x: 0, y: 27, width: 1920, height: 1053 }, dpi: { horizontal: 141.76, vertical: 142.13, diagonal: 141.85 }, }, { name: '1', format: 'rgb888', frequency: 60, geometry: { x: 1920, y: 0, width: 1920, height: 1080 }, usable: { x: 1920, y: 27, width: 1920, height: 1053 }, dpi: { horizontal: 141.76, vertical: 142.13, diagonal: 141.85 }, }, ] ``` ### sdl.video.windows - [``](#class-window)`[]` A list of all open windows. ### sdl.video.focused - [``](#class-window)`|` The window that has the current keyboard focus, or `null` if no window has the keyboard focus. ### sdl.video.hovered - [``](#class-window)`|` The window that the mouse is hovered over, or `null` if the mouse is not over a window. ### sdl.video.createWindow([options]) - `options: ` - `title: ` Appears in the window's title bar. Default: `''` - `display: ` An object from `sdl.video.displays` to specify in which display the window should appear (if you have multiple displays). Default: `sdl.video.displays[0]` - `x: ` The x position in which the window should appear relative to the screen, or `null` for centered. Default: `null` - `y: ` The y position in which the window should appear relative to the screen, or `null` for centered. Default: `null` - `width: ` The width of the window. Default: `640` - `height: ` The height of the window. Default: `480` - `visible: ` Set to `false` to create a hidden window that will only be shown when you call [`window.show()`](#windowshowshow). Default: `true` - `fullscreen: ` Set to `true` to create the window in fullscreen mode. Default: `false` - `resizable: ` Set to `true` to allow resizing the window by dragging its borders. Default: `false` - `borderless: ` Set to `true` to completely hide the window's borders and title bar. Default: `false` - `alwaysOnTop: ` Set to `true` to always show the window above others. Default: `false` - `accelerated: ` Set to `false` to disable hardware accelerated rendering. Default: `true` - `vsync: ` Set to `false` to disable frame rate synchronization. Default: `true` - `opengl: ` Set to `true` to create an OpenGL-compatible window (for use with [@kmamal/gl](https://github.com/kmamal/headless-gl#readme)). Default: `false` - `webgpu: ` Set to `true` to create an WebGPU-compatible window (for use with [@kmamal/gpu](https://github.com/kmamal/gpu#readme)). Default: `false` - `skipTaskbar: ` X11 only. Set to `true` to not add the window to the taskbar. Default: `false` - `popupMenu: ` X11 only. Set to `true` to treat the window like a popup menu. Default: `false` - `tooltip: ` X11 only. Set to `true` to treat the window like a tooltip. Default: `false` - `utility: ` X11 only. Set to `true` to treat the window like a utility window. Default: `false` - Returns: [``](#class-window) an object representing the new window. Creates a new window. The following restrictions apply: - The `display` option is mutually exclusive with the `x` and `y` options. - The `resizable` and `borderless` options are mutually exclusive. - The `opengl` and `webgpu` options are mutually exclusive. - The `vsync` option only applies to windows that are also `accelerated`. - The `accelerated` and `vsync` options have no effect if either `opengl` or `webgpu` is also specified. If you set the `opengl` or `webgpu` options, then you must use OpenGL/WebGPU calls to render to the window. Calls to [`render()`](#windowrenderwidth-height-stride-format-buffer-options) will fail. ## class Window The `Window` class is not directly exposed by the API so you can't (and shouldn't) use it with the `new` operator. Instead, objects returned by [`sdl.video.createWindow()`](#sdlvideocreatewindowoptions) are of type `Window`. ### Event: 'show' Fired when the window becomes visible. ### Event: 'hide' Fired when the window becomes hidden. ### Event: 'expose' Fired when the window becomes exposed and should be redrawn. ### Event: 'minimize' Fired when the window becomes minimized. ### Event: 'maximize' Fired when the window becomes maximized. ### Event: 'restore' Fired when the window gets restored. ### Event: 'move' - `x: ` The window's new x position, relative to the screen. - `y: ` The window's new y position, relative to the screen. Fired when the window changes position. ### Event: 'resize' - `width: ` The window's new width. - `height: ` The window's new height. - `pixelWidth: ` The window's new width in pixels. See [high-dpi](#high-dpi). - `pixelHeight: ` The window's new height in pixels. See [high-dpi](#high-dpi). Fired when the window changes size. ### Event: 'displayChange' - `display: ` An object from [`sdl.video.displays`](#sdlvideodisplays) indicating the window's new display. Fired when the window moves from one display to another. ### Event: 'focus' Fired when the window gains the keyboard focus. ### Event: 'blur' Fired when the window loses the keyboard focus. ### Event: 'hover' Fired when the mouse enters the window. ### Event: 'leave' Fired when the mouse leaves the window. ### Event: 'beforeClose' - `prevent: void>` Call this function to prevent the window from closing. Fired to indicate that the user requested that the window should close (usually by clicking the "x" button). If you need to display any confirmation dialogs, call `event.prevent()` and afterwards handle destruction manually. If `prevent` is not called, then the `beforeClose` event will be followed by a [`'close'`](#event-close) event. ### Event: 'close' Indicates that the window is about to be destroyed. Handle any cleanup here. ### Event: 'keyDown' - `scancode: `[``](#enum-scancode) The scancode of the key that caused the event. - `key: `[``](#virtual-keys)`|` The virtual key that caused the event, or `null` if the physical key does not correspond to any virtual key. - `repeat: ` Is `true` if the event was generated by holding down a key for a long time. - `shift: ` Is `true` if the Shift key was pressed when the event was generated. - `ctrl: ` Is `true` if the Ctrl key was pressed when the event was generated. - `alt: ` Is `true` if the Alt key was pressed when the event was generated. - `super: ` Is `true` if the "Windows" key was pressed when the event was generated. - `altgr: ` Is `true` if the AltGr key was pressed when the event was generated. - `capslock: ` Is `true` if CapsLock was active when the event was generated. - `numlock: ` Is `true` if NumLock was active when the event was generated. Fired when a key is pressed, and will also be fired repeatedly afterwards if the key is held down. ### Event: 'keyUp' - `scancode: `[``](#enum-scancode) The scancode of the key that caused the event. - `key: `[``](#virtual-keys)`|` The virtual key that caused the event, or `null` if the physical key does not correspond to any virtual key. - `shift: ` Is `true` if the Shift key was pressed when the event was generated. - `ctrl: ` Is `true` if the Ctrl key was pressed when the event was generated. - `alt: ` Is `true` if the Alt key was pressed when the event was generated. - `super: ` Is `true` if the "Windows" key was pressed when the event was generated. - `altgr: ` Is `true` if the AltGr key was pressed when the event was generated. - `capslock: ` Is `true` if CapsLock was active when the event was generated. - `numlock: ` Is `true` if NumLock was active when the event was generated. Fired when a key is released. ### Event: 'textInput' - `text: ` The unicode representation of the character that was entered. Fired when text is entered via the keyboard. ### Event: 'mouseButtonDown' - `x: ` The mouse's x position when the event happened, relative to the window. - `y: ` The mouse's y position when the event happened, relative to the window. - `touch: ` Is `true` if the event was caused by a touch event. - `button: `[``](#enum-button) The button that was pressed. Fired when a mouse button is pressed. ### Event: 'mouseButtonUp' - `x: ` The mouse's x position when the event happened, relative to the window. - `y: ` The mouse's y position when the event happened, relative to the window. - `touch: ` Is `true` if the event was caused by a touch event. - `button: `[``](#enum-button) The button that was released. Fired when a mouse button is released. ### Event: 'mouseMove' - `x: ` The mouse's x position when the event happened, relative to the window. - `y: ` The mouse's y position when the event happened, relative to the window. - `touch: ` Is `true` if the event was caused by a touch event. Fired when the mouse moves. ### Event: 'mouseWheel' - `x: ` The mouse's x position when the event happened, relative to the window. - `y: ` The mouse's y position when the event happened, relative to the window. - `touch: ` Is `true` if the event was caused by a touch event. - `dx: ` The wheel's x movement, relative to its last position. - `dy: ` The wheel's y movement, relative to its last position. - `flipped: ` Is `true` if the underlying platform reverses the mouse wheel's scroll direction. Multiply `dx` and `dy` by `-1` to get the correct values. Fired when the mouse wheel is scrolled. ### Event: 'fingerDown' - `device: `: An object from [`sdl.touch.devices`](#sdltouchdevices) indicating the touch device that caused the event. - `fingerId: ` The id of the finger that coused the event. - `x: ` The finger's x position when the event happened, normalized in the range from `0` to `1`. - `y: ` The finger's y position when the event happened, normalized in the range from `0` to `1`. - `pressure: ` The finger's pressure when the event happened, normalized in the range from `0` to `1`. - `mouse: ` Is `true` if the event was caused by a mouse event. Fired when a finger is presed to the touch surface. ### Event: 'fingerUp' - `device: `: An object from [`sdl.touch.devices`](#sdltouchdevices) indicating the touch device that caused the event. - `fingerId: ` The id of the finger that coused the event. - `x: ` The finger's x position when the event happened, normalized in the range from `0` to `1`. - `y: ` The finger's y position when the event happened, normalized in the range from `0` to `1`. - `pressure: ` The finger's pressure when the event happened, normalized in the range from `0` to `1`. - `mouse: ` Is `true` if the event was caused by a mouse event. Fired when a finger is lifted from the touch surface. ### Event: 'fingerMove' - `device: `: An object from [`sdl.touch.devices`](#sdltouchdevices) indicating the touch device that caused the event. - `fingerId: ` The id of the finger that coused the event. - `x: ` The finger's x position when the event happened, normalized in the range from `0` to `1`. - `y: ` The finger's y position when the event happened, normalized in the range from `0` to `1`. - `dx: ` The finger's x position when the event happened, normalized in the range from `-1` to `1`. - `dy: ` The finger's y position when the event happened, normalized in the range from `-1` to `1`. - `pressure: ` The finger's pressure when the event happened, normalized in the range from `0` to `1`. - `mouse: ` Is `true` if the event was caused by a mouse event. Fired when a finger moves on the touch surface. ### Event: 'dropBegin' When you drop a set of items onto a window, first the [`'dropBegin'`](#event-dropbegin) event is fired, then a number of [`'dropText'`](#event-droptext) and/or [`'dropFile'`](#event-dropfile) events are fired, corresponding to the contents of the drop, then finally the [`'dropComplete'`](#event-dropcomplete) event is fired. ### Event: 'dropText' - `text: `: The text that was dropped onto the window. Fired when one of the drops is a text item. ### Event: 'dropFile' - `file: `: The path to the file that was dropped onto the window. Fired when one of the drops is a file. ### Event: 'dropComplete' Fired after a set of items has been dropped on a window. ### window.id - `` A unique identifier for the window. ### window.title - `` The text that appears in the window's title bar. ### window.setTitle(title) - `title: `: The new title. Changes the text that appears in the window's title bar. ### window.x - `` The window's x position, relative to the screen. ### window.y - `` The window's y position, relative to the screen. ### window.setPosition(x, y) - `x: `: The new x position, relative to the screen. - `y: `: The new y position, relative to the screen. Moves the window to a new position on the screen. ### window.width - `` The window's width. ### window.height - `` The window's height. ### window.pixelWidth - `` The window's width in pixels. Is larger than [`width`](#windowwidth) on [high-dpi](#high-dpi) displays. ### window.pixelHeight - `` The window's height in pixels. Is larger than [`height`](#windowheight) on [high-dpi](#high-dpi) displays. ### window.setSize(width, height) - `width: `: The new width. - `height: `: The new height. Changes the size of the window. ### window.setSizeInPixels(pixelWidth, pixelHeight) - `pixelWidth: `: The new width in pixels. - `pixelHeight: `: The new height in pixels. Changes the size of the window. This function only behaves differently from [`window.setSize()`](#windowsetsizewidth-height) for [high-dpi](#high-dpi) displays. ### window.display - `` An object from [`sdl.video.displays`](#sdlvideodisplays) indicating the display the window belongs to. If the window spans multiple displays, then the display that contains the center of the window is returned. ### window.visible - `` Is `true` if the window is visible. ### window.show([show]) - `show: ` Set to `true` to make the window visible, `false` to hide it. Default: `true` Shows or hides the window. ### window.hide() Equivalent to [`window.show(false)`](#windowshowshow). ### window.fullscreen - `` Is `true` if the window is fullscreen. A fullscreen window is displayed over the entire screen. ### window.setFullscreen(fullscreen) - `fullscreen: ` The new value of the property. Changes the window's fullscreen property. ### window.resizable - `` Is `true` if the window is resizable. A resizable window can be resized by dragging its borders. ### window.setResizable(resizable) - `resizable: ` The new value of the property. Changes the window's resizable property. ### window.borderless - `` Is `true` if the window is borderless. A borderless window has no borders or title bar. ### window.setBorderless(borderless) - `borderless: ` The new value of the property. Changes the window's borderless property. ### window.alwaysOnTop - `` Is `true` if the window was created with `alwaysOnTop: true`. Such a window is always be shown above other windows. ### window.accelerated - `` Is `true` if the window is using hardware accelerated rendering. ### window.setAccelerated(accelerated) - `accelerated: ` The new value of the property. Changes the window's accelerated property. If you have set the `opengl` or `webgpu` options, then calls to this function will fail. ### window.vsync - `` Is `true` if the window is using vsync. Vsync synchronizes the window's frame rate with the display's refresh rate to prevent tearing. Note that vsync can only be set to `true` if [`accelerated`](#windowaccelerated) is also `true`. ### window.setVsync(vsync) - `vsync: ` The new value of the property. Changes the window's vsync property. If you have set the `opengl` or `webgpu` options, then calls to this function will fail. ### window.opengl - `` Is `true` if the window was created in OpenGl mode. In OpenGL mode, you must use OpenGL calls to render to the window. Calls to [`render()`](#windowrenderwidth-height-stride-format-buffer-options) will fail. ### window.webgpu - `` Is `true` if the window was created in WebGPU mode. In WebGPU mode, you must use WebGPU calls to render to the window. Calls to [`render()`](#windowrenderwidth-height-stride-format-buffer-options) will fail. ### window.native - `` - `handle : ` The platform-specific handle of the window. The native type of `handle` is HWND on Windows, NSView* on macOS, and Window (unsigned long) on Linux. It should work exactly like the [`win.getNativeWindowHandle()`](https://www.electronjs.org/docs/latest/api/browser-window#wingetnativewindowhandle) electron method. The `window.native` object might also sometimes include extra fields other than the ones documented here. Please ignore and do not use these. They are used internally for passing to [@kmamal/gl](https://github.com/kmamal/headless-gl#readme) or [@kmamal/gpu](https://github.com/kmamal/gpu#readme) and can change at any time. ### window.maximized - `` Is `true` if the window is maximized. ### window.maximize() Maximizes the window. ### window.minimized - `` Is `true` if the window is minimized. ### window.minimize() Minimizes the window. ### window.restore() Restores the window so it is neither minimized nor maximized. ### window.focused - `` Is `true` if the window has keyboard input. ### window.focus() Gives the window the keyboard focus. ### window.hovered - `` Is `true` if the mouse is over the window. ### window.skipTaskbar - `` X11 only. Is `true` if the window was created with `skipTaskbar: true`. Such a window is not added to the taskbar. ### window.popupMenu - `` X11 only. Is `true` if the window was created with `popupMenu: true`. Such a window is always treated as a popup menu. ### window.tooltip - `` X11 only. Is `true` if the window was created with `tooltip: true`. Such a window is always treated as a tooltip. ### window.utility - `` X11 only. Is `true` if the window was created with `utility: true`. Such a window is always treated as a utility window. ### window.render(width, height, stride, format, buffer[, options]) - `width, height, stride, format, buffer: `[``](#image-data) The image to display on the window. - `options: ` - `scaling: ` How to scale the image to match the window size. Default: `'nearest'` - `dstRect: ` Where exactly on the window to draw the image. Default: whole window. - `x, y, width, height: ` The components of the rectangle. Displays an image in the window. By default the image is displayed over the entire surface of the window. You may pass the optional `dstRect` parameter to set where exactly on the window to display the image. The rest of the window will be filled with black. If the dimensions of the image do not match the dimensions of the area it should be displayed in, then the image will be stretched to match. The `scaling` argument controls how exactly the scaling is implemented. Possible values are: | Value | Corresponding `SDL_ScaleMode` | Description | | --- | --- | --- | | `'nearest'` | `SDL_ScaleModeNearest` | nearest pixel sampling | | `'linear'` | `SDL_ScaleModeLinear` | linear filtering | | `'best'` | `SDL_ScaleModeBest` | anisotropic filtering | If the window was created with either of the `opengl` or `webgpu` options, then you must use OpenGL/WebGPU calls to render to the window. Calls to `render()` will fail. ### window.setIcon(width, height, stride, format, buffer) - `width, height, stride, format, buffer: `[``](#image-data) The image to display as the icon of the window. Set's the window's icon, usually displayed in the title bar and the taskbar. ### window.flash([untilFocused]) - `untilFocused: ` Whether to keep flashing the window until the user focuses it. Default: `false` Flash the window briefly to get attention. If `untilFocused` is set, the window will continue flashing until the user focuses it. ### window.stopFlashing() Stop the window from flashing. ### window.destroyed - `` Is `true` if the window is destroyed. A destroyed window object must not be used any further. ### window.destroy() Destroys the window. ### window.destroyGently() Asks before destroying the window. The difference between this function and [destroy()](#windowdestroy) is that this function first makes the window emit the [`'beforeClose'`](#event-beforeclose) event, giving you a chance to prevent the window from being destroyed. ## sdl.keyboard There are three levels at which you can deal with the keyboard: physical keys ([scancodes](#enum-scancode)), virtual keys ([keys](#virtual-keys)), and text ([`'textInput'`](#event-textinput) events). On the physical level, each of the physical keys corresponds to a number: the key's scancode. For any given keyboard, the same key will always produce the same scancode. If your application cares about the layout of the keyboard (for example using the "WASD" keys as a substitute for arrow keys), then you should handle key events at this level using the `scancode` property of [`'keyDown'`](#event-keydown) and [`'keyUp'`](#event-keyup) events. For the most part it's better to treat scancode values as arbitrary/meaningless, but SDL does provide a scancode enumeration with values based on the [USB usage page standard](https://www.usb.org/sites/default/files/documents/hut1_12v2.pdf) so you should be able to derive some meaning from the scancodes if your keyboard is compatible. More commonly, you don't care about the physical key itself but about the "meaning" associated with each key: the character that it produces ("a", "b", "@", " ", .e.t.c.) or the function that it corresponds to ("Esc", "F4", "Ctrl", e.t.c.). Your operating system provides a "keyboard mapping" that associates physical keys with their corresponding meaning. Changing the keyboard mapping (for example by changing the language from English to German) will also change the corresponding meaning for each key (in the English-German example: the "y" and "z" keys will be switched). These meanings are represented as [virtual key strings](#virtual-keys). If your application cares about the meaning associated with individual keys then you should handle key events at this level using the `key` property of [`'keyDown'`](#event-keydown) and [`'keyUp'`](#event-keyup) events. Note that not all physical keys correspond to a well-defined meaning and thus don't have a virtual key value associated with them. The key events for these keys will have a `null` value for the `key` property. But sometimes the application doesn't care about individual keys at all, but about the resulting text that the user is entering. Consider for example what happens when a user on a Greek keyboard layout enters an accent mark "ยด" followed by the letter "ฮฑ" to produce the character "ฮฌ": Two keys were pressed, but only a single character was produced. Trying to handle text input by manually translating key presses to text is not a very viable solution. It's better to let the OS handle all the text logic, and get the final text by handling the rasulting ([`'textInput'`](#event-textinput)) events. ### Virtual keys String values used to represent virtual keys in the context of the current keyboard mapping. Note that some keys do not correspond to any virtual key. A Key can be either one of the values below __or__ any unicode character. Keys that produce characters are represented by that character. All others are represented by one of these values: `'&&'`, `'+/-'`, `'||'`, `'00'`, `'000'`, `'again'`, `'alt'`, `'altErase'`, `'app1'`, `'app2'`, `'application'`, `'audioFastForward'`, `'audioMute'`, `'audioNext'`, `'audioPlay'`, `'audioPrev'`, `'audioRewind'`, `'audioStop'`, `'back'`, `'backspace'`, `'binary'`, `'bookmarks'`, `'brightnessDown'`, `'brightnessUp'`, `'calculator'`, `'cancel'`, `'capsLock'`, `'clear'`, `'clearEntry'`, `'computer'`, `'copy'`, `'crSel'`, `'ctrl'`, `'currencySubUnit'`, `'currencyUnit'`, `'cut'`, `'decimal'`, `'decimalSeparator'`, `'delete'`, `'displaySwitch'`, `'down'`, `'eject'`, `'end'`, `'enter'`, `'escape'`, `'execute'`, `'exSel'`, `'f1'`, `'f2'`, `'f3'`, `'f4'`, `'f5'`, `'f6'`, `'f7'`, `'f8'`, `'f9'`, `'f10'`, `'f11'`, `'f12'`, `'f13'`, `'f14'`, `'f15'`, `'f16'`, `'f17'`, `'f18'`, `'f19'`, `'f20'`, `'f21'`, `'f22'`, `'f23'`, `'f24'`, `'find'`, `'forward'`, `'gui'`, `'help'`, `'hexadecimal'`, `'home'`, `'illumDown'`, `'illumToggle'`, `'illumUp'`, `'insert'`, `'left'`, `'mail'`, `'mediaSelect'`, `'memAdd'`, `'memClear'`, `'memDivide'`, `'memMultiply'`, `'memRecall'`, `'memStore'`, `'memSubtract'`, `'menu'`, `'modeSwitch'`, `'mute'`, `'numlock'`, `'octal'`, `'oper'`, `'out'`, `'pageDown'`, `'pageUp'`, `'paste'`, `'pause'`, `'power'`, `'printScreen'`, `'prior'`, `'refresh'`, `'return'`, `'right'`, `'scrollLock'`, `'search'`, `'select'`, `'separator'`, `'shift'`, `'sleep'`, `'space'`, `'stop'`, `'sysReq'`, `'tab'`, `'thousandsSeparator'`, `'undo'`, `'up'`, `'volumeDown'`, `'volumeUp'`, `'www'`, `'xor'`. ### Enum: SCANCODE Used to represent physical keys on the keyboard. The same key will always produce the same scancode. Values are based on the [USB usage page standard](https://www.usb.org/sites/default/files/documents/hut1_12v2.pdf).
Click to expand table | Value | Corresponding `SDL_Scancode` | Comment | | --- | --- | --- | | `sdl.keyboard.SCANCODE.A` | `SDL_SCANCODE_A` | | | `sdl.keyboard.SCANCODE.B` | `SDL_SCANCODE_B` | | | `sdl.keyboard.SCANCODE.C` | `SDL_SCANCODE_C` | | | `sdl.keyboard.SCANCODE.D` | `SDL_SCANCODE_D` | | | `sdl.keyboard.SCANCODE.E` | `SDL_SCANCODE_E` | | | `sdl.keyboard.SCANCODE.F` | `SDL_SCANCODE_F` | | | `sdl.keyboard.SCANCODE.G` | `SDL_SCANCODE_G` | | | `sdl.keyboard.SCANCODE.H` | `SDL_SCANCODE_H` | | | `sdl.keyboard.SCANCODE.I` | `SDL_SCANCODE_I` | | | `sdl.keyboard.SCANCODE.J` | `SDL_SCANCODE_J` | | | `sdl.keyboard.SCANCODE.K` | `SDL_SCANCODE_K` | | | `sdl.keyboard.SCANCODE.L` | `SDL_SCANCODE_L` | | | `sdl.keyboard.SCANCODE.M` | `SDL_SCANCODE_M` | | | `sdl.keyboard.SCANCODE.N` | `SDL_SCANCODE_N` | | | `sdl.keyboard.SCANCODE.O` | `SDL_SCANCODE_O` | | | `sdl.keyboard.SCANCODE.P` | `SDL_SCANCODE_P` | | | `sdl.keyboard.SCANCODE.Q` | `SDL_SCANCODE_Q` | | | `sdl.keyboard.SCANCODE.R` | `SDL_SCANCODE_R` | | | `sdl.keyboard.SCANCODE.S` | `SDL_SCANCODE_S` | | | `sdl.keyboard.SCANCODE.T` | `SDL_SCANCODE_T` | | | `sdl.keyboard.SCANCODE.U` | `SDL_SCANCODE_U` | | | `sdl.keyboard.SCANCODE.V` | `SDL_SCANCODE_V` | | | `sdl.keyboard.SCANCODE.W` | `SDL_SCANCODE_W` | | | `sdl.keyboard.SCANCODE.X` | `SDL_SCANCODE_X` | | | `sdl.keyboard.SCANCODE.Y` | `SDL_SCANCODE_Y` | | | `sdl.keyboard.SCANCODE.Z` | `SDL_SCANCODE_Z` | | | `sdl.keyboard.SCANCODE.1` | `SDL_SCANCODE_1` | | | `sdl.keyboard.SCANCODE.2` | `SDL_SCANCODE_2` | | | `sdl.keyboard.SCANCODE.3` | `SDL_SCANCODE_3` | | | `sdl.keyboard.SCANCODE.4` | `SDL_SCANCODE_4` | | | `sdl.keyboard.SCANCODE.5` | `SDL_SCANCODE_5` | | | `sdl.keyboard.SCANCODE.6` | `SDL_SCANCODE_6` | | | `sdl.keyboard.SCANCODE.7` | `SDL_SCANCODE_7` | | | `sdl.keyboard.SCANCODE.8` | `SDL_SCANCODE_8` | | | `sdl.keyboard.SCANCODE.9` | `SDL_SCANCODE_9` | | | `sdl.keyboard.SCANCODE.0` | `SDL_SCANCODE_0` | | | `sdl.keyboard.SCANCODE.RETURN` | `SDL_SCANCODE_RETURN` | | | `sdl.keyboard.SCANCODE.ESCAPE` | `SDL_SCANCODE_ESCAPE` | | | `sdl.keyboard.SCANCODE.BACKSPACE` | `SDL_SCANCODE_BACKSPACE` | | | `sdl.keyboard.SCANCODE.TAB` | `SDL_SCANCODE_TAB` | | | `sdl.keyboard.SCANCODE.SPACE` | `SDL_SCANCODE_SPACE` | | | `sdl.keyboard.SCANCODE.MINUS` | `SDL_SCANCODE_MINUS` | | | `sdl.keyboard.SCANCODE.EQUALS` | `SDL_SCANCODE_EQUALS` | | | `sdl.keyboard.SCANCODE.LEFTBRACKET` | `SDL_SCANCODE_LEFTBRACKET` | | | `sdl.keyboard.SCANCODE.RIGHTBRACKET` | `SDL_SCANCODE_RIGHTBRACKET` | | | `sdl.keyboard.SCANCODE.BACKSLASH` | `SDL_SCANCODE_BACKSLASH` | Located at the lower left of the return key on ISO keyboards and at the right end of the QWERTY row on ANSI keyboards. Produces REVERSE SOLIDUS (backslash) and VERTICAL LINE in a US layout, REVERSE SOLIDUS and VERTICAL LINE in a UK Mac layout, NUMBER SIGN and TILDE in a UK Windows layout, DOLLAR SIGN and POUND SIGN in a Swiss German layout, NUMBER SIGN and APOSTROPHE in a German layout, GRAVE ACCENT and POUND SIGN in a French Mac layout, and ASTERISK and MICRO SIGN in a French Windows layout. | | `sdl.keyboard.SCANCODE.NONUSHASH` | `SDL_SCANCODE_NONUSHASH` | ISO USB keyboards actually use this code instead of 49 for the same key, but all OSes I've seen treat the two codes identically. So, as an implementor, unless your keyboard generates both of those codes and your OS treats them differently, you should generate SDL_SCANCODE_BACKSLASH instead of this code. As a user, you should not rely on this code because SDL will never generate it with most (all?) keyboards. | | `sdl.keyboard.SCANCODE.SEMICOLON` | `SDL_SCANCODE_SEMICOLON` | | | `sdl.keyboard.SCANCODE.APOSTROPHE` | `SDL_SCANCODE_APOSTROPHE` | | | `sdl.keyboard.SCANCODE.GRAVE` | `SDL_SCANCODE_GRAVE` | Located in the top left corner (on both ANSI and ISO keyboards). Produces GRAVE ACCENT and TILDE in a US Windows layout and in US and UK Mac layouts on ANSI keyboards, GRAVE ACCENT and NOT SIGN in a UK Windows layout, SECTION SIGN and PLUS-MINUS SIGN in US and UK Mac layouts on ISO keyboards, SECTION SIGN and DEGREE SIGN in a Swiss German layout (Mac: only on ISO keyboards), CIRCUMFLEX ACCENT and DEGREE SIGN in a German layout (Mac: only on ISO keyboards), SUPERSCRIPT TWO and TILDE in a French Windows layout, COMMERCIAL AT and NUMBER SIGN in a French Mac layout on ISO keyboards, and LESS-THAN SIGN and GREATER-THAN SIGN in a Swiss German, German, or French Mac layout on ANSI keyboards. | | `sdl.keyboard.SCANCODE.COMMA` | `SDL_SCANCODE_COMMA` | | | `sdl.keyboard.SCANCODE.PERIOD` | `SDL_SCANCODE_PERIOD` | | | `sdl.keyboard.SCANCODE.SLASH` | `SDL_SCANCODE_SLASH` | | | `sdl.keyboard.SCANCODE.CAPSLOCK` | `SDL_SCANCODE_CAPSLOCK` | | | `sdl.keyboard.SCANCODE.F1` | `SDL_SCANCODE_F1` | | | `sdl.keyboard.SCANCODE.F2` | `SDL_SCANCODE_F2` | | | `sdl.keyboard.SCANCODE.F3` | `SDL_SCANCODE_F3` | | | `sdl.keyboard.SCANCODE.F4` | `SDL_SCANCODE_F4` | | | `sdl.keyboard.SCANCODE.F5` | `SDL_SCANCODE_F5` | | | `sdl.keyboard.SCANCODE.F6` | `SDL_SCANCODE_F6` | | | `sdl.keyboard.SCANCODE.F7` | `SDL_SCANCODE_F7` | | | `sdl.keyboard.SCANCODE.F8` | `SDL_SCANCODE_F8` | | | `sdl.keyboard.SCANCODE.F9` | `SDL_SCANCODE_F9` | | | `sdl.keyboard.SCANCODE.F10` | `SDL_SCANCODE_F10` | | | `sdl.keyboard.SCANCODE.F11` | `SDL_SCANCODE_F11` | | | `sdl.keyboard.SCANCODE.F12` | `SDL_SCANCODE_F12` | | | `sdl.keyboard.SCANCODE.PRINTSCREEN` | `SDL_SCANCODE_PRINTSCREEN` | | | `sdl.keyboard.SCANCODE.SCROLLLOCK` | `SDL_SCANCODE_SCROLLLOCK` | | | `sdl.keyboard.SCANCODE.PAUSE` | `SDL_SCANCODE_PAUSE` | | | `sdl.keyboard.SCANCODE.INSERT` | `SDL_SCANCODE_INSERT` | insert on PC, help on some Mac keyboards | | `sdl.keyboard.SCANCODE.HOME` | `SDL_SCANCODE_HOME` | | | `sdl.keyboard.SCANCODE.PAGEUP` | `SDL_SCANCODE_PAGEUP` | | | `sdl.keyboard.SCANCODE.DELETE` | `SDL_SCANCODE_DELETE` | | | `sdl.keyboard.SCANCODE.END` | `SDL_SCANCODE_END` | | | `sdl.keyboard.SCANCODE.PAGEDOWN` | `SDL_SCANCODE_PAGEDOWN` | | | `sdl.keyboard.SCANCODE.RIGHT` | `SDL_SCANCODE_RIGHT` | | | `sdl.keyboard.SCANCODE.LEFT` | `SDL_SCANCODE_LEFT` | | | `sdl.keyboard.SCANCODE.DOWN` | `SDL_SCANCODE_DOWN` | | | `sdl.keyboard.SCANCODE.UP` | `SDL_SCANCODE_UP` | | | `sdl.keyboard.SCANCODE.NUMLOCKCLEAR` | `SDL_SCANCODE_NUMLOCKCLEAR` | num lock on PC, clear on Mac keyboards | | `sdl.keyboard.SCANCODE.KP_DIVIDE` | `SDL_SCANCODE_KP_DIVIDE` | | | `sdl.keyboard.SCANCODE.KP_MULTIPLY` | `SDL_SCANCODE_KP_MULTIPLY` | | | `sdl.keyboard.SCANCODE.KP_MINUS` | `SDL_SCANCODE_KP_MINUS` | | | `sdl.keyboard.SCANCODE.KP_PLUS` | `SDL_SCANCODE_KP_PLUS` | | | `sdl.keyboard.SCANCODE.KP_ENTER` | `SDL_SCANCODE_KP_ENTER` | | | `sdl.keyboard.SCANCODE.KP_1` | `SDL_SCANCODE_KP_1` | | | `sdl.keyboard.SCANCODE.KP_2` | `SDL_SCANCODE_KP_2` | | | `sdl.keyboard.SCANCODE.KP_3` | `SDL_SCANCODE_KP_3` | | | `sdl.keyboard.SCANCODE.KP_4` | `SDL_SCANCODE_KP_4` | | | `sdl.keyboard.SCANCODE.KP_5` | `SDL_SCANCODE_KP_5` | | | `sdl.keyboard.SCANCODE.KP_6` | `SDL_SCANCODE_KP_6` | | | `sdl.keyboard.SCANCODE.KP_7` | `SDL_SCANCODE_KP_7` | | | `sdl.keyboard.SCANCODE.KP_8` | `SDL_SCANCODE_KP_8` | | | `sdl.keyboard.SCANCODE.KP_9` | `SDL_SCANCODE_KP_9` | | | `sdl.keyboard.SCANCODE.KP_0` | `SDL_SCANCODE_KP_0` | | | `sdl.keyboard.SCANCODE.KP_PERIOD` | `SDL_SCANCODE_KP_PERIOD` | | | `sdl.keyboard.SCANCODE.NONUSBACKSLASH` | `SDL_SCANCODE_NONUSBACKSLASH` | This is the additional key that ISO keyboards have over ANSI ones, located between left shift and Y. Produces GRAVE ACCENT and TILDE in a US or UK Mac layout, REVERSE SOLIDUS (backslash) and VERTICAL LINE in a US or UK Windows layout, and LESS-THAN SIGN and GREATER-THAN SIGN in a Swiss German, German, or French layout. | | `sdl.keyboard.SCANCODE.APPLICATION` | `SDL_SCANCODE_APPLICATION` | windows contextual menu, compose | | `sdl.keyboard.SCANCODE.POWER` | `SDL_SCANCODE_POWER` | The USB document says this is a status flag, not a physical key - but some Mac keyboards do have a power key. | | `sdl.keyboard.SCANCODE.KP_EQUALS` | `SDL_SCANCODE_KP_EQUALS` | | | `sdl.keyboard.SCANCODE.F13` | `SDL_SCANCODE_F13` | | | `sdl.keyboard.SCANCODE.F14` | `SDL_SCANCODE_F14` | | | `sdl.keyboard.SCANCODE.F15` | `SDL_SCANCODE_F15` | | | `sdl.keyboard.SCANCODE.F16` | `SDL_SCANCODE_F16` | | | `sdl.keyboard.SCANCODE.F17` | `SDL_SCANCODE_F17` | | | `sdl.keyboard.SCANCODE.F18` | `SDL_SCANCODE_F18` | | | `sdl.keyboard.SCANCODE.F19` | `SDL_SCANCODE_F19` | | | `sdl.keyboard.SCANCODE.F20` | `SDL_SCANCODE_F20` | | | `sdl.keyboard.SCANCODE.F21` | `SDL_SCANCODE_F21` | | | `sdl.keyboard.SCANCODE.F22` | `SDL_SCANCODE_F22` | | | `sdl.keyboard.SCANCODE.F23` | `SDL_SCANCODE_F23` | | | `sdl.keyboard.SCANCODE.F24` | `SDL_SCANCODE_F24` | | | `sdl.keyboard.SCANCODE.EXECUTE` | `SDL_SCANCODE_EXECUTE` | | | `sdl.keyboard.SCANCODE.HELP` | `SDL_SCANCODE_HELP` | | | `sdl.keyboard.SCANCODE.MENU` | `SDL_SCANCODE_MENU` | | | `sdl.keyboard.SCANCODE.SELECT` | `SDL_SCANCODE_SELECT` | | | `sdl.keyboard.SCANCODE.STOP` | `SDL_SCANCODE_STOP` | | | `sdl.keyboard.SCANCODE.AGAIN` | `SDL_SCANCODE_AGAIN` | redo | | `sdl.keyboard.SCANCODE.UNDO` | `SDL_SCANCODE_UNDO` | | | `sdl.keyboard.SCANCODE.CUT` | `SDL_SCANCODE_CUT` | | | `sdl.keyboard.SCANCODE.COPY` | `SDL_SCANCODE_COPY` | | | `sdl.keyboard.SCANCODE.PASTE` | `SDL_SCANCODE_PASTE` | | | `sdl.keyboard.SCANCODE.FIND` | `SDL_SCANCODE_FIND` | | | `sdl.keyboard.SCANCODE.MUTE` | `SDL_SCANCODE_MUTE` | | | `sdl.keyboard.SCANCODE.VOLUMEUP` | `SDL_SCANCODE_VOLUMEUP` | | | `sdl.keyboard.SCANCODE.VOLUMEDOWN` | `SDL_SCANCODE_VOLUMEDOWN` | | | `sdl.keyboard.SCANCODE.KP_COMMA` | `SDL_SCANCODE_KP_COMMA` | | | `sdl.keyboard.SCANCODE.KP_EQUALSAS400` | `SDL_SCANCODE_KP_EQUALSAS400` | | | `sdl.keyboard.SCANCODE.INTERNATIONAL1` | `SDL_SCANCODE_INTERNATIONAL1` | used on Asian keyboards, see footnotes in USB doc | | `sdl.keyboard.SCANCODE.INTERNATIONAL2` | `SDL_SCANCODE_INTERNATIONAL2` | | | `sdl.keyboard.SCANCODE.INTERNATIONAL3` | `SDL_SCANCODE_INTERNATIONAL3` | Yen | | `sdl.keyboard.SCANCODE.INTERNATIONAL4` | `SDL_SCANCODE_INTERNATIONAL4` | | | `sdl.keyboard.SCANCODE.INTERNATIONAL5` | `SDL_SCANCODE_INTERNATIONAL5` | | | `sdl.keyboard.SCANCODE.INTERNATIONAL6` | `SDL_SCANCODE_INTERNATIONAL6` | | | `sdl.keyboard.SCANCODE.INTERNATIONAL7` | `SDL_SCANCODE_INTERNATIONAL7` | | | `sdl.keyboard.SCANCODE.INTERNATIONAL8` | `SDL_SCANCODE_INTERNATIONAL8` | | | `sdl.keyboard.SCANCODE.INTERNATIONAL9` | `SDL_SCANCODE_INTERNATIONAL9` | | | `sdl.keyboard.SCANCODE.LANG1` | `SDL_SCANCODE_LANG1` | Hangul/English toggle | | `sdl.keyboard.SCANCODE.LANG2` | `SDL_SCANCODE_LANG2` | Hanja conversion | | `sdl.keyboard.SCANCODE.LANG3` | `SDL_SCANCODE_LANG3` | Katakana | | `sdl.keyboard.SCANCODE.LANG4` | `SDL_SCANCODE_LANG4` | Hiragana | | `sdl.keyboard.SCANCODE.LANG5` | `SDL_SCANCODE_LANG5` | Zenkaku/Hankaku | | `sdl.keyboard.SCANCODE.LANG6` | `SDL_SCANCODE_LANG6` | | | `sdl.keyboard.SCANCODE.LANG7` | `SDL_SCANCODE_LANG7` | | | `sdl.keyboard.SCANCODE.LANG8` | `SDL_SCANCODE_LANG8` | | | `sdl.keyboard.SCANCODE.LANG9` | `SDL_SCANCODE_LANG9` | | | `sdl.keyboard.SCANCODE.ALTERASE` | `SDL_SCANCODE_ALTERASE` | Erase-Eaze | | `sdl.keyboard.SCANCODE.SYSREQ` | `SDL_SCANCODE_SYSREQ` | | | `sdl.keyboard.SCANCODE.CANCEL` | `SDL_SCANCODE_CANCEL` | | | `sdl.keyboard.SCANCODE.CLEAR` | `SDL_SCANCODE_CLEAR` | | | `sdl.keyboard.SCANCODE.PRIOR` | `SDL_SCANCODE_PRIOR` | | | `sdl.keyboard.SCANCODE.RETURN2` | `SDL_SCANCODE_RETURN2` | | | `sdl.keyboard.SCANCODE.SEPARATOR` | `SDL_SCANCODE_SEPARATOR` | | | `sdl.keyboard.SCANCODE.OUT` | `SDL_SCANCODE_OUT` | | | `sdl.keyboard.SCANCODE.OPER` | `SDL_SCANCODE_OPER` | | | `sdl.keyboard.SCANCODE.CLEARAGAIN` | `SDL_SCANCODE_CLEARAGAIN` | | | `sdl.keyboard.SCANCODE.CRSEL` | `SDL_SCANCODE_CRSEL` | | | `sdl.keyboard.SCANCODE.EXSEL` | `SDL_SCANCODE_EXSEL` | | | `sdl.keyboard.SCANCODE.KP_00` | `SDL_SCANCODE_KP_00` | | | `sdl.keyboard.SCANCODE.KP_000` | `SDL_SCANCODE_KP_000` | | | `sdl.keyboard.SCANCODE.THOUSANDSSEPARATOR` | `SDL_SCANCODE_THOUSANDSSEPARATOR` | | | `sdl.keyboard.SCANCODE.DECIMALSEPARATOR` | `SDL_SCANCODE_DECIMALSEPARATOR` | | | `sdl.keyboard.SCANCODE.CURRENCYUNIT` | `SDL_SCANCODE_CURRENCYUNIT` | | | `sdl.keyboard.SCANCODE.CURRENCYSUBUNIT` | `SDL_SCANCODE_CURRENCYSUBUNIT` | | | `sdl.keyboard.SCANCODE.KP_LEFTPAREN` | `SDL_SCANCODE_KP_LEFTPAREN` | | | `sdl.keyboard.SCANCODE.KP_RIGHTPAREN` | `SDL_SCANCODE_KP_RIGHTPAREN` | | | `sdl.keyboard.SCANCODE.KP_LEFTBRACE` | `SDL_SCANCODE_KP_LEFTBRACE` | | | `sdl.keyboard.SCANCODE.KP_RIGHTBRACE` | `SDL_SCANCODE_KP_RIGHTBRACE` | | | `sdl.keyboard.SCANCODE.KP_TAB` | `SDL_SCANCODE_KP_TAB` | | | `sdl.keyboard.SCANCODE.KP_BACKSPACE` | `SDL_SCANCODE_KP_BACKSPACE` | | | `sdl.keyboard.SCANCODE.KP_A` | `SDL_SCANCODE_KP_A` | | | `sdl.keyboard.SCANCODE.KP_B` | `SDL_SCANCODE_KP_B` | | | `sdl.keyboard.SCANCODE.KP_C` | `SDL_SCANCODE_KP_C` | | | `sdl.keyboard.SCANCODE.KP_D` | `SDL_SCANCODE_KP_D` | | | `sdl.keyboard.SCANCODE.KP_E` | `SDL_SCANCODE_KP_E` | | | `sdl.keyboard.SCANCODE.KP_F` | `SDL_SCANCODE_KP_F` | | | `sdl.keyboard.SCANCODE.KP_XOR` | `SDL_SCANCODE_KP_XOR` | | | `sdl.keyboard.SCANCODE.KP_POWER` | `SDL_SCANCODE_KP_POWER` | | | `sdl.keyboard.SCANCODE.KP_PERCENT` | `SDL_SCANCODE_KP_PERCENT` | | | `sdl.keyboard.SCANCODE.KP_LESS` | `SDL_SCANCODE_KP_LESS` | | | `sdl.keyboard.SCANCODE.KP_GREATER` | `SDL_SCANCODE_KP_GREATER` | | | `sdl.keyboard.SCANCODE.KP_AMPERSAND` | `SDL_SCANCODE_KP_AMPERSAND` | | | `sdl.keyboard.SCANCODE.KP_DBLAMPERSAND` | `SDL_SCANCODE_KP_DBLAMPERSAND` | | | `sdl.keyboard.SCANCODE.KP_VERTICALBAR` | `SDL_SCANCODE_KP_VERTICALBAR` | | | `sdl.keyboard.SCANCODE.KP_DBLVERTICALBAR` | `SDL_SCANCODE_KP_DBLVERTICALBAR` | | | `sdl.keyboard.SCANCODE.KP_COLON` | `SDL_SCANCODE_KP_COLON` | | | `sdl.keyboard.SCANCODE.KP_HASH` | `SDL_SCANCODE_KP_HASH` | | | `sdl.keyboard.SCANCODE.KP_SPACE` | `SDL_SCANCODE_KP_SPACE` | | | `sdl.keyboard.SCANCODE.KP_AT` | `SDL_SCANCODE_KP_AT` | | | `sdl.keyboard.SCANCODE.KP_EXCLAM` | `SDL_SCANCODE_KP_EXCLAM` | | | `sdl.keyboard.SCANCODE.KP_MEMSTORE` | `SDL_SCANCODE_KP_MEMSTORE` | | | `sdl.keyboard.SCANCODE.KP_MEMRECALL` | `SDL_SCANCODE_KP_MEMRECALL` | | | `sdl.keyboard.SCANCODE.KP_MEMCLEAR` | `SDL_SCANCODE_KP_MEMCLEAR` | | | `sdl.keyboard.SCANCODE.KP_MEMADD` | `SDL_SCANCODE_KP_MEMADD` | | | `sdl.keyboard.SCANCODE.KP_MEMSUBTRACT` | `SDL_SCANCODE_KP_MEMSUBTRACT` | | | `sdl.keyboard.SCANCODE.KP_MEMMULTIPLY` | `SDL_SCANCODE_KP_MEMMULTIPLY` | | | `sdl.keyboard.SCANCODE.KP_MEMDIVIDE` | `SDL_SCANCODE_KP_MEMDIVIDE` | | | `sdl.keyboard.SCANCODE.KP_PLUSMINUS` | `SDL_SCANCODE_KP_PLUSMINUS` | | | `sdl.keyboard.SCANCODE.KP_CLEAR` | `SDL_SCANCODE_KP_CLEAR` | | | `sdl.keyboard.SCANCODE.KP_CLEARENTRY` | `SDL_SCANCODE_KP_CLEARENTRY` | | | `sdl.keyboard.SCANCODE.KP_BINARY` | `SDL_SCANCODE_KP_BINARY` | | | `sdl.keyboard.SCANCODE.KP_OCTAL` | `SDL_SCANCODE_KP_OCTAL` | | | `sdl.keyboard.SCANCODE.KP_DECIMAL` | `SDL_SCANCODE_KP_DECIMAL` | | | `sdl.keyboard.SCANCODE.KP_HEXADECIMAL` | `SDL_SCANCODE_KP_HEXADECIMAL` | | | `sdl.keyboard.SCANCODE.LCTRL` | `SDL_SCANCODE_LCTRL` | | | `sdl.keyboard.SCANCODE.LSHIFT` | `SDL_SCANCODE_LSHIFT` | | | `sdl.keyboard.SCANCODE.LALT` | `SDL_SCANCODE_LALT` | alt, option | | `sdl.keyboard.SCANCODE.LGUI` | `SDL_SCANCODE_LGUI` | windows, command (apple), meta | | `sdl.keyboard.SCANCODE.RCTRL` | `SDL_SCANCODE_RCTRL` | | | `sdl.keyboard.SCANCODE.RSHIFT` | `SDL_SCANCODE_RSHIFT` | | | `sdl.keyboard.SCANCODE.RALT` | `SDL_SCANCODE_RALT` | alt gr, option | | `sdl.keyboard.SCANCODE.RGUI` | `SDL_SCANCODE_RGUI` | windows, command (apple), meta | | `sdl.keyboard.SCANCODE.MODE` | `SDL_SCANCODE_MODE` | | | `sdl.keyboard.SCANCODE.AUDIONEXT` | `SDL_SCANCODE_AUDIONEXT` | | | `sdl.keyboard.SCANCODE.AUDIOPREV` | `SDL_SCANCODE_AUDIOPREV` | | | `sdl.keyboard.SCANCODE.AUDIOSTOP` | `SDL_SCANCODE_AUDIOSTOP` | | | `sdl.keyboard.SCANCODE.AUDIOPLAY` | `SDL_SCANCODE_AUDIOPLAY` | | | `sdl.keyboard.SCANCODE.AUDIOMUTE` | `SDL_SCANCODE_AUDIOMUTE` | | | `sdl.keyboard.SCANCODE.MEDIASELECT` | `SDL_SCANCODE_MEDIASELECT` | | | `sdl.keyboard.SCANCODE.WWW` | `SDL_SCANCODE_WWW` | | | `sdl.keyboard.SCANCODE.MAIL` | `SDL_SCANCODE_MAIL` | | | `sdl.keyboard.SCANCODE.CALCULATOR` | `SDL_SCANCODE_CALCULATOR` | | | `sdl.keyboard.SCANCODE.COMPUTER` | `SDL_SCANCODE_COMPUTER` | | | `sdl.keyboard.SCANCODE.AC_SEARCH` | `SDL_SCANCODE_AC_SEARCH` | | | `sdl.keyboard.SCANCODE.AC_HOME` | `SDL_SCANCODE_AC_HOME` | | | `sdl.keyboard.SCANCODE.AC_BACK` | `SDL_SCANCODE_AC_BACK` | | | `sdl.keyboard.SCANCODE.AC_FORWARD` | `SDL_SCANCODE_AC_FORWARD` | | | `sdl.keyboard.SCANCODE.AC_STOP` | `SDL_SCANCODE_AC_STOP` | | | `sdl.keyboard.SCANCODE.AC_REFRESH` | `SDL_SCANCODE_AC_REFRESH` | | | `sdl.keyboard.SCANCODE.AC_BOOKMARKS` | `SDL_SCANCODE_AC_BOOKMARKS` | | | `sdl.keyboard.SCANCODE.BRIGHTNESSDOWN` | `SDL_SCANCODE_BRIGHTNESSDOWN` | | | `sdl.keyboard.SCANCODE.BRIGHTNESSUP` | `SDL_SCANCODE_BRIGHTNESSUP` | | | `sdl.keyboard.SCANCODE.DISPLAYSWITCH` | `SDL_SCANCODE_DISPLAYSWITCH` | display mirroring/dual display switch, video mode switch | | `sdl.keyboard.SCANCODE.KBDILLUMTOGGLE` | `SDL_SCANCODE_KBDILLUMTOGGLE` | | | `sdl.keyboard.SCANCODE.KBDILLUMDOWN` | `SDL_SCANCODE_KBDILLUMDOWN` | | | `sdl.keyboard.SCANCODE.KBDILLUMUP` | `SDL_SCANCODE_KBDILLUMUP` | | | `sdl.keyboard.SCANCODE.EJECT` | `SDL_SCANCODE_EJECT` | | | `sdl.keyboard.SCANCODE.SLEEP` | `SDL_SCANCODE_SLEEP` | | | `sdl.keyboard.SCANCODE.APP1` | `SDL_SCANCODE_APP1` | | | `sdl.keyboard.SCANCODE.APP2` | `SDL_SCANCODE_APP2` | | | `sdl.keyboard.SCANCODE.AUDIOREWIND` | `SDL_SCANCODE_AUDIOREWIND` | | | `sdl.keyboard.SCANCODE.AUDIOFASTFORWARD` | `SDL_SCANCODE_AUDIOFASTFORWARD` | |
### Event: 'keymapChange' Fired when the keymap changes due to a system event such as an input language or keyboard layout change. After this event, the correspondance between physical and logical keys might have changed. You should assume that any previous result you have gotten from [`getKey()`](#sdlkeyboardgetkeyscancode) or [`getScancode()`](#sdlkeyboardgetscancodekey) are not invalid. ### sdl.keyboard.getKey(scancode) - `scancode: `[``](#enum-scancode) - Returns: [``](#virtual-keys)`|` Maps a scancode to the corresponding key based on the current keyboard mapping. Retuns `null` if the scancode does not currespond to a key in the current mapping. ### sdl.keyboard.getScancode(key) - `key: `[``](#virtual-keys) - Returns: [``](#enum-scancode)`|` Maps a key to the corresponding scancode based on the current keyboard mapping. Retuns `null` if the key does not currespond to a scancode in the current mapping. If multiple physical keys produce the same virtual key, then only the first one is returned. ### sdl.keyboard.getState() - Returns: `` an array representing the state of each key. The returned array can be indexed with [`Scancode`](#enum-scancode) values. Each value in the array is either `true` if the corresponding key is pressed, or `false` otherwise. ## sdl.mouse ### Enum: BUTTON Used to represent the buttons on a mouse. A mouse can have many buttons, but the values for the three most common ones are represented in this enum. | Value | Corresponding `SDL_BUTTON_*` | | --- | --- | | `sdl.mouse.BUTTON.LEFT` | `SDL_BUTTON_LEFT` | | `sdl.mouse.BUTTON.MIDDLE` | `SDL_BUTTON_MIDDLE` | | `sdl.mouse.BUTTON.RIGHT` | `SDL_BUTTON_RIGHT` | ### sdl.mouse.getButton(button) - `button: ` The index of the button. - Returns: `` Is `true` if the button is pressed. Queries the state of a single mouse button. ### sdl.mouse.position - `` - `x: ` The x position of the mouse, relative to the screen. - `y: ` The y position of the mouse, relative to the screen. The position of the mouse on the screen. ### sdl.mouse.setPosition(x, y) - `x: ` The new x position of the mouse, relative to the screen. - `y: ` The new y position of the mouse, relative to the screen. Moves the mouse to the specified position. ### sdl.mouse.setCursor(cursor) - `cursor: ` The icon to use for the cursor. Changes the icon that is displayed for the mouse cursor. Possible values for `cursor` are: | Value | Corresponding `SDL_SystemCursor` | Description | | --- | --- | --- | | `'arrow'` | `SDL_SYSTEM_CURSOR_ARROW` | arrow | | `'ibeam'` | `SDL_SYSTEM_CURSOR_IBEAM` | i-beam | | `'wait'` | `SDL_SYSTEM_CURSOR_WAIT` | wait | | `'crosshair'` | `SDL_SYSTEM_CURSOR_CROSSHAIR` | crosshair | | `'waitarrow'` | `SDL_SYSTEM_CURSOR_WAITARROW` | small wait cursor (or wait if not available) | | `'sizenwse'` | `SDL_SYSTEM_CURSOR_SIZENWSE` | double arrow pointing northwest and southeast | | `'sizenesw'` | `SDL_SYSTEM_CURSOR_SIZENESW` | double arrow pointing northeast and southwest | | `'sizewe'` | `SDL_SYSTEM_CURSOR_SIZEWE` | double arrow pointing west and east | | `'sizens'` | `SDL_SYSTEM_CURSOR_SIZENS` | double arrow pointing north and south | | `'sizeall'` | `SDL_SYSTEM_CURSOR_SIZEALL` | four pointed arrow pointing north, south, east, and west | | `'no'` | `SDL_SYSTEM_CURSOR_NO` | slashed circle or crossbones | | `'hand'` | `SDL_SYSTEM_CURSOR_HAND` | hand | ### sdl.mouse.resetCursor() Switched back to the default cursor. ### sdl.mouse.setCursorImage(width, height, stride, format, buffer, x, y) - `width, height, stride, format, buffer: `[``](#image-data) The image to use as a cursor. - `x: ` The x position of the cursor image's hotspot. - `y: ` The y position of the cursor image's hotspot. Sets a image to be the mouse cursor. The hotspot represents the pixel that is considered to be under the mouse. ### sdl.mouse.showCursor([show]) - `show: ` If `true` then the mouse cursor is made visible. Default: `true` Changes the visibility of the mouse cursor. ### sdl.mouse.hideCursor() Equivalent to [`sdl.mouse.showCursor(false)`](#sdlmouseshowcursorshow). ### sdl.mouse.redrawCursor() Forces a cursor redraw. ### sdl.mouse.capture([capture]) - `capture: ` If `true` the mouse is to be captured by the current window. Default: `true` When the mouse has been captured you will continue receiving mouse events even if the mouse is not over a window. ### sdl.mouse.uncapture() Equivalent to [`sdl.mouse.capture(false)`](#sdlmousecapturecapture). ## sdl.touch ### sdl.touch.devices - `[]` - `id: ` The unique id for the device. - `name: |` The name of the device, or `null` if it can't be determined. - `type: |` The type of the device, or `null` if it can't be determined. A list of all the detected touch devices. On some platforms SDL only sees the touch device after it has actually been used. Therefore the returned list might be empty, although devices are available. After using all devices at least once the number will be correct. Possible values for `type` are `null` if it is unknown, or one of: | Value | Corresponding `SDL_TouchDeviceType` | | --- | --- | | `'direct'` | `SDL_TOUCH_DEVICE_DIRECT` | | `'indirectAbsolute'` | `SDL_TOUCH_DEVICE_INDIRECT_ABSOLUTE` | | `'indirectRelative'` | `SDL_TOUCH_DEVICE_INDIRECT_RELATIVE` | // TODO Sample output ## sdl.joystick ### Hat positions String values used to represent the positions of a joystick hat | Value | Corresponding `SDL_HAT_*` | | --- | --- | | `'centered'` | `SDL_HAT_CENTERED` | | `'up'` | `SDL_HAT_UP` | | `'right'` | `SDL_HAT_RIGHT` | | `'down'` | `SDL_HAT_DOWN` | | `'left'` | `SDL_HAT_LEFT` | | `'rightup'` | `SDL_HAT_RIGHTUP` | | `'rightdown'` | `SDL_HAT_RIGHTDOWN` | | `'leftup'` | `SDL_HAT_LEFTUP` | | `'leftdown'` | `SDL_HAT_LEFTDOWN` | ### Power levels String values used to represent the power level of a joystick or controller | Value | Corresponding `SDL_JoystickPowerLevel` | | --- | --- | | `'empty'` | `SDL_JOYSTICK_POWER_EMPTY` | | `'low'` | `SDL_JOYSTICK_POWER_LOW` | | `'medium'` | `SDL_JOYSTICK_POWER_MEDIUM` | | `'full'` | `SDL_JOYSTICK_POWER_FULL` | | `'wired'` | `SDL_JOYSTICK_POWER_WIRED` | | `'max'` | `SDL_JOYSTICK_POWER_MAX` | ### Event: 'deviceAdd' - `device: `: An object from [`sdl.joystick.devices`](#sdljoystickdevices) indicating the device that caused the event. Fired when a new joystick device becomes available. Check [`sdl.joystick.devices`](#sdljoystickdevices) to get the new list of joystick devices. ### Event: 'deviceRemove' - `device: `: An object from [`sdl.joystick.devices`](#sdljoystickdevices) indicating the device that caused the event. Fired when an existing joystick device is removed. Check [`sdl.joystick.devices`](#sdljoystickdevices) to get the new list of joystick devices. When this event is emitted, all instances that were opened from the removed device are closed automatically. ### sdl.joystick.devices - `[]` - `id: ` The unique id for the device. - `name: |` The name of the device. - `path: |` The implementation dependent path of the device, or `null` if it can't be determined. - `type: |` The type of the device, or `null` if it can't be determined. - `guid: |` The GUID of the device, or `null` if it can't be determined. - `vendor: |` The USB vendor ID of the device, or `null` if it can't be determined. - `product: |` The USB product ID of the device, or `null` if it can't be determined. - `version: |` The USB product version of the device, or `null` if it can't be determined. - `player: |` The player index for the device, or `null` if it can't be determined. A list of all the detected joystick devices. Possible values for `type` are `null` if it is unknown, or one of: | Value | Corresponding `SDL_JoystickType` | | --- | --- | | `'gamecontroller'` | `SDL_JOYSTICK_TYPE_GAMECONTROLLER` | | `'wheel'` | `SDL_JOYSTICK_TYPE_WHEEL` | | `'arcadestick'` | `SDL_JOYSTICK_TYPE_ARCADE_STICK` | | `'flightstick'` | `SDL_JOYSTICK_TYPE_FLIGHT_STICK` | | `'dancepad'` | `SDL_JOYSTICK_TYPE_DANCE_PAD` | | `'guitar'` | `SDL_JOYSTICK_TYPE_GUITAR` | | `'drumkit'` | `SDL_JOYSTICK_TYPE_DRUM_KIT` | | `'arcadepad'` | `SDL_JOYSTICK_TYPE_ARCADE_PAD` | | `'throttle'` | `SDL_JOYSTICK_TYPE_THROTTLE` | Sample output: ```js [ { id: 0, name: 'DragonRise Inc. Generic USB Joystick', path: '/dev/input/event21', guid: '03000000790000000600000010010000', type: 'gamecontroller', vendor: 121, product: 6, version: 272, player: 0, }, ] ``` ### sdl.joystick.openDevice(device) - `device: ` An object from [`sdl.joystick.devices`](#sdljoystickdevices) that is to be opened. - Returns: [``](#class-joystickinstance) an object representing the opened joystick device instance. Initializes a joystick device and returns a corresponding instance. ## class joystickInstance The `JoystickInstance` class is not directly exposed by the API so you can't (and shouldn't) use it with the `new` operator. Instead, objects returned by [`sdl.joystick.openDevice()`](#sdljoystickopendevicedevice) are of type `JoystickInstance`. ### Event: 'axisMotion' - `axis: ` The index of the axis that moved. - `value: ` The new axis position. Fired when one of the joystick's axes moves. ### Event: 'ballMotion' - `ball: ` The index of the ball that moved. - `x: ` The new x-position of the ball. - `y: ` The new y-position of the ball. Fired when one of the joystick's balls moves. ### Event: 'buttonDown' - `button: ` The index of the button that was pressed. Fired when one of the joystick's buttons is pressed. ### Event: 'buttonUp' - `button: ` The index of the button that was released. Fired when one of the joystick's buttons is released. ### Event: 'hatMotion' - `hat: ` The index of the hat that was moved. - `value: `[``](#hat-positions) The new hat position. Fired when one of the joystick's hats is moved. ### Event: 'powerUpdate' - `power: `[``](#power-levels)`|` The new power level. Fired when the joystick's [power level](#controllerinstancepower) changes. ### Event: 'close' Fired when the instance is about to close. Handle cleanup here. ### joystickInstance.device - `` The [device](#sdljoystickdevices) from which the instance was opened. ### joystickInstance.firmwareVersion - `|` The joystick's firmware version, or `null` if it is not available. ### joystickInstance.serialNumber - `|` The joystick's serial number, or `null` if it is not available. ### joystickInstance.axes - `[]` An array of values, each corresponding to the position of one of the joystick's axes. The values are normalized in the range from `-1` to `+1`. It may be necessary to impose certain tolerances on these values to account for jitter. ### joystickInstance.balls - `[]` - `x: ` The horizontal position of the joystick's ball. - `y: ` The vertical position of the joystick's ball. An array of values, each corresponding to the position of one of the joystick's balls. ### joystickInstance.buttons - `[]` An array of values, each corresponding to the state of one of the joystick's buttons. Each value in the object isarray is either `true` if the corresponding button is pressed, or `false` otherwise. ### joystickInstance.hats - [``](#hat-positions)`[]` An array of values, each corresponding to the position of one of the joystick's hats. ### joystickInstance.power - [``](#power-levels)`|` The current power level of the joystick device, or `null` if it is unknown. ### joystickInstance.setPlayer(index) - `index: ` The player index to assign to the joystick. Sets the player index of the joystick. ### joystickInstance.resetPlayer() Clears player assignment and player led. ### joystickInstance.hasLed - `` Is `true` if the joystick has a LED light whose color can be controlled. ### joystickInstance.setLed(red, green, blue) - `red: ` The red component of the led color, from `0` to `1`. - `green: ` The green component of the led color, from `0` to `1`. - `blue: ` The blue component of the led color, from `0` to `1`. Sets the color of the LED light on the joystick. ### joystickInstance.hasRumble - `` Is `true` if the joystick has rumble motors. ### joystickInstance.rumble([low[, high[, duration]]]) - `low: ` The intensity of the low frequency rumble motor, from `0` to `1`. Default: `1` - `high: ` The intensity of the high frequency rumble motor, from `0` to `1`. Default: `1` - `duration: ` The duration of the rumble, in ms. Default: `1e3` Makes the joystick rumble for a set `duration`. Calling this function again before `duration` has ran out, overrides the previous call. ### joystickInstance.stopRumble() Stops the joystick rumbling. Equivalent to [`joystickInstance.rumble(0, 0)`](#joystickinstancerumblelow-high-duration). ### joystickInstance.hasRumbleTriggers - `` Is `true` if the joystick has rumble motors on the triggers. ### joystickInstance.rumbleTriggers([left[, right[, duration]]]) - `left: ` The intensity of the left trigger rumble motor, from `0` to `1`. Default: `1` - `right: ` The intensity of the right trigger rumble motor, from `0` to `1`. Default: `1` - `duration: ` The duration of the rumble, in ms. Default: `1e3` Makes the joystick triggers rumble for a set `duration`. Calling this function again before `duration` has ran out, overrides the previous call. ### joystickInstance.stopRumbleTriggers() Stops the joystick trigger rumbling. Equivalent to [`joystickInstance.rumbleTriggers(0, 0)`](#joystickinstancerumbletriggersleft-right-duration). ### joystickInstance.closed - `` Is `true` if the instance is closed. A closed instance object must not be used any further. ### joystickInstance.close() Closes the instance. ## sdl.controller An SDL controller is an abstraction over [`joysticks`](#sdljoystick) based on the xbox360 controller: They have a dpad, two analog sticks, 4 buttons on the right (called A, B, X, Y), shoulder buttons (two of which might be axes) and 3 buttons in the middle ("Start", "Back" and usually some kind of logo-button called "Guide"). The SDL controller abstraction uses the naming-conventions of xbox360/XInput for all supported devices (for example devices that have a similar layout, like the Playstation DualShock Controller, but different button names), so you'll know that for example `controllerInstance.axes.leftStickX` is always the x-axis of the left analog stick, or `controllerInstance.buttons.b` is always the rightmost button of the 4 buttons on the right. This makes it easy to provide consistent input bindings, like "press B to jump, move around with the left analog stick". With a pure joystick instance it's impossible to know which axis or button corresponds to which physical axis/button on the device. Because controllers are an abstraction over joysticks, they operate on the same set of devices (if a joystick device and a controller device have the same id, then they refer to the same underlying physical device). For a joystick device to also be available as a controller device it needs a "mapping". A mapping is a string that consists of the device's GUID, its name, and a series of pairings between one joystick axis/button and the corresponding controller axis/button name. See the sample output [`here`](#sdlcontrollerdevices) for an example. SDL has pretty good default controller mappings, but if you need more, there's a community sourced database available on [gabomdq/SDL_GameControllerDB](https://github.com/gabomdq/SDL_GameControllerDB). Add them via: ```js const url = 'https://raw.githubusercontent.com/gabomdq/SDL_GameControllerDB/master/gamecontrollerdb.txt' const result = await fetch(url) const text = await result.text() const mappings = text.split('\n').filter((line) => line && !line.startsWith('#')) sdl.controller.addMappings(mappings) ``` ### Event: 'deviceAdd' - `device: `: An object from [`sdl.controller.devices`](#sdlcontrollerdevices) indicating the device that caused the event. Fired when a new controller device becomes available. Check [`sdl.controller.devices`](#sdlcontrollerdevices) to get the new list of controller devices. ### Event: 'deviceRemove' - `device: `: An object from [`sdl.controller.devices`](#sdlcontrollerdevices) indicating the device that caused the event. Fired when an existing controller device is removed. Check [`sdl.controller.devices`](#sdlcontrollerdevices) to get the new list of controller devices. When this event is emitted, all instances that were opened from the removed device are closed automatically. ### sdl.controller.addMappings(mappings) - `mappings: []` An array of mappings to register. Registers new mappings for controllers. This may cause already opened controller instances to be [remapped](#event-remap). ### sdl.controller.devices - `[]` - `id: ` The unique id for the device. - `name: |` The name of the device. - `path: |` The implementation dependent path of the device, or `null` if it can't be determined. - `type: |` The type of the device, or `null` if it can't be determined. - `guid: |` The GUID of the device, or `null` if it can't be determined. - `vendor: |` The USB vendor ID of the device, or `null` if it can't be determined. - `product: |` The USB product ID of the device, or `null` if it can't be determined. - `version: |` The USB product version of the device, or `null` if it can't be determined. - `player: |` The player index for the device, or `null` if it can't be determined. - `mapping: |` The axis and button mapping for the device, or `null` if it can't be determined. A list of all the detected controller devices. Possible values for `type` are `null` if it is unknown, or one of: | Value | Corresponding `SDL_GameControllerType` | | --- | --- | | `'xbox360'` | SDL_CONTROLLER_TYPE_XBOX360 | | `'xboxOne'` | SDL_CONTROLLER_TYPE_XBOXONE | | `'ps3'` | SDL_CONTROLLER_TYPE_PS3 | | `'ps4'` | SDL_CONTROLLER_TYPE_PS4 | | `'nintendoSwitchPro'` | SDL_CONTROLLER_TYPE_NINTENDO_SWITCH_PRO | | `'virtual'` | SDL_CONTROLLER_TYPE_VIRTUAL | | `'ps5'` | SDL_CONTROLLER_TYPE_PS5 | | `'amazonLuna'` | SDL_CONTROLLER_TYPE_AMAZON_LUNA | | `'googleStadia'` | SDL_CONTROLLER_TYPE_GOOGLE_STADIA | | `'nvidiaShield'` | SDL_CONTROLLER_TYPE_NVIDIA_SHIELD | | `'nintendoSwitchJoyconLeft'` | SDL_CONTROLLER_TYPE_NINTENDO_SWITCH_JOYCON_LEFT | | `'nintendoSwitchJoyconRight'` | SDL_CONTROLLER_TYPE_NINTENDO_SWITCH_JOYCON_RIGHT | | `'nintendoSwitchJoyconPair'` | SDL_CONTROLLER_TYPE_NINTENDO_SWITCH_JOYCON_PAIR | Sample output: ```js [ { id: 0, name: 'DragonRise Inc. Generic USB Joystick', path: '/dev/input/event21', guid: '03000000790000000600000010010000', type: null, vendor: 121, product: 6, version: 272, player: 0, mapping: '03000000790000000600000010010000,DragonRise Inc. Generic USB Joystick,a:b2,b:b1,back:b8,dpdown:h0.4,dpleft:h0.8,dpright:h0.2,dpup:h0.1,leftshoulder:b4,leftstick:b10,lefttrigger:b6,leftx:a0,lefty:a1,rightshoulder:b5,rightstick:b11,righttrigger:b7,rightx:a3,righty:a4,start:b9,x:b3,y:b0,', }, ] ``` ### sdl.controller.openDevice(device) - `device: ` An object from [`sdl.controller.devices`](#sdlcontrollerdevices) that is to be opened. - Returns: [``](#class-controllerinstance) an object representing the opened controller device instance. Initializes an controller device and returns a corresponding instance. ## class ControllerInstance The `ControllerInstance` class is not directly exposed by the API so you can't (and shouldn't) use it with the `new` operator. Instead, objects returned by [`sdl.controller.openDevice()`](#sdlcontrolleropendevicedevice) are of type `ControllerInstance`. ### Event: 'axisMotion' - `axis:`[``](#controllerinstanceaxes) The axis that moved. - `value: ` The new axis position. Fired when one of the controller's axes moves. ### Event: 'buttonDown' - `button:`[`