Global

Members

(constant) ATTACHMENT :number

Enum for ATTACHMENT

Type:

number

Properties

Name	Type	Description
`COLOR_ATTACHMENT0`	number
`COLOR_ATTACHMENT1`	number
`COLOR_ATTACHMENT2`	number
`COLOR_ATTACHMENT3`	number
`COLOR_ATTACHMENT4`	number
`COLOR_ATTACHMENT5`	number
`COLOR_ATTACHMENT6`	number
`COLOR_ATTACHMENT7`	number
`COLOR_ATTACHMENT8`	number
`COLOR_ATTACHMENT9`	number
`COLOR_ATTACHMENT10`	number
`COLOR_ATTACHMENT11`	number
`COLOR_ATTACHMENT12`	number
`COLOR_ATTACHMENT13`	number
`COLOR_ATTACHMENT14`	number
`COLOR_ATTACHMENT15`	number
`DEPTH_ATTACHMENT`	number
`STENCIL_ATTACHMENT`	number
`DEPTH_STENCIL_ATTACHMENT`	number

(constant) BLEND_EQUATION :number

Enum for blend equation.

Type:

number

Properties

Name	Type	Description
`ADD`	number
`SUBTRACT`	number
`REVERSE_SUBTRACT`	number
`MIN`	number	Only webgl2
`MAX`	number

(constant) BLEND_FACTOR :number

Enum for blend factor.

Type:

number

Properties

Name	Type	Description
`ZERO`	number
`ONE`	number
`SRC_COLOR`	number
`SRC_ALPHA`	number
`SRC_ALPHA_SATURATE`	number
`DST_COLOR`	number
`DST_ALPHA`	number
`ONE_MINUS_SRC_COLOR`	number
`ONE_MINUS_SRC_ALPHA`	number
`ONE_MINUS_DST_COLOR`	number
`ONE_MINUS_DST_ALPHA`	number

(constant) BLEND_TYPE :string

Enum for blend Type.

Type:

string

Properties

Name	Type	Description
`NONE`	string
`NORMAL`	string
`ADD`	string
`SUB`	string
`MUL`	string
`CUSTOM`	string

(constant) BUFFER_USAGE :number

Enum for BUFFER_USAGE

Type:

number

Properties

Name	Type	Description
`STREAM_DRAW`	number
`STREAM_READ`	number
`STREAM_COPY`	number
`STATIC_DRAW`	number
`STATIC_READ`	number
`STATIC_COPY`	number
`DYNAMIC_DRAW`	number
`DYNAMIC_READ`	number
`DYNAMIC_COPY`	number

(constant) COMPARE_FUNC :number

Enum for compare function.

Type:

number

Properties

Name	Type	Description
`LEQUAL`	number
`GEQUAL`	number
`LESS`	number
`GREATER`	number
`EQUAL`	number
`NOTEQUAL`	number
`ALWAYS`	number
`NEVER`	number

(constant) CULL_FACE_TYPE :string

Enum for cull face Type.

Type:

string

Properties

Name	Type	Description
`NONE`	string
`FRONT`	string
`BACK`	string
`FRONT_AND_BACK`	string

(constant) DRAW_MODE :number

Enum for Draw Mode.

Type:

number

Properties

Name	Type	Description
`POINTS`	number
`LINES`	number
`LINE_LOOP`	number
`LINE_STRIP`	number
`TRIANGLES`	number
`TRIANGLE_STRIP`	number
`TRIANGLE_FAN`	number

(constant) DRAW_SIDE :string

Enum for draw side.

Type:

string

Properties

Name	Type	Description
`FRONT`	string
`BACK`	string
`DOUBLE`	string

(constant) DefaultLoadingManager :LoadingManager

The global default loading manager.

Type:

LoadingManager

(constant) ENVMAP_COMBINE_TYPE :string

Enum for Envmap Combine Type.

Type:

string

Properties

Name	Type	Description
`MULTIPLY`	string
`MIX`	string
`ADD`	string

(constant) MATERIAL_TYPE :string

Enum for material Type.

Type:

string

Properties

Name	Type	Description
`BASIC`	string
`LAMBERT`	string
`PHONG`	string
`PBR`	string
`PBR2`	string
`POINT`	string
`LINE`	string
`SHADER`	string
`DEPTH`	string
`DISTANCE`	string

(constant) OPERATION :number

Enum for operation.

Type:

number

Properties

Name	Type	Description
`KEEP`	number
`REPLACE`	number
`INCR`	number
`DECR`	number
`INVERT`	number
`INCR_WRAP`	number
`DECR_WRAP`	number

(constant) PIXEL_FORMAT :number

Enum for pixel format.

Type:

number

Properties

Name	Type	Description
`DEPTH_COMPONENT`	number
`DEPTH_STENCIL`	number
`STENCIL_INDEX8`	number
`ALPHA`	number
`RED`	number
`RGB`	number
`RGBA`	number
`LUMINANCE`	number
`LUMINANCE_ALPHA`	number
`RED_INTEGER`	number	Only webgl2
`RG`	number
`RG_INTEGER`	number
`RGB_INTEGER`	number
`RGBA_INTEGER`	number
`R32F`	number	Only internal formats and webgl2
`R16F`	number
`R8`	number
`RG32F`	number
`RG16F`	number
`RG8`	number
`RGB32F`	number
`RGB16F`	number
`RGB8`	number
`RGBA32F`	number
`RGBA16F`	number
`RGBA8`	number
`RGBA4`	number
`RGB5_A1`	number
`DEPTH_COMPONENT32F`	number
`DEPTH_COMPONENT24`	number
`DEPTH_COMPONENT16`	number
`DEPTH24_STENCIL8`	number
`DEPTH32F_STENCIL8`	number
`R11F_G11F_B10F`	number
`RGB_S3TC_DXT1`	number	For compressed texture formats
`RGBA_S3TC_DXT1`	number
`RGBA_S3TC_DXT3`	number
`RGBA_S3TC_DXT5`	number
`RGB_PVRTC_4BPPV1`	number
`RGB_PVRTC_2BPPV1`	number
`RGBA_PVRTC_4BPPV1`	number
`RGBA_PVRTC_2BPPV1`	number
`RGB_ETC1`	number
`RGBA_ASTC_4x4`	number
`RGBA_BPTC`	number

(constant) PIXEL_TYPE :number

Enum for pixel Type.

Type:

number

Properties

Name	Type	Description
`UNSIGNED_BYTE`	number
`UNSIGNED_SHORT_5_6_5`	number
`UNSIGNED_SHORT_4_4_4_4`	number
`UNSIGNED_SHORT_5_5_5_1`	number
`UNSIGNED_SHORT`	number
`UNSIGNED_INT`	number
`UNSIGNED_INT_24_8`	number
`FLOAT`	number
`HALF_FLOAT`	number
`FLOAT_32_UNSIGNED_INT_24_8_REV`	number
`BYTE`	number
`SHORT`	number
`INT`	number

(constant) QUERY_TYPE :number

Enum for QUERY_TYPE

Type:

number

Properties

Name	Type	Description
`ANY_SAMPLES_PASSED`	number
`ANY_SAMPLES_PASSED_CONSERVATIVE`	number
`TIME_ELAPSED`	number

(constant) SHADING_TYPE :string

Enum for shading side.

Type:

string

Properties

Name	Type	Description
`SMOOTH_SHADING`	string
`FLAT_SHADING`	string

(constant) SHADOW_TYPE :string

Enum for Shadow Type.

Type:

string

Properties

Name	Type	Description
`HARD`	string
`POISSON_SOFT`	string
`PCF3_SOFT`	string
`PCF5_SOFT`	string
`PCSS16_SOFT`	string	Only webgl2
`PCSS32_SOFT`	string
`PCSS64_SOFT`	string

(constant) TEXEL_ENCODING_TYPE :string

Enum for Texel Encoding Type.

Type:

string

Properties

Name	Type	Description
`LINEAR`	string
`SRGB`	string
`GAMMA`	string

(constant) TEXTURE_FILTER :number

Enum for texture filter.

Type:

number

Properties

Name	Type	Description
`NEAREST`	number
`LINEAR`	number
`NEAREST_MIPMAP_NEAREST`	number
`LINEAR_MIPMAP_NEAREST`	number
`NEAREST_MIPMAP_LINEAR`	number
`LINEAR_MIPMAP_LINEAR`	number

(constant) TEXTURE_WRAP :number

Enum for texture wrap.

Type:

number

Properties

Name	Type	Description
`REPEAT`	number
`CLAMP_TO_EDGE`	number
`MIRRORED_REPEAT`	number

(constant) VERTEX_COLOR :number

Enum for Vertex Color.

Type:

number

Properties

Name	Type	Description
`NONE`	number
`RGB`	number
`RGBA`	number

Methods

cloneJson(obj) → {object}

Clone json. This is faster than JSON.parse(JSON.stringify()).

Parameters:

Name	Type	Description
`obj`	object	The input json.

Returns:

The output json.

Type:: object

cloneUniforms(uniforms_src) → {object}

Clone uniforms.

Parameters:

Name	Type	Description
`uniforms_src`	object	The input uniforms.

Returns:

The output uniforms.

Type:: object

Type Definitions

RenderOptions

The render options for renderRenderableItem and renderRenderableList methods.

Type:

object

Properties

Name	Type	Description
`getGeometry`	function	(Optional) Get renderable geometry.
`getMaterial`	function	(Optional) Get renderable material.
`beforeRender`	function	(Optional) Before render each renderable item.
`afterRender`	function	(Optional) After render each renderable item.
`ifRender`	function	(Optional) If render the renderable item.
`renderInfo`	RenderInfo	(Optional) Render info for collect information.
`onlyCompile`	boolean	(Optional) Only compile shader, do not render.

onErrorCallback(error)

Callback for onError in loaders.

Parameters:

Name	Type	Description
`error`	Error	The error which occurred during the loading process.

onProgressCallback(event)

Callback for onProgress in loaders.

Parameters:

Name	Type	Description
`event`	ProgressEvent	An instance of `ProgressEvent` that represents the current loading status.