Tutorial WebGL

Aus DGL Wiki
Wechseln zu: Navigation, Suche

WebGL ist der neue Standard für OpenGL im Browser. Der Standard ermöglicht es hardwarebeschleunigte 3D-Grafik mit Shadern im Browser darzustellen, ohne dabei auf spezielle Plugins angewiesen zu sein.

In diesem Tutorial werden die wesentlichen Besonderheiten von WebGL gegenüber anderen OpenGL-Anwendungen vorgestellt. Kenntnisse in JavaScript und OpenGL ES 2.0, also insbesondere GLSL und VBOs werden vorausgesetzt. Es sei darauf hingewiesen, dass WebGL im Augenblick noch hochgradig experimentell ist und bisher auch nicht wirklich dokumentiert ist. Neben diesem Tutorial existieren auch einige andere Tutorials, aber ein Blick in den Quellcode der verfügbaren Demos kann nie schaden.

WebGL ist im wesentlichen ein JavaScript-Binding für OpenGL ES 2.0 und wird bisher von den aktuellen Entwickler-Versionen von Firefox, Google Chrome und Safari unterstützt. Weitere Browser auf Gecko- bzw. Webkit-Basis werden sicher bald folgen. Bisher wird der WebGL-Standard von den folgenden Browsern unterstützt (Stand Dezember 2009):

  • Gecko-Engine
    • Mozilla Firefox 4.0 (Homepage)
      • WebGL muss über die Einstellung about:config -> webgl.enabled_for_all_sites aktiviert werden. Unter Windows kann es einige Probleme geben, wenn kein OpenGL verfügbar ist, in dem Fall muss in den Softwaremodus geschaltet werden.
      • Es ist möglich verschiedene Firefox-Versionen parallel zu verwenden. Es ist aber ratsam dafür getrennte Profile anzulegen. Das Ausführen von firefox -help in der Konsole dürfte in diesem Zusammenhang hilfreich sein, insbesondere die Optionen -P, -ProfileManager und -no-remote.
  • WebKit (Nightly Build)
    • Google Chrome 4.0.221.8 (Nightly-Build)
      • mit den Parametern --enable-webgl und --no-sandbox starten
    • Safari (Nightly Build, ab ca. 23.9.2009)
  • ...bitte ergänzen...



Demos

Zunächst einmal ein paar Demos um die Funktionalität des eigenen Browsers zu testen.

webgl-sporeviewer.jpg
Spore Creature Viewer
webgl-metatunnel.jpg
Metatunnel


WebGL

Context

Um WebGL nutzen zu können benötigt man zunächst einmal ein HTML5 Canvas-Element, welchem wir passender weise die ID "canvas" geben. Wir können die Anwendung beispielsweise über das onload-Event des body-Elements startet. Genauso gut kann man natürlich auch einen Link oder Button verwenden.

<html>
    <head>
        <script type="text/javascript">
	<!--
            function init() {
 
                // ...
 
            }
	// -->
        </script> 
    </head>
    <body onload="init()">
        <div style="text-align: center">
            <canvas id="canvas" width="640" height="480"></canvas>
        </div>
    </body>
</html>

Von unserem Canvas erhalten wir zum einen die spätere Viewportgröße und zum anderen einen sogenannten Context. Das Context-Objekt erlaubt uns sämtliche OpenGL ES 2.0 Funktionen aufzurufen.

// our WebGL rendering context, it might be useful to use a global variable for this
var gl = null;
 
// grab the canvas object and its dimensions
var canvas = document.getElementById("canvas");
var viewportWidth = canvas.width;
var viewportHeight = canvas.height;
 
// request rendering context from the canvas
var names = [ "webgl", "experimental-webgl", "moz-webgl", "webkit-3d" ];
for (var i=0; i<names.length; i++) {
    try { 
        gl = canvas.getContext(names[i]);
        if (gl) { break; }
    } catch (e) { }
}
if (!gl) {
    alert("No known OpenGL context detected! Is it enabled?");
    return;
}
 
// since WebGL is still experimental, we need some compatibility code
compatibilityCode();

Da die verschiedenen Implementierungen noch nicht alle auf dem selben Stand sind ist im Augenblick noch etwas Kompatibilitätscode erforderlich. In Zukunft wird dies hoffentlich nicht mehr notwendig sein. Die Funktion compatibilityCode() findest du in der Beispiel-Implementierung dieses Tutorials.

Shader

In OpenGL ES 2.0 herrscht Shader-Zwang, eine feste Funktionspipeline existiert nicht. Stehen der verfügbaren Grafikhardware keine GLSL-Shader zur Verfügung, muss OpenGL ES in den Softwaremodus geschaltet werden und wird entsprechend langsam. Das Laden von GLSL-Shadern geschieht wie gewohnt. Zuerst werden Vertex- und Fragmentshader geladen und compiliert. Beide Shader werden dann an ein Program-Objekt angehängt und gelinkt.

function loadShader(shaderType, shaderSource) {
    var shader = gl.createShader(shaderType);
    if (!shader) { return null; }    
    gl.shaderSource(shader, shaderSource);
    gl.compileShader(shader);
 
    if (!gl.getShaderParameter(shader, gl.COMPILE_STATUS)) {
        alert(gl.getShaderInfoLog(shader));
        return null;
    }    
 
    return shader;
}
 
var vertexShaderSource = "...Vertexshader als String...";
var fragmentShaderSource = "...Fragmentshader als String...";
 
var vertexShader = loadShader(gl.VERTEX_SHADER, vertexShaderSource);
var fragmentShader = loadShader(gl.FRAGMENT_SHADER, fragmentShaderSource);
if (!vertexShader || !fragmentShader) {
    alert("Shader problem");
}
 
// create program object
var program = gl.createProgram();
 
// attach our two shaders to the program
gl.attachShader(program, vertexShader);
gl.attachShader(program, fragmentShader);
 
// setup attributes (optional)
gl.bindAttribLocation(program, 0, "aPosition");
gl.bindAttribLocation(program, 1, "aNormal");
gl.bindAttribLocation(program, 2, "aTexCoord");
 
// linking
gl.linkProgram(program);
if (!gl.getProgramParameter(program, gl.LINK_STATUS)) {
    alert(gl.getProgramInfoLog(program));
}
 
// setup uniforms (optional)
gl.useProgram(program);
gl.uniform1i(gl.getUniformLocation(program, "uTexture"), 0);

Im obigen Beispiel wird der Shader-Quellcode fest als String in den JavaScript-Code integriert. Das ist natürlich ziemlich unübersichtlich. Vom Prinzip spielt es keine Rolle wo der String herkommt. Beispielsweise kann man ihn mit einem HTTP-Request in einer Shader-Datei vom Server laden. Es ist aber auch möglich den Shader-Code als spezielles Script-Element in die HTML-Datei einzubinden.

<script id="shader-vs" type="x-shader/x-vertex">
attribute vec3 aPosition;
attribute vec3 aNormal;
attribute vec2 aTexCoord;
varying vec3 vNormal;
varying vec2 vTexCoord; 
void main() {
    gl_Position = vec4(aPosition, 1.0);
    vTexCoord = aTexCoord;
    vNormal = aNormal;
}
</script>
 
<script id="shader-fs" type="x-shader/x-fragment">
varying vec3 vNormal;
varying vec2 vTexCoord;
uniform sampler2D uTexture;
void main() {
    gl_FragColor = texture2D(uTexture, vTexCoord);
}
</script>

Der Browser hat vom Script-Typ "x-shader/x-vertex" natürlich noch nie etwas gehört und wird das Element entsprechend einfach ignorieren. Mit einer einfachen JavaScript-Funktion kann man aber trotzdem an den Inhalt gelangen.

function getShaderSource(id) {
    var script = document.getElementById(id);
    if (!script) { return null; }
 
    var source = "";
    var child = script.firstChild;
    while (child) {
        // node is a "textnode" ?
        // see: http://de.selfhtml.org/javascript/objekte/node.htm#node_type
        if (child.nodeType == 3) {
            source += child.textContent;
        }
        child = child.nextSibling;
    }
    return source;
}
 
var vertexShaderSource = getShaderSource("shader-vs");
var fragmentShaderSource = getShaderSource("shader-fs");

VertexBufferObjects

VertexArrays scheinen zumindest im Firefox bisher nicht implementiert zu sein. Das mag damit zusammenhängen, dass Arrays in JavaScript sehr langsam sind. Arrays müssen nämlich in JavaScript nicht zwangsläufig wirkliche zusammenhängende Arrays sein, sondern können auch als HashMap realisiert sein.

Um Geometrie zu rendern muss also zumindest im Augenblick auf VertexBufferObjects (VBOs) zurückgegriffen werden. Diese können im wesentlichen wie gewohnt benutzt werden. Es gibt eine spezielle Wrapper-Klasse WebGLFloatArray die ein JavaScript-Array mit Werten in ein richtiges float-Array umwandelt. Dieses WebGLFloatArray wird dann an OpenGL übergeben. Zusätzlich gibt es auch die Klassen WebGLByteArray, WebGLShortArray und WebGLIntArray. Außerdem existieren auch WebGLUnsignedByteArray, WebGLUnsignedShortArray und WebGLUnsignedIntArray.

Leider existiert im Zusammenhang mit glVertexAttribPointer ein Bug in der aktuellen Firefox-Implementierung. Aus Sicherheitsgründen wird die mindestens notwendige Größe eines Vertexbuffers geprüft bevor darauf zugegriffen werden kann. Sofern wie im Beispiel ein Interleaved-VBO verwendet wird, wird diese Größe leider falsch berechnet. Um den Bug zu umgehen müssen im Augenblick Indices benutzt werden.

// define some vertexdata
var vertices = [
    // position XYZ, normal XYZ, texcoord UV => 8 floats per vertex
    -0.5,  0.5,  0.0,  0.6,  0.0,  0.8,  0.0,  0.0,
     0.5,  0.5,  0.0,  0.6,  0.0,  0.8,  1.0,  0.0,
    -0.5, -0.5,  0.0,  0.0,  0.0,  1.0,  0.0,  1.0,
     0.5, -0.5,  0.0,  0.0,  0.6,  0.8,  1.0,  1.0,
];
// we need also some indices because of this annoying Firefox-Bug:
// https://bugzilla.mozilla.org/show_bug.cgi?id=521667
var indices = [
   0, 1, 2, 2, 1, 3
];
// create VBO & IBO
var vbo = gl.createBuffer();
gl.bindBuffer(gl.ARRAY_BUFFER, vbo);
gl.bufferData(gl.ARRAY_BUFFER, new WebGLFloatArray(vertices), gl.STATIC_DRAW);
var ibo = gl.createBuffer();
gl.bindBuffer(gl.ELEMENT_ARRAY_BUFFER, ibo);
gl.bufferData(gl.ELEMENT_ARRAY_BUFFER, new WebGLUnsignedShortArray(indices), gl.STATIC_DRAW);
 
// ...
 
// setup interleaved VBO and IBO
gl.bindBuffer(gl.ARRAY_BUFFER, vbo);
gl.bindBuffer(gl.ELEMENT_ARRAY_BUFFER, ibo);
gl.enableVertexAttribArray(0);
gl.enableVertexAttribArray(1);
gl.enableVertexAttribArray(2);
gl.vertexAttribPointer(0, 3, gl.FLOAT, false, 8*4, 0*4); // position
gl.vertexAttribPointer(1, 3, gl.FLOAT, false, 8*4, 3*4); // normal
gl.vertexAttribPointer(2, 2, gl.FLOAT, false, 8*4, 6*4); // texcoord
 
// draw the buffer
gl.drawElements(gl.TRIANGLES, 6, gl.UNSIGNED_SHORT, 0);

Der schnellste Weg ein Mesh zu laden ist dessen Vertex- und Indexbuffer direkt als JavaScript-Array anzugeben. Die Daten können so nativ vom Browser geladen werden. Größere Meshes hat man natürlich ungern direkt im Quellcode und möchte diese auch vielleicht nicht direkt beim Start der Anwendung laden. Hier bietet sich eine eigene Datei an, die dann über ein XMLHttpRequest-Objekt (Stichwort: AJAX) in JavaScript nachgeladen und anschließend dem Browser zum Parsen übergeben wird. So kann das Laden im Hintergrund realisiert werden.

Ein Problem ist natürlich das Dateiformat. Bisher hat nach meinem Wissen noch niemand einen Benchmark versucht, aber das manuelle Parsen der Daten dauert bei einer JavaScript-Implementierung wahrscheinlich vergleichsweise lange. Außerdem dürfte es in JavaScript schwierig werden Binärdaten zu lesen. Wenn man Daten aus einer externen Datei laden möchte, bietet sich das JSON-Format an. Dieses kann mit der JavaScript-Funktion eval() extrem schnell (da nativ) verarbeitet werden. Die folgenden Loader bzw. Konverter sind bekannt:

Es lohnt sich übrigens diese großen JavaScript-Arrays so kompakt wie möglich zu schreiben. Alleine durch das Weglassen von unnötigen Leerzeichen spart man schnell einige 10 oder 100 kB bei der Dateigröße. Des weiteren erlaubt das HTTP-Protokoll auch die Übertragung mit GZIP-komprimierter Daten. Aktuelle Browser sollten dies nativ unterstützen, so dass keine eigene Implementierung der Komprimierung erforderlich ist. Allerdings muss der HTTP-Server entsprechend konfiguriert sein.

Texturen

Das Laden von Texturen ist relativ einfach, da der Browser bereits über die nötige Infrastruktur zum Laden von Bildern in vielen Formaten bereitstellt. Etwas ungewohnt ist der asynchrone Ladevorgang: Ein Bild steht nicht sofort zur Verfügung, da dieses ja möglicherweise zuerst vom Server geladen werden muss. Sobald aber das Bild verfügbar ist wird das onload-Event ausgelöst. Was im Fehlerfall geschehen soll wird über das onerror-Event festgelegt.

function loadTexture(filename) {
    // preparations
    var texture = gl.createTexture();
    gl.bindTexture(gl.TEXTURE_2D, texture);
    gl.texParameteri(gl.TEXTURE_2D, gl.TEXTURE_MIN_FILTER, gl.LINEAR);
    gl.texParameteri(gl.TEXTURE_2D, gl.TEXTURE_MAG_FILTER, gl.LINEAR);
    var image = new Image();
 
    // register event handlers
    image.onload = function() {
        gl.bindTexture(gl.TEXTURE_2D, texture);
        gl.texImage2D(gl.TEXTURE_2D, 0, image);
        gl.generateMipmap(gl.TEXTURE_2D);
        draw(); // texture now available, we can redraw the scene
    }
    image.onerror = function() {
        alert("error while loading image '"+filename+"'.");
    }
 
    // request image from server
    image.src = filename; 
 
    // return texture object (asynchronous loading, texture NOT available yet!)
    return texture;
}

Ressourcen und Mathematik

Dadurch das Ressourcen (Meshes, Texturen, Shader, ...) im Browser asynchron geladen werden, wird entsprechendes Management dieser Ressourcen erforderlich. Eine Ressource darf erst verwendet werden, wenn sie auch wirklich initialisiert wurde. Entsprechend müssen die zugehörigen Callbacks abgewartet werden.

Eine einfache Lösung für dieses Problem ist ein Ressourcenmanager der alle Daten lädt oder zumindest weiß welche Ressourcen noch geladen werden müssen. Zu Beginn wird einfach nur der Text "Loading..." angezeigt. Jede Ressource meldet sich beim Manager sobald sie verfügbar ist. Sobald alles korrekt initialisiert wurde kann der Ressourcenmanager die eigentliche Anwendung starten.

Genau wie OpenGL 3.1 besitzt auch OpenGL ES 2.0 keine eigenen Mathematikfunktionen mehr. Einen guten Ansatz bietet hierbei das Lineare Algebra Tutorial von TAK2004. Beliebt im Zusammenhang mit WebGL ist im Augenblick die JavaScript-Bibliothek Sylvester die grundlegende Vektor und Matrix Operationen bereitstellt. Die WebGLU Library versucht unter Rückgriff auf Sylvester die aus OpenGL 2.0 (und älter) bekannten Funktionen wie den Matrix-Stack zurückzubringen.

Soweit von mir, im Anschluss findet ihr noch ein Beispiel sowie eine Liste von Links die nach Möglichkeit aktuell gehalten wird.

Coolcat


Vorhergehendes Tutorial:
Tutorial_GLScene
Nächstes Tutorial:
-

Schreibt was ihr zu diesem Tutorial denkt ins Feedbackforum von DelphiGL.com.
Lob, Verbesserungsvorschläge, Hinweise und Tutorialwünsche sind stets willkommen.

Beispiel

Eine Beispielanwendung die die hier vorgestellten Code-Schnippsel zusammenfügt ist hier verfügbar.

webgl-sample.jpg

Links