Interface Renderable

The interface contract for an object that may exist in a Scene. This interface is designed to place very few demands on the implementation.

interface Renderable {
    name?: string;
    transparent?: boolean;
    addRef?(): number;
    contextFree?(): void;
    contextGain?(): void;
    contextLost?(): void;
    release?(): number;
    render(ambients: Facet[]): void;
}

Hierarchy (view full)

Implemented by

Properties

name? transparent?

Methods

addRef? contextFree? contextGain? contextLost? release? render

Properties

Optionalname

name?: string

An optional name allowing the object to be found by name.

Optionaltransparent

transparent?: boolean

Determines when this object will be renderered relative to other objects. Transparent objects are rendered after non-transparent objects.

Methods

OptionaladdRef

  • addRef(): number

  • Increments the reference count of an Shareable instance.

    Returns number

    The new reference count. This value is intended to be used only for testing purposes.

OptionalcontextFree

  • contextFree(): void

  • Called to request the consumer to free any WebGL resources acquired and owned. The consumer may assume that its cached context is still valid in order to properly dispose of any cached resources. In the case of shared objects, this method may be called multiple times for what is logically the same context. In such cases the consumer must be idempotent and respond only to the first request.

    Returns void

OptionalcontextGain

OptionalcontextLost

  • contextLost(): void

  • Called to inform the dependent of a loss of WebGL rendering context. The dependent must assume that any cached context is invalid. The dependent must not try to use and cached context to free resources. The dependent should reset its state to that for which there is no context.

    Returns void

Optionalrelease

  • release(): number

  • Decrements the reference count of an Shareable instance.

    Returns number

    The new reference count. This value is intended to be used only for testing purposes.

render

Settings

Member Visibility

On This Page

Properties
Methods