com.shc.webgl4j.client

Class WebGLContext

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

com.shc.webgl4j.client.WebGLContext

public final class WebGLContext
extends com.google.gwt.core.client.JavaScriptObject

A WebGLContext represents a WebGL rendering context that is used to draw WebGL graphics onto a HTML5 canvas. A context can represent many things, such as which objects are bound to which targets, and the state associated with this instance of WebGL. It also provides the WebGL version that is used for it's functions, and also the WebGLContext.Attributes of the context.

This also contains the WebGL functions that does the drawing on a canvas. The static methods in WebGL10 class call the same methods present in the context which is 'current' at that time. This allows for grouping the methods by the version of WebGL they were first introduced, allowing to easily keep track of which version your application is using.

In order to render anything, a context must be current. If not, the WebGL10 class will not know from where to call the functions upon, and hence a ReferenceError will be generated.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebGLContext.Attributes This class represents the context attributes that were used to create a context, or the attributes that will be used to create a context.
static interface	WebGLContext.HandlesContextLoss Handles Context Loss is an attribute that specifies that a method defined by WebGL API handles the context loss automatically.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WebGLContext()

Method Summary

Modifier and Type	Method and Description
static boolean	exitFullscreen() A cross-browser polyfill for FullScreen API.
WebGLContext.Attributes	getAttributes() Returns the WebGL context attributes that are used to create this context.
static WebGLContext	getCurrent() Returns the current context.
com.google.gwt.core.client.JavaScriptObject	getGL() Returns the native JS WebGL context object that this class wraps upon.
float	getVersion() Returns the WebGL context version as a float.
static boolean	isFullscreen() A cross-browser polyfill for FullScreen API.
void	makeCurrent() Makes this context current, so that it will be used to render when the static WebGL methods are called.
boolean	requestFullscreen() A cross browser polyfill for the fullscreen API.

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

WebGLContext

protected WebGLContext()

Method Detail

isFullscreen

public static boolean isFullscreen()

A cross-browser polyfill for FullScreen API. Works on Google Chrome 15 and above, Firefox 9 and above, Safari, Opera 32 and above, Internet Explorer 11 and the new Microsoft Edge. Returns true if any of the context or even any other element in the page is fullscreen.

Returns:

True if any context is in fullscreen mode, false otherwise.

exitFullscreen

public static boolean exitFullscreen()

A cross-browser polyfill for FullScreen API. Works on Google Chrome 15 and above, Firefox 9 and above, Safari, Opera 32 and above, Internet Explorer 11 and the new Microsoft Edge. This method requests the browser to exit the fullscreen state.

Returns:

Returns whether the request is successful.

getCurrent

public static WebGLContext getCurrent()

Returns the current context. If there is no context that is current, then null is returned.

Returns:

The current context.

getGL

public com.google.gwt.core.client.JavaScriptObject getGL()

Returns the native JS WebGL context object that this class wraps upon. This is a javascript object that contains all the methods that are called by WebGL10 and such classes.

Returns:

The native JS WebGL context object that this class wraps upon.

getVersion

public float getVersion()

Returns the WebGL context version as a float. This is 1.0 for WebGL10 context, and 2.0 for WebGL20 contexts.

Returns:

The WebGL context version as a float.

getAttributes

public WebGLContext.Attributes getAttributes()

Returns the WebGL context attributes that are used to create this context.

Returns:

The context attributes that are used to create this context.

makeCurrent

public void makeCurrent()

Makes this context current, so that it will be used to render when the static WebGL methods are called. This will result in the following WebGL calls have effect only on the canvas that this context is based upon.

requestFullscreen

public boolean requestFullscreen()

A cross browser polyfill for the fullscreen API. Works on Google Chrome 15 and above, Firefox 9 and above, Safari, Opera 32 and above, Internet Explorer 11 and the new Microsoft Edge. This method requests the browser to enable fullscreen for the canvas that this WebGLContext uses.

Returns:

Returns whether the request succeeded or not.