ViewportQuad

var viewportQuad = new ViewportQuad(new BoundingRectangle(0, 0, 80, 40));
viewportQuad.material.uniforms.color = new Color(1.0, 0.0, 0.0, 1.0);

Members

material :Material

The surface appearance of the viewport quad. This can be one of several built-in Material objects or a custom material, scripted with Fabric.

The default material is Material.ColorType.

Example

// 1. Change the color of the default material to yellow
viewportQuad.material.uniforms.color = new Color(1.0, 1.0, 0.0, 1.0);

// 2. Change material to horizontal stripes
viewportQuad.material = Material.fromType(scene.getContext(), Material.StripeType);

See:

• Fabric

rectangle :BoundingRectangle

The BoundingRectangle defining the quad's position within the viewport.

Example

viewportQuad.rectangle = new BoundingRectangle(0, 0, 80, 40);

show :Boolean

Determines if the viewport quad primitive will be shown.

Default Value:

• true

Methods

destroy

Destroys the WebGL resources held by this object. Destroying an object allows for deterministic release of WebGL resources, instead of relying on the garbage collector to destroy this object.

Once an object is destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception. Therefore, assign the return value (undefined) to the object as done in the example.

Throws:

DeveloperError : This object was destroyed, i.e., destroy() was called.

Returns:

Example

quad = quad && quad.destroy();

See:

• ViewportQuad#isDestroyed

isDestroyed

Returns true if this object was destroyed; otherwise, false.

If this object was destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception.

Returns:

Boolean True if this object was destroyed; otherwise, false.

See:

• ViewportQuad#destroy

update

Commits changes to properties before rendering by updating the object's WebGL resources.

Throws:

• DeveloperError : this.material must be defined.
• DeveloperError : this.rectangle must be defined.