WebVR API

WebVR -rajapinta tarjoaa tuen VR-laitteiden — kuten Oculus Rift tai HTC Vive -silmikoiden — käyttämiseen webbisovelluksille, jolloin kehittäjät voivat muuttaa silmikolta saadun sijainti- ja liiketiedon 3D-skenessä liikkumistiedoksi. Tämä mahdollistaa useita kiinnostavia sovellusmahdollisuuksia aina virtuaalisista tuote-esittelyistä ja interaktiivisista treenisovelluksista immersiivisiin FPS-räiskintäpeleihin.

Metodi Navigator.getVRDisplays() (en-US) hakee kaikki tietokoneeseen liitetyt VR-laitteet; jokaista näistä vastaa VRDisplay (en-US) -tyyppinen objekti.

VRDisplay (en-US) on perusrajapinta WebVR API:in — sen ominaisuuksien ja metodien avulla voit esimerkiksi:

• Hakea tiedot näyttölaitteen tunnistamiseen, sen ominaisuudet ja siihen liitetyt ohjaimet.
• Hakea kunkin näytettäväksi tarkoitetun sisältöruudun frame data (en-US) ja toimittaa ruudut näytölle oikealla taajuudella.
• Käynnistää ja pysäyttää näyttämisen.

Tyypillinen (yksinkertainen) WebVR-sovellus toimisi esimerkiksi näin:

1. Navigator.getVRDisplays() (en-US) -metodilla haetaan viittaus VR-näyttöön.
2. VRDisplay.requestPresent() (en-US) -metodilla käynnistetään näyttäminen.
3. WebVR:n omalla versiolla VRDisplay.requestAnimationFrame() (en-US) -methodista suoritetaan sovelluksen renderöintisilmukkaa näytölle sopivalla virkistystaajuudella.
4. Renderöintisilmukassa haetaan ruudun näyttämiseen tarvittavat tiedot (VRDisplay.getFrameData() (en-US)) -metodilla, piirretään näytettävä skene kaksi kertaa — siis kerran molemmille silmille, ja sen jälkeen toimitetaan renderöity näkymä näytölle käyttäjälle näytettäväksi metodilla (VRDisplay.submitFrame() (en-US)).

Tämän lisäksi WebVR 1.1 lisää useita tapahtumia (event) Window -objektiin, jolloin JavaScriptillä voidaan reagoida näytön tilan muutoksiin.

Huom: APIn toiminnasta löytyy paljon lisätietoa artikkeleista Using the WebVR API ja WebVR Concepts.

Useissa WebVR-laitekokoonpanoissa silmikon mukana on käytettävissä erillinen ohjain. Ohjaimia voidaan käyttää WebVR-sovelluksissa Gamepad API:n kautta, ja erityisesti Gamepad Extensions API:n, joka lisää mukaan ohjaimen asentotiedon (controller pose), tuntoperusteiset laitteet (haptic actuators) ja muita vastaavia.

Huom: Artikkeli Using VR controllers with WebVR selittää perusteet VR-ohjaimien käytöstä WebVR-sovelluksissa.

VRDisplay (en-US)

Edustaa mitä tahnsa APIn tukemaa VR-laitetta. Siinä on mukana yleistiedot laittesta, kuten laitteen tunnisteet (ID) ja kuvaukset sekä metodit VR-skenen esittämisen käynnistämiseen, silmäparametrien ja näytön ominaisuuksien hakemiseen ja muut olennaiset toiminnat.

VRDisplayCapabilities (en-US)

Esittää VRDisplay (en-US):n ominaisuudet — näillä voidaan testata, saako laitteelta esimerkiksi sijaintitietoa.

VRDisplayEvent (en-US)

Edustaa WebVR-kohtaisen tapahtuman tapahtumaobjektia (kts. window object extensions alempana).

VRFrameData (en-US)

Vastaa kaikkea tietoa, mitä yksittäisen VR-skenen ruudun renderöintiin tarvitaan; metodi VRDisplay.getFrameData() (en-US) hakee nämä tiedot.

VRPose (en-US)

Edustaa tietyllä ajanhetkellä vallitsevaa sijaintitietoa (johon kuuluvat suunta, sijainti, nopeus ja kiihtyvyys.)

VREyeParameters (en-US)

Tarjoaa pääsyn kaikkeen tietoon, joka tarvitaan skenen renderöintiin oikein kullekin silmälle, esimerkiksi näkökentän laajuuden.

VRFieldOfView (en-US)

Näkökenttätieto, joka on määritelty keskipisteestä katsottuna neljällä asteluvulla.

VRLayerInit (en-US)

Tämä on VRDisplay (en-US)-näytöllä esitettävä kuvan eräs taso (layer).

VRStageParameters (en-US)

Huoneskaalaa tukevien laitteiden kanssa käytettävissä sovelluksissa "näyttämöalueen" tiedot löytyvät tästä.

WebVR API laajentaa joitakin API-rajapintoja lisäten seuraavat ominaisuudet.

Gamepad

Gamepad.displayId (en-US) Read only

Palauttaa liitetyn VRDisplay (en-US) tunnisteen VRDisplay.displayId (en-US) — VRDisplay , jonka skeneä gamepad ohjaa.

Navigator

Navigator.activeVRDisplays (en-US) Read only

Palauttaa taulukon, jossa on mukana jokainen VRDisplay (en-US), joka esittää parhaillaan (VRDisplay.ispresenting (en-US) on true).

Navigator.getVRDisplays() (en-US)

Palauttaa promise-objektin, joka sisältää taulukon VRDisplay (en-US) objekteja, jotka vastaavat kaikkia tietokoneeseen liitettyjä VR-näyttöjä.

Window-tapahtumat

Window.onvrdisplaypresentchange (en-US)

Edustaa tapahtumankäsittelijää (event handler), joka suoritetaan, kun VR_näytön esittämistila muuttuu — esimerkiksi tilasta 'esittää' tilaan 'ei esitä' tai päinvastoin (kun tapahtuma vrdisplaypresentchange signaloidaan).

Window.onvrdisplayconnect (en-US)

Tämä tapahtumankäsittelijä suoritetaan, kun yhteensopiva VR-näyttö on kytketty tietokoneeseen (tapahtuma vrdisplayconnect ).

Window.onvrdisplaydisconnect (en-US)

Tämä tapahtumankäsittelijä suoritetaan, kun yhteensopiva VR-näyttö irrotetaan tietokoneesta (kun tapahtuma vrdisplaydisconnect signaloidaan).

Window.onvrdisplayactivate (en-US)

Edustaa taphtumaa, joka suoritetaan, kun näyttö on valmis esittämään sisältöä (tapahtuma vrdisplayactivate ),esimerkiksi kun silmikko aktivoituu virransäästötilasta tai puetaan päälle.

Window.onvrdisplaydeactivate (en-US)

Tämä tapahtumankäsittelijä suoritetaan, kun näytölle ei voi enää esittää sisältöä (kun tapahtuma vrdisplaydeactivate signaloidaan), esimerkiksi syystä, että silmikkonäyttö on siirtynyt virransäästötilaan käyttämättömyyden vuoksi.

Window:n tapahtumat, jotka eivät ole käytettävissä

Seuraavat tapahtumat löytyvät APIn määrittelystä, mutta niiden toteutusta ei tunnu vielä löytyvän mistään selaimista.

Window.onvrdisplayblur (en-US)

Edustaa tapahtumankäsittelijää, joka suoritetaan kun selain, käyttöjärjestelmä tai VR-laitteisto on keskeyttänyt esittämisen näytölle jostain syystä (tapahtuman vrdisplayblur johdosta) — esimerkiksi käytettäessä järjestelmän valikkoa tai selainta. Tarkoitus on estää seurantaa tai VR-kokemuksen menetystä.

Window.onvrdisplayfocus (en-US)

Tämä tapahtumankäsittelijä suoritetaan, kun esittäminen näytöllä palautuu edellisen tapahtuman jälkeen (tapahtumasta vrdisplayfocus ).

Näiltä sivustoilta töydät useita esimerkkejä:

• webvr-tests — hyvin yksinkertaisia esimerkkejä MDN:n WebVR dokumentaation tueksi.
• Carmel starter kit — mukavia yksinkertaisia ja hyvin kommentoituja esimerkkejä, jotka tulevat Carmel:in, Facebookin WebVR-selaimen mukana.
• WebVR.info samples — hieman syvemmälle meneviä esimerkkejä lähdekoodeineen
• WebVR.rocks Firefox demos — demottavia esimerkkejä
• A-Frame homepage — esimerkkejä A-Frame:n käytöstä

[1] API käytettävissä (Available) kaikilla alustoilla lipulla, mutta tällä hetkellä toimii ainoastaan kokeellisessa työpöytäversiossa (experimental version of Chrome) (muut versiot eivät palauta yhtään laitetta metodia Navigator.getVRDisplays() (en-US) kutsuttaessa).

[2] Tällä hetkellä ainoastaan Windows ja Mac OSX tuki on oletuksena päällä.

[3] Nyt ainoastaan laitteella Google Daydream.

[4] Päällä Firefox Nightly ja Beta -versioissa 55 ja uudempi. Käytetään valinnalla dom.gamepad-extensions.enabled.

• vr.mozilla.org — Mozillan WebVR:n aloitussivu, jossa on demoja, apuohjelmia ja muuta tietoa.
• A-Frame — Open source web-sovelluskehys VR-kokemuksien rakentamiseen.
• webvr.info — Ajantasaista tietoa WebVR:stä, selaintuesta ja yhteisöstä.
• MozVr.com — Demoja, latauslinkkejä ja muuta Mozillan VR-ryhmän tarjoamia resursseja.
• threejs-vr-boilerplate — Käyttökelpoinen mallipohja, jonka päälle WebVR-sovellus on helppo rakentaa.
• Web VR polyfill — JavaScript -toteutus WebVR:n toiminnoista.