com.googlecode.gwtgl.binding.WebGLContextAttributes.java Source code

Introduction

Here is the source code for com.googlecode.gwtgl.binding.WebGLContextAttributes.java

Source

/**
 * Copyright 2010 Snke Sothmann, Steffen Schfer and others
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */
package com.googlecode.gwtgl.binding;

import com.google.gwt.core.client.JavaScriptObject;

/**
 * Represents the parameters, the {@link WebGLRenderingContext} is initialized with.
 * 
 */
public final class WebGLContextAttributes extends JavaScriptObject {

    /**
     * Creates a new instance of the {@link WebGLContextAttributes}.
     * 
     * @return the created instance.
     */
    public static WebGLContextAttributes create() {
        return JavaScriptObject.createObject().cast();
    }

    /**
     * Protected standard constructor as specified by
     * {@link com.google.gwt.core.client.JavaScriptObject}.
     */
    protected WebGLContextAttributes() {
        super();
    }

    /**
     * Returns weather alpha is turned on.
     * 
     * @return the state of the alpha flag
     */
    public native Boolean getAlpha() /*-{
                                     if (typeof (this.alpha) == 'undefined') {
                                     return null;
                                     }
                                     return this.alpha;
                                     }-*/;

    /**
     * Returns weather antialiasing is turned on for the rendering context.
     * 
     * @return the state of the antialias flag
     */
    public native Boolean getAntialias() /*-{
                                         if (typeof (this.antialias) == 'undefined') {
                                         return null;
                                         }
                                         return this.antialias;
                                         }-*/;

    /**
     * Returns weather depth buffer is turned on for the rendering buffer.
     * 
     * @return the state of the depth flag
     */
    public native Boolean getDepth() /*-{
                                     if (typeof (this.depth) == 'undefined') {
                                     return null;
                                     }
                                     return this.depth;
                                     }-*/;

    /**
     * Returns weather premultiplied alpha is used.
     * 
     * @return the state of the premultiplied alpha flag
     */
    public native Boolean getPremultipliedAlpha() /*-{
                                                  if (typeof (this.premultipliedAlpha) == 'undefined') {
                                                  return null;
                                                  }
                                                  return this.premultipliedAlpha;
                                                  }-*/;

    /**
     * Returns weather stencil buffer is turned on for the rendering buffer.
     * 
     * @return the state of the stencil flag
     */
    public native Boolean getStencil() /*-{
                                       if (typeof (this.stencil) == 'undefined') {
                                       return null;
                                       }
                                       return this.stencil;
                                       }-*/;

    /**
     * Sets a new value for the alpha flag.
     * 
     * @param alpha the new state of the alpha flag
     */
    public native void setAlpha(Boolean alpha) /*-{
                                               if (alpha == null) {
                                               delete alpha;
                                               } else {
                                               this.alpha = alpha;
                                               }
                                               }-*/;

    /**
     * Sets a new value for the antialias flag.
     * 
     * @param antialias the new state of the antialias flag
     */
    public native void setAntialias(Boolean antialias) /*-{
                                                       if (antialias == null) {
                                                       delete antialias;
                                                       } else {
                                                       this.antialias = antialias;
                                                       }
                                                       }-*/;

    /**
     * Sets a new value for the depth flag.
     * 
     * @param depth the new state of the depth flag
     */
    public native void setDepth(Boolean depth) /*-{
                                               if (depth == null) {
                                               delete depth;
                                               } else {
                                               this.depth = depth;
                                               }
                                               }-*/;

    /**
     * Sets a new value for the premultiplied alpha flag.
     * 
     * @param premultipliedAlpha the new state of the premultiplied alpha flag
     */
    public native void setPremultipliedAlpha(Boolean premultipliedAlpha) /*-{
                                                                         if (premultipliedAlpha == null) {
                                                                         delete premultipliedAlpha;
                                                                         } else {
                                                                         this.premultipliedAlpha = premultipliedAlpha;
                                                                         }
                                                                         }-*/;

    /**
     * Sets a new value for the stencil flag.
     * 
     * @param stencil the new state of the stencil flag
     */
    public native void setStencil(Boolean stencil) /*-{
                                                   if (stencil == null) {
                                                   delete stencil;
                                                   } else {
                                                   this.stencil = stencil;
                                                   }
                                                   }-*/;
}