Members
(constant) ABSOLUTE_URL_REGEX :RegExp
Regex used to detect absolute URLs.
Type:
- RegExp
- Source:
(constant) ACTIONS :Object
Key action registry.
Type:
- Object
- Source:
(constant) ACTION_BACKWARD :string
Key action: move backward.
Type:
- string
- Source:
(constant) ACTION_FORWARD :string
Key action: move forward.
Type:
- string
- Source:
(constant) ACTION_JUMP :string
Key action: jump (space).
Type:
- string
- Source:
(constant) ACTION_LEFT :string
Key action: move left.
Type:
- string
- Source:
(constant) ACTION_RIGHT :string
Key action: move right.
Type:
- string
- Source:
(constant) ACTION_RUN :string
Key action: run (left shift).
Type:
- string
- Source:
(constant) ALPHA_MAP_UNIFORM_NAME :string
Alpha map sampler uniform name.
Type:
- string
- Source:
(constant) ALPHA_UV_OFFSET_UNIFORM_NAME :string
Alpha UV-offset uniform name.
Type:
- string
(constant) ALPHA_UV_SCALE_UNIFORM_NAME :string
Alpha UV-scale uniform name.
Type:
- string
(constant) AMBIENT_COLOR_EPSILON :number
Epsilon used, when checking for near-zero ambient colors.
Type:
- number
(constant) AMBIENT_COLOR_UNIFORM_NAME :string
Ambient color uniform name.
Type:
- string
(constant) AMBIENT_MAP_UNIFORM_NAME :string
Ambient map sampler uniform name.
Type:
- string
- Source:
(constant) AMBIENT_STRENGTH_UNIFORM_NAME :string
Ambient strength uniform name.
Type:
- string
(constant) AMBIENT_UV_OFFSET_UNIFORM_NAME :string
Ambient UV-offset uniform name.
Type:
- string
(constant) AMBIENT_UV_SCALE_UNIFORM_NAME :string
Ambient UV-scale uniform name.
Type:
- string
(constant) APEX_UV_U :number
Default UV for apex vertex.
Type:
- number
- Source:
(constant) APEX_UV_V :number
Default UV for apex vertex.
Type:
- number
- Source:
(constant) ARIA_LIVE_POLITE :string
Attribute value used to announce updates politely.
Type:
- string
- Source:
(constant) ARIA_ROLE_STATUS :string
Role attribute value for the root element.
Type:
- string
- Source:
(constant) ARROW_COLOR :Float32Array
Arrow color (RGB).
Type:
- Float32Array
- Source:
(constant) ARROW_HEAD_HALF_WIDTH :number
Arrow head half-width.
Type:
- number
- Source:
(constant) ARROW_HEAD_LENGTH :number
Arrow head length.
Type:
- number
- Source:
(constant) ARROW_LENGTH :number
Direction arrow length.
Type:
- number
- Source:
(constant) ASIN_CLAMP_MAX :number
Maximum clamp value for asin.
Type:
- number
- Source:
(constant) ASIN_CLAMP_MIN :number
Minimum clamp value for asin.
Type:
- number
- Source:
(constant) ATTRIBUTE_LOCATION_NOT_FOUND_VALUE :number
WebGL sentinel value for `attribute not found`.
getAttribLocation returns `-1`, when the attribute is not found.
Type:
- number
- Source:
(constant) ATTRIBUTE_NORMALIZED :boolean
Flag passed to `vertexAttribPointer()` method.
When false, attribute values are used as-is (no normalization).
Type:
- boolean
- Source:
(constant) ATTRIBUTE_NO_OFFSET :number
Offset parameter for `vertexAttribPointer()` for attributes starting at the beginning of the buffer.
Type:
- number
- Source:
(constant) ATTRIBUTE_NO_STRIDE :number
Stride parameter for `vertexAttribPointer()`, when the attribute data is tightly packed.
Zero means: compute stride automatically from attribute size and type.
Type:
- number
- Source:
(constant) AUTO_EXPECTED_PER_VERTEX_COLOR_LENGTH :number
Sentinel value, that means auto-detect expected per-vertex color buffer length.
Type:
- number
- Source:
(constant) AXIS_ACTIVE_OPACITY :number
Opacity, used for active axes.
Type:
- number
- Source:
(constant) AXIS_DIR_X :Array.<number>
Unit direction for X axis.
Type:
- Array.<number>
- Source:
(constant) AXIS_DIR_Y :Array.<number>
Unit direction for Y axis.
Type:
- Array.<number>
- Source:
(constant) AXIS_DIR_Z :Array.<number>
Unit direction for Z axis.
Type:
- Array.<number>
- Source:
(constant) AXIS_HEAD_HALF_WIDTH :number
Axis arrow head half-width.
Type:
- number
- Source:
(constant) AXIS_HEAD_LENGTH :number
Axis arrow head length.
Type:
- number
- Source:
(constant) AXIS_HEAD_ORTHO_X :Array.<number>
Ortho direction for X axis arrow head (drawn in XY plane).
Type:
- Array.<number>
- Source:
(constant) AXIS_HEAD_ORTHO_Y :Array.<number>
Ortho direction for Y axis arrow head (drawn in XY plane).
Type:
- Array.<number>
- Source:
(constant) AXIS_HEAD_ORTHO_Z :Array.<number>
Ortho direction for Z axis arrow head (drawn in XZ plane).
Type:
- Array.<number>
- Source:
(constant) AXIS_HIDDEN_OPACITY_WHEN_ACTIVE :number
Opacity, used to fully hide axes while another axis is active.
Type:
- number
- Source:
(constant) AXIS_HOVER_OPACITY :number
Opacity, used for hovered axes.
Type:
- number
- Source:
(constant) AXIS_IDLE_OPACITY :number
Opacity, used for idle axes.
Type:
- number
- Source:
(constant) AXIS_INACTIVE_OPACITY :number
Opacity, used for inactive axes when hover/active is set.
Type:
- number
- Source:
(constant) AXIS_LENGTH :number
Axis length for the gizmo.
Type:
- number
- Source:
(constant) AXIS_PICK_CENTER_DIVISOR :number
Divider used to place pick volumes in the middle of the axis.
Type:
- number
- Source:
(constant) AXIS_PICK_LENGTH :number
Axis pick volume length.
Type:
- number
- Source:
(constant) AXIS_PICK_THICKNESS :number
Axis pick volume thickness.
Type:
- number
- Source:
(constant) AXIS_X :string
Axis identifier for X.
Type:
- string
- Source:
(constant) AXIS_X_COLOR :Float32Array
X axis color (RGB).
Type:
- Float32Array
- Source:
(constant) AXIS_Y :string
Axis identifier for Y.
Type:
- string
- Source:
(constant) AXIS_Y_COLOR :Float32Array
Y axis color (RGB).
Type:
- Float32Array
- Source:
(constant) AXIS_Z :string
Axis identifier for Z.
Type:
- string
- Source:
(constant) AXIS_Z_COLOR :Float32Array
Z axis color (RGB).
Type:
- Float32Array
- Source:
(constant) BACKSLASH_REGEX :RegExp
Backslash regex for the separator normalization.
Type:
- RegExp
(constant) BACKSLASH_REGEX :RegExp
Matches backslash characters in paths.
Type:
- RegExp
- Source:
(constant) BACKSLASH_SEPARATOR :string
Backslash path separator.
Type:
- string
- Source:
(constant) BASE_MIPMAP_LEVEL :number
Default mipmap level, used by `texImage2D`.
Type:
- number
- Source:
(constant) BASE_PATH_SLICE_OFFSET :number
Offset used, when slicing to a base URL.
Type:
- number
(constant) BITWISE_ZERO :number
Bitwise `zero` value, used in bit-mask comparisons.
Type:
- number
- Source:
(constant) BIT_MASK_ONE :number
Bit mask helper value, used by the `power-of-two` check.
Type:
- number
- Source:
(constant) BOUNDING_BOX_COMPONENT_COUNT :number
Component count for AABB min/max vectors.
Type:
- number
- Source:
(constant) BOUND_MAX_INIT :number
Initial value used for bounding box maximum computations.
Type:
- number
- Source:
(constant) BOUND_MIN_INIT :number
Initial value used for bounding box minimum computations.
Type:
- number
- Source:
(constant) BOX_FACE_COUNT :number
Number of box faces.
Type:
- number
- Source:
(constant) BUMP_MAP_UNIFORM_NAME :string
Bump map sampler uniform name.
Type:
- string
- Source:
(constant) BUMP_MULTIPLIER_UNIFORM_NAME :string
Bump multiplier uniform name.
Type:
- string
(constant) BUMP_UV_OFFSET_UNIFORM_NAME :string
Bump UV-offset uniform name.
Type:
- string
(constant) BUMP_UV_SCALE_UNIFORM_NAME :string
Bump UV-scale uniform name.
Type:
- string
(constant) BYTES_PER_PIXEL :number
Number of bytes per RGBA pixel.
Type:
- number
- Source:
(constant) CACHE_KEY_SEPARATOR :string
Separator used to build cache keys.
Type:
- string
(constant) CAMERA_POSITION_UNIFORM_NAME :string
Camera position uniform name (world space).
Type:
- string
(constant) CANVAS_CONTEXT_2D :string
String identifier for 2D canvas context.
Type:
- string
- Source:
(constant) CANVAS_TAG_NAME :string
String tag name used to create canvas elements.
Type:
- string
- Source:
(constant) CAP_TYPE_FLAT :string
Cap type: flat caps.
Type:
- string
- Source:
(constant) CAP_TYPE_NONE :string
Cap type: no caps.
Type:
- string
- Source:
(constant) CARRIAGE_RETURN_REGEX :RegExp
Carriage return regex for sanitizing the material names.
Type:
- RegExp
(constant) CATMULL_ROM_TENSION :number
Catmull-Rom tension multiplier.
Type:
- number
- Source:
(constant) CENTER_SPHERE_COLOR :Float32Array
Center sphere color (RGB).
Type:
- Float32Array
- Source:
(constant) CENTER_SPHERE_DIAMETER :number
Center sphere diameter.
Type:
- number
- Source:
(constant) CENTER_SPHERE_DIAMETER_MULTIPLIER :number
Multiplier, used to convert radius to diameter.
Type:
- number
- Source:
(constant) CENTER_SPHERE_HEIGHT_SEGMENTS :number
Center sphere latitudinal segment count.
Type:
- number
- Source:
(constant) CENTER_SPHERE_OPACITY :number
Center sphere opacity, when visible.
Type:
- number
- Source:
(constant) CENTER_SPHERE_RADIUS :number
Center sphere radius.
Type:
- number
- Source:
(constant) CENTER_SPHERE_WIDTH_SEGMENTS :number
Center sphere longitudinal segment count.
Type:
- number
- Source:
(constant) CENTER_T_OFFSET :number
Used to center face coordinates around the origin: `(t - 0.5) * size`.
Type:
- number
- Source:
(constant) CENTER_T_OFFSET :number
Used to center coordinates around the origin: `(t - 0.5) * size`.
Type:
- number
- Source:
(constant) CENTER_T_OFFSET :number
Used to center coordinates around the origin: `(t - 0.5) * size`.
Type:
- number
- Source:
(constant) CENTER_T_OFFSET :number
Used to center coordinates around the origin: `(t - 0.5) * size`.
Type:
- number
- Source:
(constant) CHILD_NOT_FOUND_INDEX :number
Type:
- number
- Source:
(constant) CHUNK_KEY_SEPARATOR :string
Separator for the material chunk keys.
Type:
- string
- Source:
(constant) CLAMP_OFF_NUMERIC_TOKEN :string
Token for numeric value `0`.
Type:
- string
- Source:
(constant) CLAMP_OFF_TOKEN :string
Token, representing the `off` value in map options.
Type:
- string
- Source:
(constant) CLAMP_ON_NUMERIC_TOKEN :string
Token for numeric value `1`.
Type:
- string
- Source:
(constant) CLAMP_ON_TOKEN :string
Token, representing the `on` value in map options.
Type:
- string
- Source:
(constant) CLIP_W :number
Clip-space `W component` for unprojection.
Type:
- number
- Source:
(constant) COLORS_PER_FACE_LENGTH :number
Expected length for per-face RGB colors (6 faces * 3).
Type:
- number
- Source:
(constant) COLOR_ATTRIBUTE_LOCATION :number
Attribute location used by vertex color.
Must match shader `layout(location = X)` declaration.
Type:
- number
- Source:
(constant) COLOR_ATTRIBUTE_LOCATION :number
Attribute location used by `vec3` color.
Type:
- number
- Source:
(constant) COLOR_ATTRIBUTE_LOCATION :number
Attribute location used by `vec3` color.
Type:
- number
- Source:
(constant) COLOR_COMPONENT_BLUE_INDEX :number
Blue component index.
Type:
- number
- Source:
(constant) COLOR_COMPONENT_COUNT :number
Number of float components per RGB color.
Type:
- number
- Source:
(constant) COLOR_COMPONENT_COUNT :number
Number of float components per vertex color.
Type:
- number
- Source:
(constant) COLOR_COMPONENT_COUNT :number
Number of components for the RGB-color.
Type:
- number
- Source:
(constant) COLOR_COMPONENT_COUNT :number
Number of components for RGB color.
Type:
- number
(constant) COLOR_COMPONENT_COUNT :number
Number of components for RGB color.
Type:
- number
(constant) COLOR_COMPONENT_COUNT :number
Number of components for RGB color.
Type:
- number
(constant) COLOR_COMPONENT_COUNT :number
Number of components for RGB color.
Type:
- number
- Source:
(constant) COLOR_COMPONENT_COUNT :number
Number of components in a RGB color.
Type:
- number
- Source:
(constant) COLOR_COMPONENT_COUNT :number
Number of components in a RGB color.
Type:
- number
- Source:
(constant) COLOR_COMPONENT_GREEN_INDEX :number
Green component index.
Type:
- number
- Source:
(constant) COLOR_COMPONENT_RED_INDEX :number
Red component index.
Type:
- number
- Source:
(constant) COLOR_START_INDEX :number
Start index for vertex color components in `v` lines.
Type:
- number
- Source:
(constant) COLOR_UNIFORM_NAME :string
Diffuse/base color uniform name.
Type:
- string
(constant) COLOR_UNIFORM_NAME :string
Name of the color uniform in the shader.
Type:
- string
- Source:
(constant) COLOR_UNIFORM_NAME :string
Name of the color uniform in the shader.
Type:
- string
- Source:
(constant) COMMENT_TOKEN :string
Token, that starts a comment line in MTL files.
Type:
- string
- Source:
(constant) COMMENT_TOKEN :string
Token, that starts a comment line in OBJ files.
Type:
- string
- Source:
(constant) COMPONENT_INDEX_X :number
Index positions used in float triplets (X).
Type:
- number
(constant) COMPONENT_INDEX_Y :number
Index positions used in float triplets (Y).
Type:
- number
(constant) COMPONENT_INDEX_Z :number
Index positions used in float triplets (Z).
Type:
- number
(constant) COMPONENT_X :string
Component key for X.
Type:
- string
- Source:
(constant) COMPONENT_Y :string
Component key for Y.
Type:
- string
- Source:
(constant) COMPONENT_Z :string
Component key for Z.
Type:
- string
- Source:
(constant) CROSS_ORIGIN_ANONYMOUS :string
Cross-origin mode, `anonymous`.
Type:
- string
- Source:
(constant) CROSS_ORIGIN_USE_CREDENTIALS :string
Cross-origin mode, `use-credentials`.
Type:
- string
- Source:
(constant) CURVE_PARAMETER_MAX :number
Clamp maximum for the curve parameter.
Type:
- number
- Source:
(constant) CURVE_PARAMETER_MIN :number
Clamp minimum for the curve parameter.
Type:
- number
- Source:
(constant) DECIMAL_RADIX :number
Decimal radix for integer parsing.
Type:
- number
- Source:
(constant) DECIMAL_RADIX :number
Decimal radix for integer parsing.
Type:
- number
- Source:
(constant) DEFAULT_ALPHA_TEXTURE_UNIT :number
Default texture unit for alpha map.
Type:
- number
(constant) DEFAULT_AMBIENT_COLOR :Float32Array
Default ambient color for materials.
Type:
- Float32Array
- Source:
(constant) DEFAULT_AMBIENT_COLOR :Float32Array
Default ambient color.
Type:
- Float32Array
(constant) DEFAULT_AMBIENT_STRENGTH :number
Default ambient strength for MTL materials.
Type:
- number
(constant) DEFAULT_AMBIENT_STRENGTH :number
Default ambient term strength.
Type:
- number
(constant) DEFAULT_AMBIENT_TEXTURE_UNIT :number
Default texture unit for ambient map.
Type:
- number
(constant) DEFAULT_ASPECT_RATIO :number
Default viewport aspect ratio.
Type:
- number
- Source:
(constant) DEFAULT_ASPECT_RATIO :number
Default viewport aspect ratio.
Type:
- number
- Source:
(constant) DEFAULT_AZIMUTH_RADIANS :number
Default camera azimuth (yaw) in radians.
Type:
- number
- Source:
(constant) DEFAULT_AZIMUTH_RADIANS :number
Default azimuth (yaw) angle in radians.
Type:
- number
- Source:
(constant) DEFAULT_BASE_SEGMENT_COUNT :number
Default segment count for base edges.
Type:
- number
- Source:
(constant) DEFAULT_BASE_URL :string
Default base URL, used for resolving relative assets.
Type:
- string
- Source:
(constant) DEFAULT_BOBBING_AMPLITUDE_RUN :number
Default running bobbing height.
Type:
- number
- Source:
(constant) DEFAULT_BOBBING_AMPLITUDE_WALK :number
Default walking bobbing height.
Type:
- number
- Source:
(constant) DEFAULT_BOBBING_FREQUENCY_RUN :number
Default running bobbing speed (radians per second).
Type:
- number
- Source:
(constant) DEFAULT_BOBBING_FREQUENCY_WALK :number
Default walking bobbing speed (radians per second).
Type:
- number
- Source:
(constant) DEFAULT_BOBBING_PITCH_AMPLITUDE_RADIANS :number
Default bobbing pitch amplitude in radians.
Type:
- number
- Source:
(constant) DEFAULT_BOX_SIZE :number
Default box size used by `Engine.createBoxMesh()`.
Used when `createBoxMesh options.size` is not provided.
Type:
- number
- Source:
(constant) DEFAULT_BOX_SIZE :number
Default box edge size.
Type:
- number
- Source:
(constant) DEFAULT_BUMP_MULTIPLIER :number
Default bump multiplier value.
Type:
- number
- Source:
(constant) DEFAULT_BUMP_MULTIPLIER :number
Default bump multiplier.
Type:
- number
(constant) DEFAULT_BUMP_TEXTURE_UNIT :number
Default texture unit for bump map.
Type:
- number
(constant) DEFAULT_CAMERA_ROLL_RADIANS :number
Default camera roll in radians.
Type:
- number
- Source:
(constant) DEFAULT_CAMERA_ROLL_RADIANS :number
Default roll (Z rotation).
Type:
- number
- Source:
(constant) DEFAULT_CAMERA_ROLL_RADIANS :number
Default camera roll in radians.
Type:
- number
- Source:
(constant) DEFAULT_CAP_TYPE :string
Default cap type.
Type:
- string
- Source:
(constant) DEFAULT_CLOSED :boolean
Default closed flag.
Type:
- boolean
- Source:
(constant) DEFAULT_CLOSED :boolean
Default closed flag for Catmull-Rom curve.
Type:
- boolean
- Source:
(constant) DEFAULT_COLOR :Float32Array
Default diffuse/base color (RGB).
Type:
- Float32Array
(constant) DEFAULT_COLOR :Float32Array
Default color for points.
Type:
- Float32Array
- Source:
(constant) DEFAULT_COLOR :Float32Array
Default solid color (white).
Type:
- Float32Array
- Source:
(constant) DEFAULT_COLORS :null
Default colors input value. When used, no color buffer is created.
Type:
- null
- Source:
(constant) DEFAULT_COLORS :null
Default colors option value.
Type:
- null
- Source:
(constant) DEFAULT_COLORS :null
Default colors option value.
Type:
- null
- Source:
(constant) DEFAULT_CONE_HEIGHT :number
Default cone height along Y.
Type:
- number
- Source:
(constant) DEFAULT_CONE_WIDTH :number
Default cone base diameter along X.
Type:
- number
- Source:
(constant) DEFAULT_CONTROLS_NAME :string
Default controls class name.
Type:
- string
- Source:
(constant) DEFAULT_CONTROLS_NAME :string
Default controls class name.
Type:
- string
- Source:
(constant) DEFAULT_DEVICE_PIXEL_RATIO :number
Fallback device pixel ratio used when window.devicePixelRatio is not set.
Type:
- number
- Source:
(constant) DEFAULT_DIFFUSE_COLOR :Float32Array
Default diffuse color for materials (white).
Type:
- Float32Array
- Source:
(constant) DEFAULT_DIFFUSE_COLOR :Float32Array
Default diffuse color for materials (white color).
Type:
- Float32Array
(constant) DEFAULT_DIFFUSE_COLOR :Float32Array
Default diffuse color for materials (white).
Type:
- Float32Array
- Source:
(constant) DEFAULT_DIFFUSE_COLOR :Float32Array
Default diffuse color.
Type:
- Float32Array
(constant) DEFAULT_DIFFUSE_TEXTURE_UNIT :number
Default texture unit for diffuse map.
Type:
- number
(constant) DEFAULT_DIRECTION :Float32Array
Default light direction (world space).
Matches the engine's historical default.
Type:
- Float32Array
- Source:
(constant) DEFAULT_DIRECTIONAL_STRENGTH :number
Default directional light strength.
Type:
- number
- Source:
(constant) DEFAULT_DIRECTIONAL_STRENGTH :number
Default directional strength.
Type:
- number
(constant) DEFAULT_DISPLACEMENT_SCALE :number
Default displacement scale factor.
Type:
- number
(constant) DEFAULT_DISPLACEMENT_TEXTURE_UNIT :number
Default texture unit for displacement map.
Type:
- number
(constant) DEFAULT_DISTANCE :number
Default orbit distance from the target.
Type:
- number
- Source:
(constant) DEFAULT_DISTANCE :number
Default camera follow distance.
Type:
- number
- Source:
(constant) DEFAULT_EMISSIVE_COLOR :Float32Array
Default emissive color for materials.
Type:
- Float32Array
- Source:
(constant) DEFAULT_EMISSIVE_COLOR :Float32Array
Default emissive color.
Type:
- Float32Array
(constant) DEFAULT_ENABLED :boolean
Default enabled state for lights.
Type:
- boolean
- Source:
(constant) DEFAULT_EPSILON :number
Default epsilon for approximate comparisons.
Type:
- number
- Source:
(constant) DEFAULT_EXPECTED_PER_VERTEX_COLOR_LENGTH :number
Default value, that indicates auto-detect expected per-vertex color length.
Type:
- number
- Source:
(constant) DEFAULT_EYE_HEIGHT :number
Default eye height above the target for first-person camera.
Type:
- number
- Source:
(constant) DEFAULT_FAR :number
Default far clipping plane distance.
Used when `EngineOptions.far` is not provided.
Type:
- number
- Source:
(constant) DEFAULT_FAR :number
Default far clipping plane distance.
Type:
- number
- Source:
(constant) DEFAULT_FAR :number
Default far clipping plane distance.
Type:
- number
- Source:
(constant) DEFAULT_FIELD_OF_VIEW_DIVISOR :number
Default camera field of view divisor used for computing FOV in radians.
Type:
- number
- Source:
(constant) DEFAULT_FIELD_OF_VIEW_DIVISOR :number
Default camera field of view divisor used for computing FOV in radians.
Type:
- number
- Source:
(constant) DEFAULT_FIELD_OF_VIEW_RADIANS :number
Default camera vertical field of view, in radians.
Used when `EngineOptions.fieldOfViewRadians` is not provided.
Type:
- number
- Source:
(constant) DEFAULT_FIELD_OF_VIEW_RADIANS :number
Default camera field of view in radians.
Type:
- number
- Source:
(constant) DEFAULT_FIELD_OF_VIEW_RADIANS :number
Default camera field of view in radians.
Type:
- number
- Source:
(constant) DEFAULT_FILTER :null
Default filter value.
Type:
- null
- Source:
(constant) DEFAULT_FIRST_PERSON_MAX_POLAR_RADIANS :number
Default maximum pitch angle in radians for first-person view.
Type:
- number
- Source:
(constant) DEFAULT_FIRST_PERSON_MIN_POLAR_RADIANS :number
Default minimum pitch angle in radians for first-person view.
Type:
- number
- Source:
(constant) DEFAULT_FIRST_PERSON_POLAR_RADIANS :number
Default camera polar (pitch) in radians for first-person view.
Type:
- number
- Source:
(constant) DEFAULT_FLIP_Y :boolean
Default vertical flip for heightmap sampling.
Type:
- boolean
- Source:
(constant) DEFAULT_FLIP_Y :boolean
Default value for the `flipY` option.
When true, uploaded images are flipped vertically during upload via `UNPACK_FLIP_Y_WEBGL`.
Type:
- boolean
- Source:
(constant) DEFAULT_GOOD_FPS_THRESHOLD :number
Default FPS threshold considered `good`.
Type:
- number
- Source:
(constant) DEFAULT_GRAVITY_ACCELERATION :number
Default gravity acceleration magnitude (positive value).
Type:
- number
- Source:
(constant) DEFAULT_GROUND_Y :number
Default ground Y position for movement and jumping.
Type:
- number
- Source:
(constant) DEFAULT_GROUP_NAME :string
Default group name used, when OBJ has no `g` statement.
Type:
- string
- Source:
(constant) DEFAULT_HEIGHTMAP_DEPTH :number
Default heightmap geometry depth along the Z axis.
Type:
- number
- Source:
(constant) DEFAULT_HEIGHTMAP_WIDTH :number
Default heightmap geometry width along the X axis.
Type:
- number
- Source:
(constant) DEFAULT_HEIGHT_OFFSET :number
Default height offset applied to all vertices.
Type:
- number
- Source:
(constant) DEFAULT_HEIGHT_SCALE :number
Default height scale multiplier (amplitude).
Type:
- number
- Source:
(constant) DEFAULT_HEIGHT_SEGMENTS :number
Default height segment count.
Type:
- number
- Source:
(constant) DEFAULT_HEIGHT_SEGMENTS :number
Default latitudinal segment count.
Type:
- number
- Source:
(constant) DEFAULT_HEIGHT_SEGMENT_COUNT :number
Default segment count along side height.
Type:
- number
- Source:
(constant) DEFAULT_INITIAL_CAMERA_Z :number
Default initial camera position on the Z axis.
Used when `EngineOptions.initialCameraZ` is not provided.
Type:
- number
- Source:
(constant) DEFAULT_JUMP_SPEED :number
Default jump speed (vertical velocity).
Type:
- number
- Source:
(constant) DEFAULT_LABEL :string
Default label used by the counter header.
Type:
- string
- Source:
(constant) DEFAULT_LIGHTING_ENABLED :number
Default lighting enabled flag (float).
Type:
- number
(constant) DEFAULT_LIGHT_DIRECTION :Float32Array
Default directional light direction in world space (points from surface to light).
Type:
- Float32Array
(constant) DEFAULT_LOOP :boolean
Default loop option.
Type:
- boolean
- Source:
(constant) DEFAULT_LOOP :boolean
Default loop flag.
Type:
- boolean
- Source:
(constant) DEFAULT_MAJOR_DIAMETER :number
Default torus major diameter (center ring diameter without tube).
Type:
- number
- Source:
(constant) DEFAULT_MAP_CLAMP :boolean
Default clamp flag for the texture maps.
Type:
- boolean
- Source:
(constant) DEFAULT_MAP_OFFSET :Float32Array
Default offset for the texture map options.
Type:
- Float32Array
- Source:
(constant) DEFAULT_MAP_SCALE :Float32Array
Default scale for the texture map options.
Type:
- Float32Array
- Source:
(constant) DEFAULT_MATERIAL_NAME :string
Default material name used, when OBJ has no `usemtl` statement.
Type:
- string
- Source:
(constant) DEFAULT_MAX_DISTANCE :number
Default maximum orbit distance.
Type:
- number
- Source:
(constant) DEFAULT_MAX_POLAR_RADIANS :number
Default maximum pitch angle in radians.
Type:
- number
- Source:
(constant) DEFAULT_MAX_POLAR_RADIANS :number
Maximum allowed polar angle (pitch) in radians.
This avoids reaching `+/-` 90 degrees, where the controls become unstable.
Type:
- number
- Source:
(constant) DEFAULT_MIN_DISTANCE :number
Default minimum orbit distance.
Type:
- number
- Source:
(constant) DEFAULT_MIN_POLAR_RADIANS :number
Default minimum pitch angle in radians.
Type:
- number
- Source:
(constant) DEFAULT_MIN_POLAR_RADIANS :number
Minimum allowed polar angle (pitch) in radians.
This avoids reaching `+/- 90` degrees, where the controls become unstable.
Type:
- number
- Source:
(constant) DEFAULT_MIPMAP_POLICY :number
Default mipmap generation policy, used by `Texture2D`.
Type:
- number
- Source:
(constant) DEFAULT_MOVE_SPEED :number
Default walking speed in world units per second.
Type:
- number
- Source:
(constant) DEFAULT_NEAR :number
Default near clipping plane distance.
Used when `EngineOptions.near` is not provided.
Type:
- number
- Source:
(constant) DEFAULT_NEAR :number
Default near clipping plane distance.
Type:
- number
- Source:
(constant) DEFAULT_NEAR :number
Default near clipping plane distance.
Type:
- number
- Source:
(constant) DEFAULT_NORMAL :Array.<number>
Default normal vector used as placeholder.
Type:
- Array.<number>
(constant) DEFAULT_NORMALS :null
Default normals input value. When used, no normal buffer is created.
Type:
- null
- Source:
(constant) DEFAULT_OBJECT_NAME :string
Default object name used, when OBJ has no `o` statement.
Type:
- string
- Source:
(constant) DEFAULT_OK_FPS_THRESHOLD :number
Default FPS threshold considered `ok`.
Type:
- number
- Source:
(constant) DEFAULT_OPACITY :number
Default opacity for materials.
Type:
- number
- Source:
(constant) DEFAULT_OPACITY :number
Default opacity for materials.
Type:
- number
(constant) DEFAULT_OPACITY :number
Default opacity for materials.
Type:
- number
- Source:
(constant) DEFAULT_OPACITY :number
Default opacity value.
Type:
- number
- Source:
(constant) DEFAULT_OPTICAL_DENSITY :number
Default optical density value.
Type:
- number
(constant) DEFAULT_OPTICAL_DENSITY :number
Default optical density value.
Type:
- number
(constant) DEFAULT_OWNS_GEOMETRY :boolean
Default ownership flag for geometry.
When true, `Mesh.dispose()` disposes geometry.
Type:
- boolean
- Source:
(constant) DEFAULT_OWNS_MATERIAL :boolean
Default ownership flag for material.
When true, `Mesh.dispose()` disposes material.
Type:
- boolean
- Source:
(constant) DEFAULT_PLANE_HEIGHT :number
Default plane height.
Type:
- number
- Source:
(constant) DEFAULT_PLANE_WIDTH :number
Default plane width.
Type:
- number
- Source:
(constant) DEFAULT_POINT_SIZE :number
Default point size in pixels.
Type:
- number
- Source:
(constant) DEFAULT_POLAR_RADIANS :number
Default camera polar (pitch) in radians.
Type:
- number
- Source:
(constant) DEFAULT_POLAR_RADIANS :number
Default polar (pitch) angle in radians.
Type:
- number
- Source:
(constant) DEFAULT_POSITIONS :null
Default positions option value.
Type:
- null
- Source:
(constant) DEFAULT_PYRAMID_HEIGHT :number
Default pyramid height.
Type:
- number
- Source:
(constant) DEFAULT_PYRAMID_WIDTH :number
Default pyramid base width.
Type:
- number
- Source:
(constant) DEFAULT_RADIAL_SEGMENTS :number
Default radial segment count.
Type:
- number
- Source:
(constant) DEFAULT_RADIAL_SEGMENTS :number
Default radial segment count (tube segments).
Type:
- number
- Source:
(constant) DEFAULT_RADIAL_SEGMENTS :number
Default radial segments.
Type:
- number
- Source:
(constant) DEFAULT_RADIUS :number
Default radius for the tube line.
Type:
- number
- Source:
(constant) DEFAULT_RECURSIVE :boolean
Base value for boolean defaults.
Type:
- boolean
- Source:
(constant) DEFAULT_REFLECTION_TEXTURE_UNIT :number
Default texture unit for reflection map.
Type:
- number
(constant) DEFAULT_ROLL_RADIANS :number
Default roll angle (rotation around the Z axis).
Type:
- number
- Source:
(constant) DEFAULT_ROTATION_ENABLED :boolean
Default rotation enabled state.
Type:
- boolean
- Source:
(constant) DEFAULT_ROTATION_SPEED :number
Default rotation speed multiplier.
Type:
- number
- Source:
(constant) DEFAULT_ROTATION_SPEED :number
Default rotation speed multiplier.
Type:
- number
- Source:
(constant) DEFAULT_RUN_SPEED_MULTIPLIER :number
Default running speed multiplier.
Type:
- number
- Source:
(constant) DEFAULT_SAMPLE_SEGMENTS :number
Default segment count for curve sampling.
Type:
- number
- Source:
(constant) DEFAULT_SAMPLING :string
Default heightmap sampling mode.
Type:
- string
- Source:
(constant) DEFAULT_SEGMENTS_X :number
Default segment count along the X axis.
Type:
- number
- Source:
(constant) DEFAULT_SEGMENTS_Z :number
Default segment count along the Z axis.
Type:
- number
- Source:
(constant) DEFAULT_SEGMENT_COUNT :number
Default segment count for each box axis.
Type:
- number
- Source:
(constant) DEFAULT_SEGMENT_COUNT :number
Default segment count per axis.
Type:
- number
- Source:
(constant) DEFAULT_SHININESS :number
Default shininess, when `Ns` is missing.
Type:
- number
(constant) DEFAULT_SHININESS :number
Default shininess value.
Type:
- number
(constant) DEFAULT_SHININESS :number
Default shininess exponent.
Type:
- number
- Source:
(constant) DEFAULT_SHOW_FRAME_TIME :boolean
Default flag that enables frame time (ms) display.
Type:
- boolean
- Source:
(constant) DEFAULT_SMOOTHING_FACTOR :number
Default exponential smoothing factor.
Type:
- number
- Source:
(constant) DEFAULT_SMOOTHING_GROUP :number
Default smoothing group value for `s off`.
Type:
- number
- Source:
(constant) DEFAULT_SOLID_PRIMITIVE :string
Default solid primitive, used by geometry (triangles).
Type:
- string
- Source:
(constant) DEFAULT_SORT :boolean
Default sorting flag for raycast results.
Type:
- boolean
- Source:
(constant) DEFAULT_SPECULAR_COLOR :Float32Array
Default specular color for materials.
Type:
- Float32Array
- Source:
(constant) DEFAULT_SPECULAR_COLOR :Float32Array
Default specular color.
Type:
- Float32Array
(constant) DEFAULT_SPECULAR_COLOR :Float32Array
Default specular color (RGB).
Type:
- Float32Array
- Source:
(constant) DEFAULT_SPECULAR_STRENGTH :number
Default specular strength multiplier.
Type:
- number
(constant) DEFAULT_SPECULAR_STRENGTH :number
Default specular strength multiplier.
Type:
- number
(constant) DEFAULT_SPECULAR_STRENGTH :number
Default specular strength multiplier.
Type:
- number
- Source:
(constant) DEFAULT_SPECULAR_TEXTURE_UNIT :number
Default texture unit for specular map.
Type:
- number
(constant) DEFAULT_SPHERE_DEPTH :number
Default sphere depth (diameter along Z).
Type:
- number
- Source:
(constant) DEFAULT_SPHERE_HEIGHT :number
Default sphere height (diameter along Y).
Type:
- number
- Source:
(constant) DEFAULT_SPHERE_WIDTH :number
Default sphere width (diameter along X).
Type:
- number
- Source:
(constant) DEFAULT_STRENGTH :number
Default ambient strength.
Type:
- number
- Source:
(constant) DEFAULT_TARGET_HEIGHT :number
Default camera look-at height offset from the target.
Type:
- number
- Source:
(constant) DEFAULT_TARGET_X :number
Default target X component.
Type:
- number
- Source:
(constant) DEFAULT_TARGET_Y :number
Default target Y component.
Type:
- number
- Source:
(constant) DEFAULT_TARGET_Z :number
Default target Z component.
Type:
- number
- Source:
(constant) DEFAULT_TERRAIN_COLOR :Float32Array
Default terrain vertex color (green).
Type:
- Float32Array
- Source:
(constant) DEFAULT_TERRAIN_COLOR_BLUE :number
Default terrain color blue component.
Type:
- number
- Source:
(constant) DEFAULT_TERRAIN_COLOR_GREEN :number
Default terrain color green component.
Type:
- number
- Source:
(constant) DEFAULT_TERRAIN_COLOR_RED :number
Default terrain color red component.
Type:
- number
- Source:
(constant) DEFAULT_TEXTURE_UNIT_INDEX :number
Default texture unit index.
Type:
- number
(constant) DEFAULT_TEXTURE_UNIT_INDEX :number
Default texture unit index.
Type:
- number
- Source:
(constant) DEFAULT_TEXTURE_UNIT_INDEX :number
Default texture unit index used for binding the diffuse texture.
Type:
- number
- Source:
(constant) DEFAULT_TEXTURE_UNIT_INDEX :number
Default texture unit index used by `ShaderProgram.setTexture2D`.
Zero corresponds to `TEXTURE0`.
Type:
- number
- Source:
(constant) DEFAULT_TUBE_DIAMETER :number
Default torus tube diameter.
Type:
- number
- Source:
(constant) DEFAULT_TUBULAR_SEGMENTS :number
Default tubular segment count (around the ring).
Type:
- number
- Source:
(constant) DEFAULT_T_VALUE :number
When segments are positive, the divisor is never 0. This value is used as fallback.
Type:
- number
- Source:
(constant) DEFAULT_UPDATE_INTERVAL_MS :number
Default DOM update interval in milliseconds.
Type:
- number
- Source:
(constant) DEFAULT_USE_VERTEX_COLORS :boolean
Default vertex colors usage flag.
Type:
- boolean
- Source:
(constant) DEFAULT_UV :Array.<number>
Default UV coordinates, when missing in OBJ data.
Type:
- Array.<number>
(constant) DEFAULT_UVS :null
Default UV input value. When used, no UV buffer is created.
Type:
- null
- Source:
(constant) DEFAULT_UV_OFFSET :Float32Array
Default UV offset.
Type:
- Float32Array
(constant) DEFAULT_UV_SCALE :Float32Array
Default UV scale.
Type:
- Float32Array
(constant) DEFAULT_VERTEX_COLOR :Float32Array
Default vertex color used by geometry classes, when no explicit colors are provided.
Type:
- Float32Array
- Source:
(constant) DEFAULT_VERTEX_COLOR :Array.<number>
Default vertex color (white color).
Type:
- Array.<number>
- Source:
(constant) DEFAULT_VISIBLE :boolean
Default visibility state.
Type:
- boolean
- Source:
(constant) DEFAULT_VISIBLE :boolean
Default visibility state.
Type:
- boolean
- Source:
(constant) DEFAULT_WIDTH :null
Default tube width (when specified, overrides the radius).
Type:
- null
- Source:
(constant) DEFAULT_WIDTH_SEGMENTS :number
Default longitudinal segment count.
Type:
- number
- Source:
(constant) DEFAULT_WIREFRAME_INDICES :null
Default wireframe indices input value.
When used, wireframe indices are generated from solid indices.
Type:
- null
- Source:
(constant) DEFAULT_WIREFRAME_PRIMITIVE :string
Default wireframe primitive, used by geometry (lines).
Type:
- string
- Source:
(constant) DEFAULT_WIREFRAME_STATE :boolean
Default wireframe hint state.
Type:
- boolean
- Source:
(constant) DEFAULT_ZOOM_SPEED :number
Default zoom speed multiplier.
Type:
- number
- Source:
(constant) DEPTH_RANGE_NUMERATOR :number
Numerator used for inverse range computations, e.g. `1 / (near - far)`.
Kept as a named constant to make the matrix formulas explicit.
Type:
- number
- Source:
(constant) DEPTH_RANGE_NUMERATOR :number
Type:
- number
- Source:
(constant) DIFFUSE_MAP_UNIFORM_NAME :string
Diffuse map sampler uniform name.
Type:
- string
- Source:
(constant) DIFFUSE_TEXTURE_UNIFORM_NAME :string
Name of the `sampler2D` uniform in the shader.
Type:
- string
- Source:
(constant) DIFFUSE_UV_OFFSET_UNIFORM_NAME :string
Diffuse UV-offset uniform name.
Type:
- string
(constant) DIFFUSE_UV_SCALE_UNIFORM_NAME :string
Diffuse UV-scale uniform name.
Type:
- string
(constant) DIRECTIONAL_STRENGTH_DISABLED :number
Directional strength value used for disabling directional light.
Type:
- number
(constant) DIRECTIONAL_STRENGTH_UNIFORM_NAME :string
Directional strength uniform name.
Type:
- string
(constant) DISPLACEMENT_MAP_UNIFORM_NAME :string
Displacement map sampler uniform name.
Type:
- string
- Source:
(constant) DISPLACEMENT_SCALE_UNIFORM_NAME :string
Displacement scale uniform name.
Type:
- string
(constant) DISPLACEMENT_UV_OFFSET_UNIFORM_NAME :string
Displacement UV-offset uniform name.
Type:
- string
(constant) DISPLACEMENT_UV_SCALE_UNIFORM_NAME :string
Displacement UV-scale uniform name.
Type:
- string
(constant) DIV_TAG_NAME :string
DOM element tag name used by the counter.
Type:
- string
- Source:
(constant) DOT_SLASH_PREFIX :string
Prefix used for relative paths.
Type:
- string
- Source:
(constant) DOUBLE_SIZE_MULTIPLIER :number
Used in some UV computations.
Type:
- number
- Source:
(constant) EDGE_KEY_SEPARATOR :string
Separator used to build an undirected edge key string.
Type:
- string
- Source:
(constant) EMISSIVE_COLOR_UNIFORM_NAME :string
Emissive color uniform name.
Type:
- string
(constant) EMPTY_BOUND_COMPONENT :number
Default bounding box component value for empty geometry.
Type:
- number
- Source:
(constant) EMPTY_STRING :string
Empty string constant.
Type:
- string
(constant) EMPTY_STRING :string
Empty string constant.
Type:
- string
- Source:
(constant) EMPTY_STRING :string
Empty string constant.
Type:
- string
- Source:
(constant) EMPTY_STRING :string
Empty string constant.
Type:
- string
- Source:
(constant) EMPTY_STRING_LENGTH :number
Empty string length used for non-empty checks.
Type:
- number
- Source:
(constant) ENGINE_ANIMATION_FRAME_ID_RESET_VALUE :number
`requestAnimationFrame` id reset value.
Zero means - no frame scheduled.
Type:
- number
- Source:
(constant) ENGINE_TIME_SECONDS_RESET_VALUE :number
Engine time fields reset/uninitialized value (seconds).
Used as a sentinel to detect the first frame.
Type:
- number
- Source:
(constant) ENTRY_TYPE_LINE :string
Geometry entry type for lines.
Type:
- string
(constant) ENTRY_TYPE_LINE :string
Entry type for line geometry.
Type:
- string
(constant) ENTRY_TYPE_MESH :string
Geometry entry type for meshes.
Type:
- string
(constant) ENTRY_TYPE_MESH :string
Entry type for mesh geometry.
Type:
- string
(constant) ENTRY_TYPE_POINTS :string
Geometry entry type for points.
Type:
- string
(constant) ENTRY_TYPE_POINTS :string
Entry type for point geometry.
Type:
- string
(constant) ERROR_ABSTRACT_CONSTRUCTOR :string
Error message used, when instantiating Light directly.
Type:
- string
- Source:
(constant) ERROR_ASSET_URL_MAP_TYPE :string
Error message for invalid assetUrlMap.
Type:
- string
(constant) ERROR_AXIS_MESH_TYPE :string
Error message for invalid mesh values.
Type:
- string
- Source:
(constant) ERROR_AXIS_TYPE :string
Error message for invalid axis values.
Type:
- string
- Source:
(constant) ERROR_BASE_URL_TYPE :string
Error message for invalid baseUrl.
Type:
- string
(constant) ERROR_BOUNDING_BOX_MAX_TYPE :string
Error message for invalid bounding box maximum buffer.
Type:
- string
- Source:
(constant) ERROR_BOUNDING_BOX_MIN_TYPE :string
Error message for invalid bounding box minimum buffer.
Type:
- string
- Source:
(constant) ERROR_BOUNDING_BOX_POSITIONS_TYPE :string
Error message for invalid bounding box positions buffer.
Type:
- string
- Source:
(constant) ERROR_BUMP_MULTIPLIER_TYPE :string
Error message for invalid bump multiplier value.
Type:
- string
(constant) ERROR_CAMERA_TYPE :string
Error message: invalid camera.
Type:
- string
- Source:
(constant) ERROR_CANVAS_CONTEXT :string
Error message for missing 2D canvas context.
Type:
- string
- Source:
(constant) ERROR_CLAMP_OPTION_TYPE :string
Error message for invalid clamp option.
Type:
- string
(constant) ERROR_COLORS_BUFFER :string
Error message for invalid colors buffer.
Type:
- string
- Source:
(constant) ERROR_DEFAULT_COLOR_LENGTH :string
Error message for invalid default color length.
Type:
- string
(constant) ERROR_DEFAULT_COLOR_LENGTH :string
Error message for invalid default color length.
Type:
- string
(constant) ERROR_DEFAULT_COLOR_TYPE :string
Error message for invalid default color.
Type:
- string
(constant) ERROR_DEFAULT_COLOR_TYPE :string
Error message for invalid default color type.
Type:
- string
(constant) ERROR_DIRECTIONAL_ENABLED_TYPE :string
Error message for invalid directional enabled values.
Type:
- string
(constant) ERROR_DIRECTIONAL_STRENGTH_TYPE :string
Error message for invalid directional strength values.
Type:
- string
(constant) ERROR_DIRECTION_COMPONENTS :string
Error message for invalid direction component count.
Type:
- string
- Source:
(constant) ERROR_DIRECTION_COMPONENTS_FINITE :string
Error message for invalid direction component values.
Type:
- string
- Source:
(constant) ERROR_DIRECTION_LENGTH :string
Error message for invalid direction length.
Type:
- string
- Source:
(constant) ERROR_DIRECTION_TYPE :string
Error message for invalid direction type.
Type:
- string
- Source:
(constant) ERROR_DISPLACEMENT_SCALE_TYPE :string
Error message for invalid displacement scale value.
Type:
- string
(constant) ERROR_ENABLED_TYPE :string
Error message for invalid enabled flag.
Type:
- string
- Source:
(constant) ERROR_EXPECTS_CROSS_ORIGIN :string
Error message: invalid `crossOrigin` value for `loadFromUrl`.
Type:
- string
- Source:
(constant) ERROR_EXPECTS_FLIPY_BOOLEAN :string
Error message: invalid `flipY` option type.
Type:
- string
- Source:
(constant) ERROR_EXPECTS_LOAD_OPTIONS_OBJECT :string
Error message: invalid load options argument type for `loadFromUrl`.
Type:
- string
- Source:
(constant) ERROR_EXPECTS_MAG_FILTER_ENUM :string
Error message: invalid `magFilter` enum value.
Type:
- string
- Source:
(constant) ERROR_EXPECTS_MIN_FILTER_ENUM :string
Error message: invalid `minFilter` enum value.
Type:
- string
- Source:
(constant) ERROR_EXPECTS_MIPMAP_POLICY :string
Error message: invalid `mipmapPolicy` enum value.
Type:
- string
- Source:
(constant) ERROR_EXPECTS_OPTIONS_OBJECT :string
Error message: invalid options argument type (must be an object).
Type:
- string
- Source:
(constant) ERROR_EXPECTS_OPTIONS_OBJECT_SUFFIX :string
Error suffix for options object validation.
Type:
- string
(constant) ERROR_EXPECTS_SAMPLER_OPTIONS_OBJECT :string
Error message: invalid sampler options argument type for `setSamplerParams`.
Type:
- string
- Source:
(constant) ERROR_EXPECTS_TEXTURE_SUFFIX :string
Error suffix for texture type validation.
Type:
- string
(constant) ERROR_EXPECTS_TEXTURE_UNIT_INDEX :string
Error message: invalid texture unit index passed to `bind`.
Type:
- string
- Source:
(constant) ERROR_EXPECTS_TEXTURE_UNIT_INDEX_SUFFIX :string
Error suffix for texture unit index validation.
Type:
- string
(constant) ERROR_EXPECTS_URL_STRING :string
Error message: invalid URL argument passed to `loadFromUrl`.
Type:
- string
- Source:
(constant) ERROR_EXPECTS_VECTOR2_COMPONENTS_SUFFIX :string
Error suffix for vector2 component validation.
Type:
- string
(constant) ERROR_EXPECTS_VECTOR2_TYPE_SUFFIX :string
Error suffix for vector2 type validation.
Type:
- string
(constant) ERROR_EXPECTS_VECTOR3_COMPONENTS_SUFFIX :string
Error suffix for vector3 component validation.
Type:
- string
(constant) ERROR_EXPECTS_WEBGL2_CONTEXT :string
Error message: invalid WebGL2 rendering context argument.
Type:
- string
- Source:
(constant) ERROR_EXPECTS_WRAP_S_ENUM :string
Error message: invalid `wrapS` enum value.
Type:
- string
- Source:
(constant) ERROR_EXPECTS_WRAP_T_ENUM :string
Error message: invalid `wrapT` enum value.
Type:
- string
- Source:
(constant) ERROR_FAILED_CREATE_TEXTURE :string
Error message: WebGL failed to create a texture handle.
Type:
- string
- Source:
(constant) ERROR_FAILED_LOAD_IMAGE_PREFIX :string
Error message prefix used, when the image fails to load.
Type:
- string
- Source:
(constant) ERROR_FAILED_READ_MAX_TEXTURE_UNITS :string
Error message: failed to read `MAX_COMBINED_TEXTURE_IMAGE_UNITS` from WebGL context.
Type:
- string
- Source:
(constant) ERROR_FETCH_FAILED_PREFIX :string
Error message, when fetch fails.
Type:
- string
(constant) ERROR_FILES_BASE_URL_TYPE :string
Error message for invalid baseUrl in files loader.
Type:
- string
(constant) ERROR_FILES_TEXTURE_BASE_URL_TYPE :string
Error message for invalid textureBaseUrl in files loader.
Type:
- string
(constant) ERROR_FLIP_Y_VALUE :string
Error message for invalid flipY option.
Type:
- string
- Source:
(constant) ERROR_HEIGHTMAP_IMAGE_DATA :string
Error message for invalid heightmap image data.
Type:
- string
- Source:
(constant) ERROR_HEIGHT_OFFSET_VALUE :string
Error message for invalid height offset value.
Type:
- string
- Source:
(constant) ERROR_HEIGHT_SCALE_VALUE :string
Error message for invalid height scale value.
Type:
- string
- Source:
(constant) ERROR_HOVER_AXIS_TYPE :string
Error message for invalid hovered axis values.
Type:
- string
- Source:
(constant) ERROR_INSTANCE_DISPOSED :string
Error message: the texture instance is already disposed.
Type:
- string
- Source:
(constant) ERROR_INVALID_CAP_TYPE :string
Error message for invalid cap type.
Type:
- string
- Source:
(constant) ERROR_INVALID_PRIMITIVE :string
Error message used for invalid primitive options.
Type:
- string
- Source:
(constant) ERROR_LIGHTING_ENABLED_RANGE :string
Error message for invalid lighting enabled value range.
Type:
- string
(constant) ERROR_LIGHTING_ENABLED_TYPE :string
Error message for invalid lighting enabled value types.
Type:
- string
(constant) ERROR_LIGHT_TYPE :string
Error message for the invalid light.
Type:
- string
- Source:
(constant) ERROR_LOAD_IMAGE_PREFIX :string
Error message prefix for image load failures.
Type:
- string
- Source:
(constant) ERROR_LOAD_OPTIONS :string
Error message for invalid load options.
Type:
- string
- Source:
(constant) ERROR_LOAD_OPTIONS_TYPE :string
Error message for invalid load options object.
Type:
- string
(constant) ERROR_LOAD_URL :string
Error message for invalid load URL.
Type:
- string
- Source:
(constant) ERROR_MATERIAL_NAME_TYPE :string
Error message for invalid material name input.
Type:
- string
(constant) ERROR_MIPMAP_AUTO_POT_REQUIRED_FOR_MIPMAP_FILTER :string
Error message: mipmap min filter was explicitly requested, but mipmaps were not generated by the auto policy.
Type:
- string
- Source:
(constant) ERROR_MIPMAP_POLICY_CONFLICT :string
Error message: mipmap-minification filter cannot be, used with `MIPMAP_POLICY_NONE`.
Type:
- string
- Source:
(constant) ERROR_MISSING_POSITION_INDEX :string
Error message, when a face vertex is missing the position index.
Type:
- string
- Source:
(constant) ERROR_MOUSE_NDC_TYPE :string
Error message: invalid mouse ndc object.
Type:
- string
- Source:
(constant) ERROR_MTL_FILES_TYPE :string
Error message for invalid mtlFiles.
Type:
- string
(constant) ERROR_MTL_TEXT_TYPE :string
Error message for invalid MTL text input.
Type:
- string
- Source:
(constant) ERROR_MTL_URL_TYPE :string
Error message for invalid mtlUrl.
Type:
- string
(constant) ERROR_OBJ_FILE_TYPE :string
Error message for invalid objFile.
Type:
- string
(constant) ERROR_OBJ_TEXT_TYPE :string
Error message for invalid OBJ text input.
Type:
- string
- Source:
(constant) ERROR_OBJ_URL_TYPE :string
Error message for invalid objUrl.
Type:
- string
(constant) ERROR_OPTICAL_DENSITY_TYPE :string
Error message for invalid optical density value.
Type:
- string
(constant) ERROR_OPTIONS_OBJECT :string
Error message for invalid material options.
Type:
- string
(constant) ERROR_OPTIONS_PLAIN_OBJECT :string
Error message for invalid options object.
Type:
- string
- Source:
(constant) ERROR_OPTIONS_TYPE :string
Error message for invalid options object.
Type:
- string
- Source:
(constant) ERROR_OPTIONS_TYPE :string
Error message: invalid options object.
Type:
- string
- Source:
(constant) ERROR_OPTIONS_TYPE :string
Error message for invalid texture options.
Type:
- string
(constant) ERROR_OPTIONS_TYPE :string
Error message for invalid options.
Type:
- string
(constant) ERROR_OPTIONS_TYPE :string
Error message for invalid options object.
Type:
- string
(constant) ERROR_OPTION_FILTER_TYPE :string
Error message: invalid filter option.
Type:
- string
- Source:
(constant) ERROR_OPTION_RECURSIVE_TYPE :string
Error message: invalid recursive option.
Type:
- string
- Source:
(constant) ERROR_OPTION_SORT_TYPE :string
Error message: invalid sort option.
Type:
- string
- Source:
(constant) ERROR_OUTPUT_LIST_TYPE :string
Error message for invalid output list.
Type:
- string
(constant) ERROR_PARSED_DATA_TYPE :string
Error message for invalid parsed data.
Type:
- string
(constant) ERROR_ROTATION_ENABLED_TYPE :string
Error message for invalid rotation enabled values.
Type:
- string
- Source:
(constant) ERROR_SAMPLING_VALUE :string
Error message for invalid sampling option.
Type:
- string
- Source:
(constant) ERROR_SCENE_TYPE :string
Error message: invalid scene.
Type:
- string
- Source:
(constant) ERROR_SEGMENT_RANGE :string
Error message for segments below minimum.
Type:
- string
- Source:
(constant) ERROR_SEGMENT_VALUE :string
Error message for invalid segments option.
Type:
- string
- Source:
(constant) ERROR_SHININESS_TYPE :string
Error message for invalid shininess value.
Type:
- string
(constant) ERROR_SIZE_VALUES :string
Error message for invalid width/depth values.
Type:
- string
- Source:
(constant) ERROR_SPECULAR_ENABLED_TYPE :string
Error message for invalid specular enabled flag.
Type:
- string
(constant) ERROR_SPECULAR_STRENGTH_TYPE :string
Error message for invalid specular strength value.
Type:
- string
(constant) ERROR_STRENGTH_TYPE :string
Error message for invalid ambient strength.
Type:
- string
- Source:
(constant) ERROR_STRENGTH_TYPE :string
Error message for invalid strength values.
Type:
- string
- Source:
(constant) ERROR_TARGET_TYPE :string
Error message for invalid target object.
Type:
- string
- Source:
(constant) ERROR_TEXTURES_OUTPUT_TYPE :string
Error message for invalid textures output.
Type:
- string
(constant) ERROR_TEXTURE_BASE_URL_TYPE :string
Error message for invalid texture base URL.
Type:
- string
(constant) ERROR_TEXTURE_CACHE_TYPE :string
Error message for invalid texture cache.
Type:
- string
(constant) ERROR_TEXTURE_UNITS_LIMIT :string
Error message for insufficient texture units.
Type:
- string
(constant) ERROR_TEXTURE_UNIT_INDEX_OUT_OF_RANGE_PREFIX :string
Error message prefix: texture unit index is out of range for the current WebGL context.
Type:
- string
- Source:
(constant) ERROR_TEXTURE_UNIT_INDEX_TYPE :string
Error message for invalid texture unit index.
Type:
- string
(constant) ERROR_TEXTURE_UNIT_INDEX_TYPE :string
Error message for invalid texture unit index.
Type:
- string
(constant) ERROR_TEXTURE_URL_TYPE :string
Error message for invalid texture URL.
Type:
- string
(constant) ERROR_UNKNOWN_PRIMITIVE :string
Error message used, when geometry primitive is unknown.
Type:
- string
- Source:
(constant) ERROR_UNPROJECT_W_ZERO :string
Error message: invalid unproject W component.
Type:
- string
- Source:
(constant) ERROR_VISIBLE_TYPE :string
Error message for the invalid visibility values.
Type:
- string
- Source:
(constant) ERROR_VISIBLE_TYPE :string
Error message for invalid visibility values.
Type:
- string
- Source:
(constant) ERROR_WEBGL_CONTEXT :string
Error message for invalid WebGL context.
Type:
- string
- Source:
(constant) ERROR_WEBGL_CONTEXT_TYPE :string
Error message for the invalid WebGL2 context.
Type:
- string
- Source:
(constant) ERROR_WEBGL_CONTEXT_TYPE :string
Error message for invalid WebGL2 context.
Type:
- string
- Source:
(constant) ERROR_WEBGL_CONTEXT_TYPE :string
Error message for invalid WebGL context.
Type:
- string
(constant) ERROR_WEBGL_CONTEXT_TYPE :string
Error message for invalid WebGL context.
Type:
- string
(constant) ERROR_WEBGL_CONTEXT_TYPE :string
Error message for invalid WebGL context.
Type:
- string
(constant) ERROR_WEBGL_CONTEXT_TYPE :string
Error message for invalid WebGL context.
Type:
- string
(constant) ERROR_WIREFRAME_VALUE :string
Error message for invalid isWireframe option.
Type:
- string
- Source:
(constant) ERROR_WRAP_S_OPTION_TYPE :string
Error message for invalid wrapS option.
Type:
- string
(constant) ERROR_WRAP_T_OPTION_TYPE :string
Error message for invalid wrapT option.
Type:
- string
(constant) EVENT_CONTEXT_MENU :string
Context menu event type.
Type:
- string
- Source:
(constant) EVENT_KEYDOWN :string
Keyboard event type: `keydown`.
Type:
- string
- Source:
(constant) EVENT_KEYUP :string
Keyboard event type: `keyup`.
Type:
- string
- Source:
(constant) EVENT_POINTERDOWN :string
Pointer event type: `pointerdown`.
Type:
- string
- Source:
(constant) EVENT_POINTERMOVE :string
Pointer event type: `pointermove`.
Type:
- string
- Source:
(constant) EVENT_POINTERUP :string
Pointer event type: `pointerup`.
Type:
- string
- Source:
(constant) EVENT_WINDOW_BLUR :string
Window blur event type.
Type:
- string
- Source:
(constant) FACE_MIN_VERTEX_COUNT :number
Face requires at least the `3 vertices`.
Type:
- number
- Source:
(constant) FALLBACK_AXIS_X :number
Fallback axis X component used, when tangent is parallel to up axis.
Type:
- number
- Source:
(constant) FALLBACK_AXIS_Y :number
Fallback axis Y component used, when tangent is parallel to up axis.
Type:
- number
- Source:
(constant) FALLBACK_AXIS_Z :number
Fallback axis Z component used, when tangent is parallel to up axis.
Type:
- number
- Source:
(constant) FAN_FIRST_VERTEX_INDEX :number
Index, of the first face vertex in fan triangulation.
Type:
- number
- Source:
(constant) FINAL_MATRIX_UNIFORM_NAME :string
Name of the final transformation matrix uniform: `view projection * world`.
Type:
- string
(constant) FIRST_INDEX :number
Index used to reference the first element in arrays.
Type:
- number
- Source:
(constant) FIRST_INDEX :number
Index used to reference the first element in arrays.
Type:
- number
(constant) FIRST_INDEX :number
Index, used to reference the first element in arrays.
Type:
- number
(constant) FIRST_INDEX :number
Index, used to reference the first element in arrays.
Type:
- number
- Source:
(constant) FIRST_PERSON_CAMERA_MODES :Object
Enum-like dictionary of supported first-person camera modes.
Type:
- Object
- Source:
(constant) FIRST_PERSON_CAMERA_MODE_BOBBING :string
First-person camera mode - bobbing (walking sway).
Type:
- string
- Source:
(constant) FIRST_PERSON_CAMERA_MODE_NORMAL :string
First-person camera mode - normal (no bobbing).
Type:
- string
- Source:
(constant) FIRST_PERSON_CAMERA_MODE_SET :Set.<string>
Supported first-person camera mode values.
Type:
- Set.<string>
- Source:
(constant) FIRST_VERTEX_INDEX :number
First vertex index.
Type:
- number
- Source:
(constant) FIVE_VALUE :number
Five value used in math formulas.
Type:
- number
- Source:
(constant) FLOAT_FALSE :number
`Boolean as-float` value for false.
Type:
- number
(constant) FLOAT_FALSE :number
Boolean-as-float value for false.
Type:
- number
(constant) FLOAT_FALSE :number
Boolean-as-float value for false.
Type:
- number
- Source:
(constant) FLOAT_TRUE :number
`Boolean-as-float` value for true.
Type:
- number
(constant) FLOAT_TRUE :number
Boolean-as-float value for true.
Type:
- number
(constant) FLOAT_TRUE :number
Boolean-as-float value for true.
Type:
- number
- Source:
(constant) FOURTH_INDEX :number
Index used to reference the fourth element in arrays.
Type:
- number
- Source:
(constant) FOURTH_INDEX :number
Index, used to reference the fourth element in arrays.
Type:
- number
- Source:
(constant) FOUR_VALUE :number
Four value used in math formulas.
Type:
- number
- Source:
(constant) FPS_FALLBACK_VALUE :number
Fallback FPS returned by `FpsCounter#end`, when a value is not yet available.
Type:
- number
- Source:
(constant) FPS_ROW_LABEL :string
FPS row label.
Type:
- string
- Source:
(constant) FRAGMENT_SHADER_SOURCE :string
GLSL fragment shader source code.
Implements Lambert diffuse lighting: `ambient + diffuse`.
Type:
- string
- Source:
(constant) FRAGMENT_SHADER_SOURCE :string
GLSL fragment shader source code.
Type:
- string
(constant) FRAGMENT_SHADER_SOURCE :string
GLSL fragment shader source code.
Type:
- string
- Source:
(constant) FRAGMENT_SHADER_SOURCE :string
GLSL fragment shader source code.
Implements classic Phong lighting: `ambient + diffuse + specular`.
Type:
- string
- Source:
(constant) FRAGMENT_SHADER_SOURCE :string
GLSL fragment shader source code.
Type:
- string
- Source:
(constant) FRAGMENT_SHADER_SOURCE :string
GLSL fragment shader source code.
Type:
- string
- Source:
(constant) FRAGMENT_SHADER_SOURCE :string
GLSL fragment shader source code.
Type:
- string
- Source:
(constant) FRAGMENT_SHADER_SOURCE :string
Type:
- string
- Source:
(constant) FRAMES_INCREMENT :number
Frame count increment used for each recorded frame.
Type:
- number
- Source:
(constant) FRAME_TIME_DECIMAL_PLACES :number
Number of digits used by `Number#toFixed` to format frame time values.
Type:
- number
- Source:
(constant) FRAME_TIME_ROW_LABEL :string
Frame time row label (milliseconds).
Type:
- string
- Source:
(constant) HALF_FIELD_OF_VIEW_DIVISOR :number
Divisor used to compute half of a vertical field of view angle.
Required for `tan(fov / 2)`, when building a perspective projection matrix.
Type:
- number
- Source:
(constant) HALF_FIELD_OF_VIEW_DIVISOR :number
Type:
- number
- Source:
(constant) HALF_MULTIPLIER :number
Multiplier used to compute half of a value.
Type:
- number
- Source:
(constant) HALF_SIZE_DIVISOR :number
Divisor used to compute the half-size from the full size.
Type:
- number
- Source:
(constant) HALF_SIZE_DIVISOR :number
Divisor used to compute half sizes from full sizes.
Type:
- number
- Source:
(constant) HALF_SIZE_DIVISOR :number
Divisor used to compute half sizes.
Type:
- number
- Source:
(constant) HALF_SIZE_DIVISOR :number
Divisor used to compute radius from diameter.
Type:
- number
- Source:
(constant) HALF_SIZE_DIVISOR :number
Divisor used to compute radius from diameter.
Type:
- number
- Source:
(constant) HEADER_CLASS :string
Header CSS class.
Type:
- string
- Source:
(constant) HEIGHTMAP_SOURCE_IMAGE_DATA_FIELD :string
Field name for `HeightmapSource.imageData`.
Type:
- string
- Source:
(constant) HIDDEN_OPACITY :number
Opacity used, when the gizmo is hidden.
Type:
- number
- Source:
(constant) HIDDEN_OPACITY :number
Opacity used, when the gizmo is hidden.
Type:
- number
- Source:
(constant) HYPHEN_SEPARATOR :string
Hyphen separator sign.
Type:
- string
- Source:
(constant) IMAGE_CROSS_ORIGIN_ANON :string
Cross-origin mode for images used in canvas extraction.
Prevents the `tainted canvas` issues, when loading images from other origins
(requires server to send the proper CORS headers).
Type:
- string
- Source:
(constant) INDEX_BUFFER_OFFSET_BYTES :number
Byte offset passed to `webglRenderingContext.drawElements()` call.
Indices always start at the beginning of the currently bound index buffer.
Type:
- number
- Source:
(constant) INITIAL_ACCUMULATED_FRAME_TIME_MS :number
Initial accumulated time value.
Type:
- number
- Source:
(constant) INITIAL_CAMERA_ASPECT_RATIO :number
Initial camera aspect ratio used during `Engine` construction.
Real aspect ratio is updated on first render based on canvas size.
Type:
- number
- Source:
(constant) INITIAL_FRAMES_SINCE_LAST_UPDATE :number
Initial frame counter value.
Type:
- number
- Source:
(constant) INPUT_BACKWARD :number
Input vector component for backward motion.
Type:
- number
- Source:
(constant) INPUT_EPSILON :number
Non-zero epsilon used for normalization checks.
Type:
- number
- Source:
(constant) INPUT_FORWARD :number
Input vector component for forward motion.
Type:
- number
- Source:
(constant) INPUT_NONE :number
No movement input value.
Type:
- number
- Source:
(constant) INTERSECTION_DISTANCE_KEY :string
Intersection distance key.
Type:
- string
- Source:
(constant) INTERSECTION_OBJECT_KEY :string
Intersection object key.
Type:
- string
- Source:
(constant) INTERSECTION_POINT_KEY :string
Intersection point key.
Type:
- string
- Source:
(constant) INVERSE_DETERMINANT_NUMERATOR :number
Type:
- number
- Source:
(constant) INVERSE_DIRECTION_NUMERATOR :number
Inverse numerator used in direction inverse computations.
Type:
- number
- Source:
(constant) INVERSE_LENGTH_NUMERATOR :number
Numerator used for inverse length computations.
Type:
- number
- Source:
(constant) INVERSE_LENGTH_NUMERATOR :number
Numerator used when computing inverse vector length: `1 / sqrt(lengthSquared)`.
Type:
- number
(constant) KEY_CODES :Object
`KeyboardEvent.code` values used by the controls.
Type:
- Object
- Source:
(constant) KEY_VALUES :KeyValues
`KeyboardEvent.key` fallback values used by the controls.
Type:
- Source:
(constant) LIGHTING_ENABLED_THRESHOLD :number
Threshold used to interpret the lighting enabled uniform as a boolean.
Type:
- number
(constant) LIGHTING_ENABLED_THRESHOLD :number
Threshold used to interpret lighting enabled values in shaders.
Type:
- number
(constant) LIGHTING_ENABLED_UNIFORM_NAME :string
Lighting enabled uniform name.
Type:
- string
(constant) LIGHT_DIRECTION_UNIFORM_NAME :string
Directional light direction uniform name (world space).
Vector points from surface to the light (towards the light).
Type:
- string
(constant) LINE_BREAK_REGEX :RegExp
Regular expression used to split the MTL text into lines.
Type:
- RegExp
- Source:
(constant) LINE_BREAK_REGEX :RegExp
Regular expression used to split the OBJ text into the lines.
Type:
- RegExp
- Source:
(constant) LINE_INDEX_COMPONENT_COUNT :number
Number of indices, that form a single line segment.
Type:
- number
- Source:
(constant) LINE_MIN_VERTEX_COUNT :number
Minimum vertex count required for line geometry.
Type:
- number
(constant) LINE_MIN_VERTEX_COUNT :number
Line requires at least 2 vertices.
Type:
- number
- Source:
(constant) LINE_SPLIT_REGEX :RegExp
Regular expression used to split the MTL lines by whitespace.
Type:
- RegExp
- Source:
(constant) LINE_SPLIT_REGEX :RegExp
Regular expression used to split the OBJ lines by whitespace.
Type:
- RegExp
- Source:
(constant) LOOP_INCREMENT :number
Loop increment value.
Type:
- number
- Source:
(constant) LOOP_INCREMENT :number
Index increment for loops.
Type:
- number
(constant) LOOP_INCREMENT :number
Loop increment step.
Type:
- number
- Source:
(constant) LOOP_INDEX_INCREMENT :number
Index increment value for loops.
Type:
- number
- Source:
(constant) LOOP_START_INDEX :number
Start index for loops.
Type:
- number
- Source:
(constant) LOOP_START_INDEX :number
Loop start index.
Type:
- number
- Source:
(constant) LOOP_START_INDEX :number
Start index for the loop iterations.
Type:
- number
- Source:
(constant) MAP_FLOAT_TOKEN_REGEX :RegExp
Regular expression for validating numeric map tokens.
Type:
- RegExp
- Source:
(constant) MARKER_COLOR :Float32Array
Marker color (RGB).
Type:
- Float32Array
- Source:
(constant) MARKER_HALF_SIZE :number
Position marker half-length.
Type:
- number
- Source:
(constant) MATERIAL_APPLY_CAMERA_POSITION_PARAM_COUNT :number
`Material.apply()` parameter count when it expects:
finalMatrix, worldMatrix, worldInverseTransposeMatrix, cameraPosition.
Type:
- number
- Source:
(constant) MATERIAL_APPLY_WORLD_INVERSE_TRANSPOSE_PARAM_COUNT :number
`Material.apply()` parameter count, when it expects: finalMatrix, worldMatrix, worldInverseTransposeMatrix.
Type:
- number
- Source:
(constant) MATERIAL_APPLY_WORLD_MATRIX_PARAM_COUNT :number
`Material.apply()` parameter count, when it expects: finalMatrix, worldMatrix.
Type:
- number
- Source:
(constant) MATRIX_4x4_ELEMENT_COUNT :number
Element count for a 4x4 matrix stored in a flat array.
Used to validate and allocate `Float32Array(16)` buffers.
Type:
- number
- Source:
(constant) MATRIX_4x4_ELEMENT_COUNT :number
Type:
- number
- Source:
(constant) MATRIX_4x4_ELEMENT_COUNT :number
Element count for a 4x4 matrix stored in a flat array.
Used for allocating reusable `Float32Array(16)` buffers.
Type:
- number
- Source:
(constant) MATRIX_4x4_ELEMENT_COUNT :number
Element count for a 4x4 matrix stored in a flat array.
Type:
- number
- Source:
(constant) MATRIX_4x4_ELEMENT_COUNT :number
Element count for a 4x4 matrix stored in a flat array.
Type:
- number
- Source:
(constant) MATRIX_4x4_ELEMENT_COUNT :number
Type:
- number
- Source:
(constant) MATRIX_4x4_ELEMENT_COUNT :number
Element count for a 4x4 matrix stored in a flat array.
Type:
- number
- Source:
(constant) MATRIX_4x4_ELEMENT_COUNT :number
Element count for a 4x4 matrix stored in a flat array.
Type:
- number
- Source:
(constant) MATRIX_4x4_ELEMENT_COUNT :number
Element count for a 4x4 matrix stored in a flat array.
Type:
- number
- Source:
(constant) MATRIX_4x4_ELEMENT_COUNT :number
Number of elements in a 4x4 matrix.
Used to validate and upload `mat4` uniform values.
Type:
- number
- Source:
(constant) MATRIX_COLUMN_COUNT :number
Type:
- number
- Source:
(constant) MATRIX_INDEX_00 :number
Matrix element indices for the 4x4 matrices.
Type:
- number
- Source:
(constant) MATRIX_ROW_COUNT :number
Type:
- number
- Source:
(constant) MATRIX_STRIDE :number
Type:
- number
- Source:
(constant) MATRIX_UNIFORM_NAME :string
Name of the matrix uniform in the shader.
Type:
- string
- Source:
(constant) MATRIX_UNIFORM_NAME :string
Name of the matrix uniform in the shader.
Type:
- string
- Source:
(constant) MATRIX_UNIFORM_NAME :string
Name of the matrix uniform in the shader.
Type:
- string
- Source:
(constant) MATRIX_UNIFORM_NAME :string
Name of the matrix uniform in the shader.
Type:
- string
- Source:
(constant) MATRIX_UNIFORM_NAME :string
Name of the matrix uniform in the shader.
Type:
- string
- Source:
(constant) MAX_CHANNEL_VALUE :number
Maximum channel value for 8-bit color channels.
Type:
- number
- Source:
(constant) MAX_COLOR_COMPONENT :number
Maximum allowed value for an RGBA color component.
Used to validate clear color inputs in the range [0 -> 1].
Type:
- number
- Source:
(constant) MAX_DIRECTIONAL_STRENGTH :number
Maximum directional light strength.
Type:
- number
- Source:
(constant) MAX_LIGHTING_ENABLED :number
Maximum accepted lighting enabled value.
Type:
- number
(constant) MAX_NORMALIZED :number
Inclusive upper bound for a [0..1] range value.
Type:
- number
- Source:
(constant) MAX_OPACITY :number
Maximum allowed opacity value.
Type:
- number
- Source:
(constant) MAX_SHININESS :number
Maximum shininess value.
Type:
- number
(constant) MAX_TEXTURE_UNIT_OFFSET :number
Texture unit range offset for map slots.
Type:
- number
(constant) MAX_UINT16_INDEX_VALUE :number
Smallest vertex index that requires 32-bit element indices.
WebGL `UNSIGNED_SHORT` can address indices in range [0..65535].
Type:
- number
- Source:
(constant) MILLISECONDS_PER_SECOND :number
Amount of milliseconds in one second.
Type:
- number
- Source:
(constant) MILLISECONDS_TO_SECONDS :number
Converts milliseconds to seconds. Used to compute time values.
Type:
- number
- Source:
(constant) MINIMUM_ASPECT_RATIO :number
Minimum allowed aspect ratio for projection computations.
Type:
- number
- Source:
(constant) MINIMUM_ASPECT_RATIO :number
Minimum allowed aspect ratio.
Type:
- number
- Source:
(constant) MINIMUM_ASPECT_RATIO :number
Minimum allowed aspect ratio.
Type:
- number
- Source:
(constant) MINIMUM_ASPECT_RATIO :number
Minimum allowed aspect ratio.
Type:
- number
- Source:
(constant) MINIMUM_ASPECT_RATIO :number
Minimum allowed aspect ratio.
Type:
- number
- Source:
(constant) MINIMUM_NEAR_CLIP_DISTANCE :number
Minimum allowed near clipping plane distance.
Type:
- number
- Source:
(constant) MINIMUM_NEAR_CLIP_DISTANCE :number
Minimum allowed near clipping plane distance.
Type:
- number
- Source:
(constant) MINIMUM_NEAR_CLIP_DISTANCE :number
Minimum allowed near clipping plane distance.
Type:
- number
- Source:
(constant) MINIMUM_NEAR_CLIP_DISTANCE :number
Minimum allowed near clipping plane distance.
Type:
- number
- Source:
(constant) MINIMUM_NON_NEGATIVE_VALUE :number
Inclusive lower bound for non-negative values.
Type:
- number
- Source:
(constant) MINIMUM_POSITIVE_VALUE :number
Lower bound for positive-only checks (must be `> 0`).
Type:
- number
- Source:
(constant) MINIMUM_POSITIVE_VALUE :number
Lower bound for positive-only checks (must be `> 0`).
Type:
- number
- Source:
(constant) MINIMUM_VIEW_SIZE :number
Minimum allowed view size (height in world units).
Type:
- number
- Source:
(constant) MIN_BOX_SIZE :number
Minimal allowed box size for `Engine.createBoxMesh()`.
Type:
- number
- Source:
(constant) MIN_COLOR_COMPONENT :number
Minimum allowed value for an RGBA color component.
Used to validate clear color inputs in the range [0 -> 1].
Type:
- number
- Source:
(constant) MIN_CONTROL_POINT_COUNT :number
Minimum control point count for Catmull-Rom curve.
Type:
- number
- Source:
(constant) MIN_DENOMINATOR :number
A guard value used by divisions to avoid a zero denominator.
Type:
- number
- Source:
(constant) MIN_DIRECTIONAL_STRENGTH :number
Minimum directional light strength.
Type:
- number
- Source:
(constant) MIN_DIRECTION_LENGTH_SQUARED :number
Minimum allowed squared length for a direction vector.
Type:
- number
- Source:
(constant) MIN_DIRECTION_LENGTH_SQUARED :number
Minimum allowed squared length for a direction vector. Used to reject the zero-length direction.
Type:
- number
(constant) MIN_DRAWING_BUFFER_DIMENSION :number
Minimum drawing buffer size (in pixels) for `canvas.width/canvas.height`.
Used as a safeguard, when the canvas CSS size is 0.
Type:
- number
- Source:
(constant) MIN_EXCLUSIVE_NUMBER :number
Exclusive lower bound for numeric parameters.
Type:
- number
- Source:
(constant) MIN_HEIGHT_SEGMENT_COUNT :number
Minimum allowed height segment count.
Type:
- number
- Source:
(constant) MIN_HEIGHT_SEGMENT_COUNT :number
Minimum allowed latitudinal segment count.
Type:
- number
- Source:
(constant) MIN_INVERTIBLE_DETERMINANT_ABS :number
Type:
- number
- Source:
(constant) MIN_LIGHTING_ENABLED :number
Minimum accepted lighting enabled value.
Type:
- number
(constant) MIN_LINE_STRIP_INDEX_COUNT :number
Minimum index count for line strip/loop primitives.
Type:
- number
- Source:
(constant) MIN_NORMALIZED :number
Inclusive lower bound for a [0..1] range value.
Type:
- number
- Source:
(constant) MIN_NORMALIZE_LENGTH :number
Minimum length for safe normalization.
Type:
- number
- Source:
(constant) MIN_OPACITY :number
Minimum allowed opacity value.
Type:
- number
- Source:
(constant) MIN_POINT_COUNT :number
Minimum points count allowed.
Type:
- number
- Source:
(constant) MIN_POINT_COUNT :number
Minimum point count for a tube line.
Type:
- number
- Source:
(constant) MIN_POINT_COUNT :number
Minimum point count for a path.
Type:
- number
- Source:
(constant) MIN_POINT_SIZE :number
Minimum allowed point size.
Type:
- number
- Source:
(constant) MIN_POSITIVE_VALUE :number
Lower bound for positive-only numeric options.
Type:
- number
- Source:
(constant) MIN_POWER_OF_TWO_VALUE :number
Minimal allowed value for `power-of-two` checks.
Type:
- number
- Source:
(constant) MIN_RADIAL_SEGMENTS :number
Minimum radial segments for a tube.
Type:
- number
- Source:
(constant) MIN_RADIAL_SEGMENT_COUNT :number
Minimum allowed radial segment count.
Type:
- number
- Source:
(constant) MIN_REQUIRED_STRING_LENGTH :number
Minimal allowed string length for required input url, used in `loadFromUrl()` method.
Type:
- number
- Source:
(constant) MIN_REQUIRED_STRING_LENGTH :number
Minimal allowed string length for required input url, used in `loadFromUrl()` method.
Type:
- number
- Source:
(constant) MIN_SAMPLE_SEGMENTS :number
Minimum allowed segment count.
Type:
- number
- Source:
(constant) MIN_SEGMENT_COUNT :number
Minimum segment count supported by segmented geometries.
Type:
- number
- Source:
(constant) MIN_SEGMENT_COUNT :number
Minimum segment count supported by heightmap geometry.
Type:
- number
- Source:
(constant) MIN_SEGMENT_COUNT :number
Minimum segment count supported by segmented geometries.
Type:
- number
- Source:
(constant) MIN_SEGMENT_COUNT :number
Minimum segment count supported by segmented geometries.
Type:
- number
- Source:
(constant) MIN_SEGMENT_COUNT :number
Minimum segment count for torus grids.
Type:
- number
- Source:
(constant) MIN_SHININESS :number
Minimum shininess value.
Type:
- number
(constant) MIN_TEXTURE_UNIT_INDEX :number
Minimal allowed texture unit index.
Zero corresponds to `TEXTURE0`.
Type:
- number
- Source:
(constant) MIN_TEXTURE_UNIT_INDEX :number
Minimum allowed texture unit index.
Type:
- number
- Source:
(constant) MIN_TEXTURE_UNIT_INDEX :number
Minimum allowed texture unit index.
Type:
- number
- Source:
(constant) MIN_UPDATE_INTERVAL_MS :number
Minimum allowed update interval.
Type:
- number
- Source:
(constant) MIN_VERTEX_COUNT :number
Minimum vertex count.
Type:
- number
- Source:
(constant) MIN_VERTEX_COUNT :number
Minimum vertex count for a polyline.
Type:
- number
- Source:
(constant) MIN_WIDTH_SEGMENT_COUNT :number
Minimum allowed longitudinal segment count.
Type:
- number
- Source:
(constant) MIPMAP_POLICY_ALWAYS :number
Mipmap policy, always generate mipmaps after the successful upload.
Type:
- number
- Source:
(constant) MIPMAP_POLICY_AUTO :number
Mipmap policy, generate the mipmaps only, when the texture size is `power-of-two`.
Type:
- number
- Source:
(constant) MIPMAP_POLICY_NONE :number
Mipmap policy, never generate the mipmaps.
Type:
- number
- Source:
(constant) MODULO_ALIGNED_VALUE :number
Modulo result expected for correct component alignment.
Type:
- number
- Source:
(constant) MOUSE_NDC_X_KEY :string
Mouse NDC key: x.
Type:
- string
- Source:
(constant) MOUSE_NDC_Y_KEY :string
Mouse NDC key: y.
Type:
- string
- Source:
(constant) MTL_ALPHA_MAP_TOKEN :string
MTL token for alpha texture map.
Type:
- string
- Source:
(constant) MTL_AMBIENT_COLOR_TOKEN :string
MTL token for ambient color.
Type:
- string
- Source:
(constant) MTL_AMBIENT_MAP_TOKEN :string
MTL token for ambient texture map.
Type:
- string
- Source:
(constant) MTL_BUMP_MAP_ALT_TOKEN :string
Alternate MTL token for bump map.
Type:
- string
- Source:
(constant) MTL_BUMP_MAP_LOWER_TOKEN :string
Additional lowercase MTL token for the bump map.
Type:
- string
- Source:
(constant) MTL_BUMP_MAP_TOKEN :string
MTL token for bump map.
Type:
- string
- Source:
(constant) MTL_DIFFUSE_COLOR_TOKEN :string
MTL token for diffuse color.
Type:
- string
- Source:
(constant) MTL_DIFFUSE_MAP_TOKEN :string
MTL token for diffuse texture map.
Type:
- string
- Source:
(constant) MTL_DISPLACEMENT_MAP_TOKEN :string
MTL token for displacement map.
Type:
- string
- Source:
(constant) MTL_EMISSIVE_COLOR_TOKEN :string
MTL token for emissive color.
Type:
- string
- Source:
(constant) MTL_ILLUMINATION_MODEL_TOKEN :string
MTL token for illumination model.
Type:
- string
- Source:
(constant) MTL_MAP_BLEND_COMPONENTS :number
Count of components for the blend options.
Type:
- number
- Source:
(constant) MTL_MAP_IMFCHAN_COMPONENTS :number
Count of components for the image channel option.
Type:
- number
- Source:
(constant) MTL_MAP_MM_COMPONENTS :number
Count of components for the base/gain option.
Type:
- number
- Source:
(constant) MTL_MAP_OPTIONAL_VECTOR_COMPONENTS :number
Optional third component for scale/offset map options.
Type:
- number
- Source:
(constant) MTL_MAP_OPTION_BLENDU :string
MTL map option for the U-blending.
Type:
- string
- Source:
(constant) MTL_MAP_OPTION_BLENDV :string
MTL map option for the V-blending.
Type:
- string
- Source:
(constant) MTL_MAP_OPTION_BUMP_MULTIPLIER :string
MTL map option for bump multiplier.
Type:
- string
- Source:
(constant) MTL_MAP_OPTION_CLAMP :string
MTL map option for clamping.
Type:
- string
- Source:
(constant) MTL_MAP_OPTION_IMFCHAN :string
MTL map option for the image channel.
Type:
- string
- Source:
(constant) MTL_MAP_OPTION_MM :string
MTL map option for base and gain.
Type:
- string
- Source:
(constant) MTL_MAP_OPTION_OFFSET :string
MTL map option for offset.
Type:
- string
- Source:
(constant) MTL_MAP_OPTION_SCALE :string
MTL map option for scaling.
Type:
- string
- Source:
(constant) MTL_MAP_OPTION_TEXRES :string
MTL map option for the texture resolution.
Type:
- string
- Source:
(constant) MTL_MAP_OPTION_TYPE :string
MTL map option for the texture type.
Type:
- string
- Source:
(constant) MTL_MAP_SCALAR_COMPONENTS :number
Count of scalar components for map options like `-clamp` and `-bm`.
Type:
- number
- Source:
(constant) MTL_MAP_TEXRES_COMPONENTS :number
Count of components for the texture resolution option.
Type:
- number
- Source:
(constant) MTL_MAP_TYPE_COMPONENTS :number
Count of components for the type option.
Type:
- number
- Source:
(constant) MTL_MAP_UV_COMPONENTS :number
Count of vector components for scale/offset map options (UV only).
Type:
- number
- Source:
(constant) MTL_NEW_MATERIAL_TOKEN :string
MTL token for new material declaration.
Type:
- string
- Source:
(constant) MTL_OPACITY_TOKEN :string
MTL token for opacity.
Type:
- string
- Source:
(constant) MTL_OPTICAL_DENSITY_TOKEN :string
MTL token for optical density.
Type:
- string
- Source:
(constant) MTL_REFLECTION_MAP_TOKEN :string
MTL token for reflection map.
Type:
- string
- Source:
(constant) MTL_SPECULAR_COLOR_TOKEN :string
MTL token for specular color.
Type:
- string
- Source:
(constant) MTL_SPECULAR_EXPONENT_TOKEN :string
MTL token for specular exponent.
Type:
- string
- Source:
(constant) MTL_SPECULAR_MAP_TOKEN :string
MTL token for specular texture map.
Type:
- string
- Source:
(constant) MTL_TRANSPARENCY_TOKEN :string
MTL token for transparency.
Type:
- string
- Source:
(constant) MULTIPLE_SLASHES_REGEX :RegExp
Matches multiple consecutive slashes in a path.
Type:
- RegExp
- Source:
(constant) NDC_FAR :number
Maximum NDC value for the far plane.
Type:
- number
- Source:
(constant) NDC_NEAR :number
Minimum NDC value for the near plane.
Type:
- number
- Source:
(constant) NEGATIVE_ONE_VALUE :number
Common numeric constants.
Type:
- number
- Source:
(constant) NEXT_FACE_VERTEX_OFFSET :number
Offset to access the next vertex in a face.
Type:
- number
- Source:
(constant) NEXT_INDEX_OFFSET :number
Offset to move from an index to the next index in the same ring/row.
Type:
- number
- Source:
(constant) NEXT_VERTEX_OFFSET :number
Offset to move from a vertex to the next vertex in the same row.
Type:
- number
- Source:
(constant) NEXT_VERTEX_OFFSET :number
Offset to move from a vertex to the next vertex in the same row.
Type:
- number
- Source:
(constant) NEXT_VERTEX_OFFSET :number
Offset to move from a vertex to the next vertex in the same row.
Type:
- number
- Source:
(constant) NEXT_VERTEX_OFFSET :number
Offset to move from a vertex to the next vertex in the same row.
Type:
- number
- Source:
(constant) NEXT_VERTEX_OFFSET :number
Offset to move from a vertex to the next vertex in the same row.
Type:
- number
- Source:
(constant) NEXT_VERTEX_OFFSET :number
Offset to move from a vertex to the next vertex in the same row.
Type:
- number
- Source:
(constant) NON_NEGATIVE_MIN :number
A numeric constant used for clamping values to a non-negative range.
Type:
- number
- Source:
(constant) NORMALIZE_EPSILON :number
Small epsilon used for vector normalization.
Type:
- number
- Source:
(constant) NORMALIZE_EPSILON :number
Epsilon used for safe normalization.
Type:
- number
- Source:
(constant) NORMAL_ATTRIBUTE_LOCATION :number
Attribute location used by the normals.
Must match shader `layout(location = X)` declaration.
Type:
- number
- Source:
(constant) NORMAL_ATTRIBUTE_LOCATION :number
Attribute location used by `vec3` normal.
Must match geometry's `NORMAL_ATTRIBUTE_LOCATION`.
Type:
- number
(constant) NORMAL_ATTRIBUTE_LOCATION :number
Attribute location used by `vec3` normal.
Type:
- number
- Source:
(constant) NORMAL_COLOR_BIAS :number
Bias used to remap normal vector from [-1..1] into [0..1] range.
Type:
- number
- Source:
(constant) NORMAL_COLOR_SCALE :number
Scale factor used to remap normal vector from [-1..1] into [0..1] range.
Type:
- number
- Source:
(constant) NORMAL_COMPONENT_COUNT :number
Number of float components per vertex normal.
Type:
- number
- Source:
(constant) NORMAL_COMPONENT_COUNT :number
Number of components for normal vectors.
Type:
- number
(constant) NORMAL_COMPONENT_COUNT :number
Number of components for normal vectors.
Type:
- number
- Source:
(constant) NORMAL_X_ZERO :number
Plane-like normal components.
Type:
- number
- Source:
(constant) NORMAL_Y_DOWN :number
Down normal Y.
Type:
- number
- Source:
(constant) NORMAL_Y_UP :number
Up normal Y.
Type:
- number
- Source:
(constant) NORMAL_Z_ZERO :number
Plane-like normal components.
Type:
- number
- Source:
(constant) NOT_FOUND_INDEX :number
Index value used, when a substring search fails.
Type:
- number
- Source:
(constant) NOT_FOUND_INDEX :number
Index value used, when a substring search fails.
Type:
- number
(constant) NOT_FOUND_INDEX :number
Index value used, when a substring search fails.
Type:
- number
- Source:
(constant) OBJ_FACE_ATTRIBUTE_SEPARATOR :string
Separator, used between vertex attributes in face definitions.
Type:
- string
- Source:
(constant) OBJ_FACE_TOKEN :string
OBJ token for face definitions.
Type:
- string
- Source:
(constant) OBJ_GROUP_TOKEN :string
OBJ token for group declaration.
Type:
- string
- Source:
(constant) OBJ_INDEX_NOT_PROVIDED :number
Value indicating, that an OBJ index is not provided.
Type:
- number
(constant) OBJ_INDEX_NOT_PROVIDED :number
Value indicating, that an OBJ index is not provided.
Type:
- number
- Source:
(constant) OBJ_INDEX_OFFSET :number
Vertex index offset for OBJ.
Type:
- number
- Source:
(constant) OBJ_INDEX_ZERO :number
Value for zero indices (invalid in the OBJ indexing).
Type:
- number
- Source:
(constant) OBJ_LINE_TOKEN :string
OBJ token for line definitions.
Type:
- string
- Source:
(constant) OBJ_MATERIAL_LIB_TOKEN :string
OBJ token for material library reference.
Type:
- string
- Source:
(constant) OBJ_NORMAL_TOKEN :string
OBJ token for vertex normals.
Type:
- string
- Source:
(constant) OBJ_OBJECT_TOKEN :string
OBJ token for object declaration.
Type:
- string
- Source:
(constant) OBJ_POINT_TOKEN :string
OBJ token for point definitions.
Type:
- string
- Source:
(constant) OBJ_SMOOTHING_TOKEN :string
OBJ token for smoothing groups.
Type:
- string
- Source:
(constant) OBJ_TEXCOORD_TOKEN :string
OBJ token for texture coordinates.
Type:
- string
- Source:
(constant) OBJ_USE_MATERIAL_TOKEN :string
OBJ token for material assignment.
Type:
- string
- Source:
(constant) OBJ_VERTEX_TOKEN :string
OBJ token for vertex positions.
Type:
- string
- Source:
(constant) ONE_COMPONENT :number
One component value.
Type:
- number
- Source:
(constant) ONE_VALUE :number
Numeric one value used for comparisons.
Type:
- number
- Source:
(constant) ONE_VALUE :number
Common numeric constants.
Type:
- number
- Source:
(constant) ONE_VALUE :number
Numeric one used in inverse-length computation.
Type:
- number
- Source:
(constant) ONE_VALUE :number
One value.
Type:
- number
- Source:
(constant) ONE_VALUE :number
One value used in math formulas.
Type:
- number
- Source:
(constant) ONE_VALUE :number
One value constant.
Type:
- number
- Source:
(constant) ONE_VALUE :number
One value constant.
Type:
- number
- Source:
(constant) OPACITY_UNIFORM_NAME :string
Opacity uniform name.
Type:
- string
(constant) OPACITY_UNIFORM_NAME :string
Opacity uniform name.
Type:
- string
- Source:
(constant) OPACITY_UNIFORM_NAME :string
Name of opacity uniform.
Type:
- string
- Source:
(constant) OPACITY_UNIFORM_NAME :string
Opacity uniform name.
Type:
- string
- Source:
(constant) OPACITY_UNIFORM_NAME :string
Opacity uniform name.
Type:
- string
- Source:
(constant) OPACITY_UNIFORM_NAME :string
Opacity uniform name.
Type:
- string
- Source:
(constant) OPAQUE_OPACITY :number
Opacity value, that is considered fully opaque.
Type:
- number
- Source:
(constant) OPEN_CURVE_LAST_SEGMENT_OFFSET :number
Segment offset for the last segment in open curves.
Type:
- number
- Source:
(constant) OPTICAL_DENSITY_UNIFORM_NAME :string
Optical density uniform name.
Type:
- string
(constant) OPTION_FILTER_KEY :string
Raycast options key: filter.
Type:
- string
- Source:
(constant) OPTION_RECURSIVE_KEY :string
Raycast options key: recursive.
Type:
- string
- Source:
(constant) OPTION_SORT_KEY :string
Raycast options key: sort.
Type:
- string
- Source:
(constant) ORIGIN :number
Origin coordinate.
Type:
- number
- Source:
(constant) ORTHOGRAPHIC_SCALE_NUMERATOR :number
Multiplier used for orthographic projection scaling terms:
`2 / (right - left)` and `2 / (top - bottom)`.
Type:
- number
- Source:
(constant) OUTWARD_HINT_BACK :Array.<number>
Outward direction hints used to ensure side face normals point outside.
Type:
- Array.<number>
- Source:
(constant) OUTWARD_HINT_FRONT :Array.<number>
Outward direction hints used to ensure side face normals point outside.
Type:
- Array.<number>
- Source:
(constant) OUTWARD_HINT_LEFT :Array.<number>
Outward direction hints used to ensure side face normals point outside.
Type:
- Array.<number>
- Source:
(constant) OUTWARD_HINT_RIGHT :Array.<number>
Outward direction hints used to ensure side face normals point outside.
Type:
- Array.<number>
- Source:
(constant) PATH_SEPARATOR :string
Forward slash separator token.
Type:
- string
(constant) PATH_SEPARATOR :string
Path separator for URL detection and slicing.
Type:
- string
- Source:
(constant) PERSPECTIVE_W_COMPONENT_SCALE :number
Constant used for the perspective projection matrix `out[11]` term.
Type:
- number
- Source:
(constant) PERSPECTIVE_W_COMPONENT_SCALE :number
Type:
- number
- Source:
(constant) PERSPECTIVE_Z_RANGE_MULTIPLIER :number
Multiplier used in the perspective projection Z translation term:
`(2 * far * near) / (near - far)`.
Type:
- number
- Source:
(constant) PERSPECTIVE_Z_RANGE_MULTIPLIER :number
Type:
- number
- Source:
(constant) PICK_OPACITY :number
Opacity, used for pick volumes (always hidden).
Type:
- number
- Source:
(constant) PLACEHOLDER_PIXEL_RGBA :Uint8Array
Placeholder pixel color (magenta).
Type:
- Uint8Array
- Source:
(constant) PLACEHOLDER_TEXT :string
Placeholder text shown before the first measurement.
Type:
- string
- Source:
(constant) PLACEHOLDER_TEXTURE_HEIGHT :number
Default height of a placeholder texture (in pixels).
Type:
- number
- Source:
(constant) PLACEHOLDER_TEXTURE_WIDTH :number
Default width of a placeholder texture (in pixels).
Type:
- number
- Source:
(constant) PLANE_NORMAL_X :number
Plane normal components.
Type:
- number
- Source:
(constant) PLANE_NORMAL_Y :number
Plane normal components.
Type:
- number
- Source:
(constant) PLANE_NORMAL_Z :number
Plane normal components.
Type:
- number
- Source:
(constant) PLANE_Z_POSITION :number
Plane is on XY plane, so Z is constant.
Type:
- number
- Source:
(constant) POINTER_ID_RESET_VALUE :number
Pointer capture reset value.
Type:
- number
- Source:
(constant) POINTER_ID_RESET_VALUE :number
Pointer capture is used only for a single pointer at a time.
This value indicates that no pointer is currently captured.
Type:
- number
- Source:
(constant) POINT_COORD_CENTER :number
Point sprite UV center, used for round points.
Type:
- number
- Source:
(constant) POINT_COORD_RADIUS :number
Point sprite radius, used for round points.
Type:
- number
- Source:
(constant) POINT_SIZE_UNIFORM_NAME :string
Name of point size uniform.
Type:
- string
- Source:
(constant) POSITION_ATTRIBUTE_LOCATION :number
Attribute location used by vec3 position.
Must match shader `layout(location = X)` declaration.
Type:
- number
- Source:
(constant) POSITION_ATTRIBUTE_LOCATION :number
Attribute location used by `vec3` position.
Must match geometry's `POSITION_ATTRIBUTE_LOCATION`.
Type:
- number
(constant) POSITION_ATTRIBUTE_LOCATION :number
Attribute location used by `vec3` position.
Type:
- number
- Source:
(constant) POSITION_ATTRIBUTE_LOCATION :number
Attribute location used by `vec3` position.
Type:
- number
- Source:
(constant) POSITION_ATTRIBUTE_LOCATION :number
Attribute location used by vec3 position.
Type:
- number
- Source:
(constant) POSITION_ATTRIBUTE_LOCATION :number
Attribute location used by vec3 position.
Type:
- number
- Source:
(constant) POSITION_ATTRIBUTE_LOCATION :number
Attribute location used by `vec3` position.
Type:
- number
- Source:
(constant) POSITION_COMPONENT_COUNT :number
Number of position components per vertex.
Type:
- number
- Source:
(constant) POSITION_COMPONENT_COUNT :number
Number of float components per vertex position.
Type:
- number
- Source:
(constant) POSITION_COMPONENT_COUNT :number
Number of components per position.
Type:
- number
- Source:
(constant) POSITION_COMPONENT_COUNT :number
Number of components per position.
Type:
- number
- Source:
(constant) POSITION_COMPONENT_COUNT :number
Number of components per position.
Type:
- number
- Source:
(constant) POSITION_COMPONENT_COUNT :number
Number of components for position vectors.
Type:
- number
(constant) POSITION_COMPONENT_COUNT :number
Number of components for position vectors.
Type:
- number
- Source:
(constant) POSITION_START_INDEX :number
Starting index for vertex data traversal.
Type:
- number
- Source:
(constant) POSITION_W_COMPONENT :number
Position W component, used in vertex shader.
Type:
- number
- Source:
(constant) POSITION_X_OFFSET :number
Offset for the X component in a position triplet.
Type:
- number
- Source:
(constant) POSITION_X_OFFSET :number
Offset for X component in position triplet.
Type:
- number
- Source:
(constant) POSITION_X_OFFSET :number
Offset for X component in position triplet.
Type:
- number
- Source:
(constant) POSITION_X_OFFSET :number
Offset for X component in position triplet.
Type:
- number
- Source:
(constant) POSITION_Y_OFFSET :number
Offset for the Y component in a position triplet.
Type:
- number
- Source:
(constant) POSITION_Y_OFFSET :number
Offset for Y component in position triplet.
Type:
- number
- Source:
(constant) POSITION_Y_OFFSET :number
Offset for Y component in position triplet.
Type:
- number
- Source:
(constant) POSITION_Y_OFFSET :number
Offset for Y component in position triplet.
Type:
- number
- Source:
(constant) POSITION_Z_OFFSET :number
Offset for the Z component in a position triplet.
Type:
- number
- Source:
(constant) POSITION_Z_OFFSET :number
Offset for Z component in position triplet.
Type:
- number
- Source:
(constant) POSITION_Z_OFFSET :number
Offset for Z component in position triplet.
Type:
- number
- Source:
(constant) POSITION_Z_OFFSET :number
Offset for Z component in position triplet.
Type:
- number
- Source:
(constant) PRIMITIVE_LINES :string
Primitive type name of the independent line segments.
Type:
- string
- Source:
(constant) PRIMITIVE_LINE_LOOP :string
Primitive type name of the closed line loop.
Type:
- string
- Source:
(constant) PRIMITIVE_LINE_STRIP :string
Primitive type name of the connected line strip.
Type:
- string
- Source:
(constant) PRIMITIVE_POINTS :string
Primitive type name of the point sprites.
Type:
- string
- Source:
(constant) PRIMITIVE_TRIANGLES :string
Primitive type name of the triangle meshes.
Type:
- string
- Source:
(constant) PROJECTION_SCALE_NUMERATOR :number
Numerator used, when computing the perspective projection scale factor.
Kept as a named constant to make the math expression self-documenting.
Type:
- number
- Source:
(constant) PROJECTION_SCALE_NUMERATOR :number
Type:
- number
- Source:
(constant) QUOTE_TOKEN :string
Quote token for the wrapped names.
Type:
- string
(constant) QUOTE_TOKEN :string
Token, used to wrap quoted paths.
Type:
- string
- Source:
(constant) QUOTE_TOKEN :string
Token, used to wrap quoted paths.
Type:
- string
- Source:
(constant) QUOTE_TOKEN :string
Quote token for the wrapped names.
Type:
- string
- Source:
(constant) RANGE_MAX_INDEX :number
Range array index: max.
Type:
- number
- Source:
(constant) RANGE_MIN_INDEX :number
Range array index: min.
Type:
- number
- Source:
(constant) RAY_DIRECTION_EPSILON :number
Epsilon used for ray direction checks.
Type:
- number
- Source:
(constant) RAY_T_MAX_INIT :number
Maximum ray parameter initial value.
Type:
- number
- Source:
(constant) RAY_T_MIN :number
Minimum ray parameter value.
Type:
- number
- Source:
(constant) RED_CHANNEL_OFFSET :number
Red channel offset inside RGBA pixel data.
Type:
- number
- Source:
(constant) REFLECTION_MAP_UNIFORM_NAME :string
Reflection map sampler uniform name.
Type:
- string
- Source:
(constant) REFLECTION_UV_OFFSET_UNIFORM_NAME :string
Reflection UV-offset uniform name.
Type:
- string
(constant) REFLECTION_UV_SCALE_UNIFORM_NAME :string
Reflection UV-scale uniform name.
Type:
- string
(constant) ROOT_CLASS :string
Root element CSS class.
Type:
- string
- Source:
(constant) ROTATE_BUTTON :number
The mouse button id used for rotation.
Type:
- number
- Source:
(constant) ROTATE_POINTER_BUTTON :number
Primary pointer button id used for rotating the camera.
Type:
- number
- Source:
(constant) ROTATION_RADIANS_PER_PIXEL :number
Rotation change per pixel, in radians.
Type:
- number
- Source:
(constant) ROTATION_RADIANS_PER_PIXEL :number
Radial rotation change per pixel, in radians.
Type:
- number
- Source:
(constant) ROW_CLASS :string
Row CSS class.
Type:
- string
- Source:
(constant) ROW_LABEL_CLASS :string
Label CSS class.
Type:
- string
- Source:
(constant) ROW_VALUE_CLASS :string
Value CSS class.
Type:
- string
- Source:
(constant) SAMPLE_END_PARAMETER :number
End sample value.
Type:
- number
- Source:
(constant) SAMPLE_INDEX_INCREMENT :number
Step to increment the sample index.
Type:
- number
- Source:
(constant) SAMPLE_START_INDEX :number
Start value for the sampling loop.
Type:
- number
- Source:
(constant) SAMPLE_START_PARAMETER :number
First sample value.
Type:
- number
- Source:
(constant) SAMPLING_BILINEAR :string
Heightmap sampling mode: `bilinear`.
Type:
- string
- Source:
(constant) SAMPLING_NEAREST :string
Heightmap sampling mode: `nearest`.
Type:
- string
- Source:
(constant) SCALE_INVERSE_NUMERATOR :number
Numerator used to compute inverse scale components `(1 / scale)`.
Type:
- number
- Source:
(constant) SECOND_FALLBACK_AXIS_X :number
Secondary fallback axis X component.
Type:
- number
- Source:
(constant) SECOND_FALLBACK_AXIS_Y :number
Secondary fallback axis Y component.
Type:
- number
- Source:
(constant) SECOND_FALLBACK_AXIS_Z :number
Secondary fallback axis Z component.
Type:
- number
- Source:
(constant) SECOND_INDEX :number
Index used to reference the second element in arrays.
Type:
- number
(constant) SECOND_INDEX :number
Index used to reference the second element in arrays.
Type:
- number
- Source:
(constant) SECOND_INDEX :number
Index used to reference the second element in arrays.
Type:
- number
(constant) SECOND_INDEX :number
Index, used to reference the second element in arrays.
Type:
- number
(constant) SECOND_INDEX :number
Index used to reference the second element in arrays.
Type:
- number
(constant) SECOND_INDEX :number
Index, used to reference the second element in arrays.
Type:
- number
- Source:
(constant) SEGMENTS_X_OPTION_NAME :string
Option name for `segmentsX` in error messages.
Type:
- string
- Source:
(constant) SEGMENTS_Z_OPTION_NAME :string
Option name for `segmentsZ` in error messages.
Type:
- string
- Source:
(constant) SEGMENT_INDEX_INCREMENT :number
Segment index increment.
Type:
- number
- Source:
(constant) SEGMENT_START_INDEX :number
Start index for segment traversal.
Type:
- number
- Source:
(constant) SEQUENTIAL_INDEX_INCREMENT :number
Increment value for sequential indices.
Type:
- number
- Source:
(constant) SHININESS_UNIFORM_NAME :string
Shininess uniform name.
Type:
- string
(constant) SHININESS_UNIFORM_NAME :string
Shininess uniform name (specular exponent).
Type:
- string
- Source:
(constant) SINGLE_CHILD_REMOVE_COUNT :number
Type:
- number
- Source:
(constant) SMOOTHING_OFF_TOKEN :string
Token value, representing smoothing disabled.
Type:
- string
- Source:
(constant) SMOOTHING_ON_TOKEN :string
Token value, representing smoothing enabled.
Type:
- string
- Source:
(constant) SPACE_SEPARATOR :string
Space separator token.
Type:
- string
(constant) SPACE_SEPARATOR :string
Space separator, used to join the split-tokens back into the names.
Type:
- string
- Source:
(constant) SPACE_SEPARATOR :string
Space separator, used to join the split tokens back into the names.
Type:
- string
- Source:
(constant) SPECULAR_COLOR_UNIFORM_NAME :string
Specular color uniform name.
Type:
- string
(constant) SPECULAR_COLOR_UNIFORM_NAME :string
Specular color uniform name.
Type:
- string
- Source:
(constant) SPECULAR_ENABLED_UNIFORM_NAME :string
Specular enable uniform name.
Type:
- string
(constant) SPECULAR_MAP_UNIFORM_NAME :string
Specular map sampler uniform name.
Type:
- string
- Source:
(constant) SPECULAR_STRENGTH_UNIFORM_NAME :string
Specular strength uniform name.
Type:
- string
(constant) SPECULAR_STRENGTH_UNIFORM_NAME :string
Specular strength uniform name.
Type:
- string
- Source:
(constant) SPECULAR_UV_OFFSET_UNIFORM_NAME :string
Specular UV-offset uniform name.
Type:
- string
(constant) SPECULAR_UV_SCALE_UNIFORM_NAME :string
Specular UV-scale uniform name.
Type:
- string
(constant) SPEED_SCALE_DEFAULT :number
Default movement speed scale (no sprint).
Type:
- number
- Source:
(constant) STACK_EMPTY_LENGTH :number
Stack empty length, used for traversal loops.
Type:
- number
- Source:
(constant) STATE_CLASS_BAD :string
Root element state class used, when FPS is in the `bad` range.
Type:
- string
- Source:
(constant) STATE_CLASS_GOOD :string
Root element state class used, when FPS is in the `good` range.
Type:
- string
- Source:
(constant) STATE_CLASS_OK :string
Root element state class used, when FPS is in the `ok` range.
Type:
- string
- Source:
(constant) SUPPORTED_PRIMITIVES :Set.<string>
Supported primitive names.
Type:
- Set.<string>
- Source:
(constant) TANGENT_EPSILON :number
Small epsilon used for tangent normalization.
Type:
- number
- Source:
(constant) TEXTURE_BORDER_VALUE :number
WebGL expects the border parameter of `texImage2D` to be `0`.
Type:
- number
- Source:
(constant) TEXTURE_UNIT_ALPHA :number
Texture unit offset for alpha map.
Type:
- number
(constant) TEXTURE_UNIT_AMBIENT :number
Texture unit offset for ambient map.
Type:
- number
(constant) TEXTURE_UNIT_BUMP :number
Texture unit offset for bump map.
Type:
- number
(constant) TEXTURE_UNIT_DIFFUSE :number
Texture unit offset for diffuse map.
Type:
- number
(constant) TEXTURE_UNIT_DISPLACEMENT :number
Texture unit offset for displacement map.
Type:
- number
(constant) TEXTURE_UNIT_REFLECTION :number
Texture unit offset for reflection map.
Type:
- number
(constant) TEXTURE_UNIT_SPECULAR :number
Texture unit offset for specular map.
Type:
- number
(constant) THIRD_INDEX :number
Index used to reference the third element in arrays.
Type:
- number
- Source:
(constant) THIRD_INDEX :number
Index used to reference the third element in arrays.
Type:
- number
(constant) THIRD_INDEX :number
Index, used to reference the third element in arrays.
Type:
- number
(constant) THIRD_INDEX :number
Index, used to reference the third element in arrays.
Type:
- number
- Source:
(constant) THIRD_PERSON_CAMERA_MODES :Object
Enum-like dictionary of supported third-person camera modes.
Type:
- Object
- Source:
(constant) THIRD_PERSON_CAMERA_MODE_BOBBING :string
Third-person camera mode - bobbing (walking sway).
Type:
- string
- Source:
(constant) THIRD_PERSON_CAMERA_MODE_NORMAL :string
Third-person camera mode - normal (no bobbing).
Type:
- string
- Source:
(constant) THIRD_PERSON_CAMERA_MODE_SET :Set.<string>
Supported third-person camera mode values.
Type:
- Set.<string>
- Source:
(constant) THREE_VALUE :number
Three value used in math formulas.
Type:
- number
- Source:
(constant) TOUCH_ACTION_NONE :string
Touch action CSS value used to disable browser gestures.
Type:
- string
- Source:
(constant) TRIANGLE_INDEX_COMPONENT_COUNT :number
Number of indices, that form a single triangle.
Type:
- number
- Source:
(constant) TRIANGLE_INDEX_STRIDE :number
Indices per triangle (3 vertices).
Type:
- number
- Source:
(constant) TRIANGLE_INDEX_STRIDE :number
Indices per triangle (3 vertices).
Type:
- number
- Source:
(constant) TWO_PI :number
Constant for `2 * pi`.
Type:
- number
- Source:
(constant) TWO_PI :number
Constant for 2Ï€.
Type:
- number
- Source:
(constant) TWO_PI :number
Constant for `2 * pi`.
Type:
- number
- Source:
(constant) TWO_PI :number
Two PI constant.
Type:
- number
- Source:
(constant) TWO_VALUE :number
Two value.
Type:
- number
- Source:
(constant) TWO_VALUE :number
Two value used in math formulas.
Type:
- number
- Source:
(constant) TYPEOF_BOOLEAN :string
String literal for `typeof boolean` checks.
Type:
- string
- Source:
(constant) TYPEOF_BOOLEAN :string
String literal for `typeof` boolean checks.
Type:
- string
(constant) TYPEOF_BOOLEAN :string
String literal for `typeof boolean` checks.
Type:
- string
- Source:
(constant) TYPEOF_NUMBER :string
String literal for `typeof` number checks.
Type:
- string
(constant) TYPEOF_NUMBER :string
String literal for typeof checks (number).
Type:
- string
(constant) TYPEOF_NUMBER :string
String literal for `typeof number` checks.
Type:
- string
- Source:
(constant) TYPEOF_OBJECT :string
String literal for `typeof` object checks.
Type:
- string
(constant) TYPEOF_OBJECT :string
String literal for typeof checks (object).
Type:
- string
(constant) TYPEOF_OBJECT :string
String literal for typeof checks.
Type:
- string
(constant) TYPEOF_OBJECT :string
String literal for typeof checks (object).
Type:
- string
(constant) TYPEOF_OBJECT :string
String literal for `typeof object` checks.
Type:
- string
- Source:
(constant) TYPEOF_STRING :string
String literal for the `typeof` checks.
Type:
- string
(constant) TYPEOF_STRING :string
String literal for typeof checks.
Type:
- string
- Source:
(constant) TYPEOF_STRING :string
String literal for `typeof` checks.
Type:
- string
(constant) TYPEOF_STRING :string
String literal for typeof checks.
Type:
- string
(constant) TYPEOF_STRING :string
String literal for the typeof checks.
Type:
- string
- Source:
(constant) UNINITIALIZED_NUMBER :number
Indicates that the counter has not yet computed a value.
Type:
- number
- Source:
(constant) UNIT_COMPONENT :number
Type:
- number
- Source:
(constant) UP_AXIS_X :number
Up axis used for frame generation.
Type:
- number
- Source:
(constant) UP_AXIS_Y :number
Up axis used for frame generation.
Type:
- number
- Source:
(constant) UP_AXIS_Z :number
Up axis used for frame generation.
Type:
- number
- Source:
(constant) USE_ALPHA_MAP_UNIFORM_NAME :string
Alpha map usage uniform name.
Type:
- string
(constant) USE_AMBIENT_MAP_UNIFORM_NAME :string
Ambient map usage uniform name.
Type:
- string
(constant) USE_BUMP_MAP_UNIFORM_NAME :string
Bump map usage uniform name.
Type:
- string
(constant) USE_DIFFUSE_MAP_UNIFORM_NAME :string
Diffuse map usage uniform name.
Type:
- string
(constant) USE_DISPLACEMENT_MAP_UNIFORM_NAME :string
Displacement map usage uniform name.
Type:
- string
(constant) USE_REFLECTION_MAP_UNIFORM_NAME :string
Reflection map usage uniform name.
Type:
- string
(constant) USE_SPECULAR_MAP_UNIFORM_NAME :string
Specular map usage uniform name.
Type:
- string
(constant) USE_VERTEX_COLOR_UNIFORM_NAME :string
Name of the use vertex colors usage uniform.
Type:
- string
- Source:
(constant) UV_ATTRIBUTE_LOCATION :number
Attribute location used by the UV coordinates.
Must match shader `layout(location = X)` declaration.
Type:
- number
- Source:
(constant) UV_ATTRIBUTE_LOCATION :number
Attribute location used by `vec2` UV-coordinates.
Type:
- number
- Source:
(constant) UV_ATTRIBUTE_LOCATION :number
Attribute location used by vec2 UV coordinates.
Type:
- number
- Source:
(constant) UV_CENTER :number
UV center coordinate.
Type:
- number
- Source:
(constant) UV_COMPONENTS_2 :number
Number of float components per `vec2` (uv).
Type:
- number
- Source:
(constant) UV_COMPONENT_COUNT :number
Number of float components per UV coordinate.
Type:
- number
- Source:
(constant) UV_COMPONENT_COUNT :number
Number of components for UV vectors.
Type:
- number
(constant) UV_COMPONENT_COUNT :number
Number of components for UV vectors.
Type:
- number
- Source:
(constant) UV_V_FLIP_BASE :number
UV/V coordinate is flipped to keep (0, 0) at top-left.
Type:
- number
- Source:
(constant) UV_V_FLIP_BASE :number
UV/V coordinate is flipped to keep (0, 0) at top-left.
Type:
- number
- Source:
(constant) UV_V_FLIP_BASE :number
UV/V coordinate is flipped to keep (0, 0) at top-left.
Type:
- number
- Source:
(constant) UV_V_FLIP_BASE :number
UV/V coordinate is flipped to keep (0, 0) at top-left.
Type:
- number
- Source:
(constant) UV_V_FLIP_BASE :number
UV/V coordinate is flipped to keep (0, 0) at top-left.
Type:
- number
- Source:
(constant) UV_V_FLIP_BASE :number
UV/V coordinate is flipped to keep (0, 0) at top-left.
Type:
- number
- Source:
(constant) U_INDEX :number
U component index within `vec2`.
Type:
- number
- Source:
(constant) VEC2_COMPONENT_COUNT :number
Number of float components per `vec2` (uv).
Type:
- number
- Source:
(constant) VEC2_COMPONENT_COUNT :number
Number of float components per `vec2` (uv).
Type:
- number
- Source:
(constant) VEC2_COMPONENT_COUNT :number
Number of float components per `vec2` (uv).
Type:
- number
- Source:
(constant) VEC2_COMPONENT_COUNT :number
Number of float components per `vec2` (uv).
Type:
- number
- Source:
(constant) VEC3_COMPONENT_COUNT :number
Number of float components per `vec3` (position/normal).
Type:
- number
- Source:
(constant) VEC3_COMPONENT_COUNT :number
Number of float components per `vec3` (position/normal).
Type:
- number
- Source:
(constant) VEC3_COMPONENT_COUNT :number
Number of float components per `vec3` (position/normal).
Type:
- number
- Source:
(constant) VEC3_COMPONENT_COUNT :number
Number of float components per `vec3` (position/normal).
Type:
- number
- Source:
(constant) VEC3_COMPONENT_COUNT :number
Number of float components per `vec3` (position/normal).
Type:
- number
- Source:
(constant) VECTOR3_COMPONENT_COUNT :number
Number of components in a 3D vector.
Type:
- number
- Source:
(constant) VECTOR3_ELEMENT_COUNT :number
Number of components in a direction vector.
Type:
- number
- Source:
(constant) VECTOR3_ELEMENT_COUNT :number
Vector3 length (component count).
Type:
- number
(constant) VECTOR3_ELEMENT_COUNT :number
Element count for a 3D vector stored in a flat array (x, y, z).
Used for allocating reusable `Float32Array(3)` buffers (e.g. camera position).
Type:
- number
- Source:
(constant) VECTOR3_X_INDEX :number
Component index for X.
Type:
- number
- Source:
(constant) VECTOR3_Y_INDEX :number
Component index for Y.
Type:
- number
- Source:
(constant) VECTOR3_Z_INDEX :number
Component index for Z.
Type:
- number
- Source:
(constant) VECTOR_2_ELEMENT_COUNT :number
Number of elements in a 2-component vector.
Used to validate `vec2` uniform values.
Type:
- number
- Source:
(constant) VECTOR_3_ELEMENT_COUNT :number
Number of elements in a 3-component vector.
Used to validate `vec3` uniform values.
Type:
- number
- Source:
(constant) VECTOR_4_ELEMENT_COUNT :number
Number of elements in a 4-component vector.
Used to validate `vec4` uniform values.
Type:
- number
- Source:
(constant) VECTOR_COMPONENTS_3 :number
Number of float components per `vec3` (position/normal).
Type:
- number
- Source:
(constant) VECTOR_INDEX_X :number
Index for X component in arrays.
Type:
- number
- Source:
(constant) VECTOR_INDEX_Y :number
Index for Y component in arrays.
Type:
- number
- Source:
(constant) VECTOR_INDEX_Z :number
Index for Z component in arrays.
Type:
- number
- Source:
(constant) VECTOR_X_INDEX :number
Index of the X component in a vector.
Type:
- number
- Source:
(constant) VECTOR_Y_INDEX :number
Index of the Y component in a vector.
Type:
- number
- Source:
(constant) VECTOR_Z_INDEX :number
Index of the Z component in a vector.
Type:
- number
- Source:
(constant) VERTEX_COUNT_TO_MAX_INDEX_OFFSET :number
Index offset to convert a vertex count into the maximum index value.
For `vertexCount` vertices, max index is `vertexCount - 1`.
Type:
- number
- Source:
(constant) VERTEX_KEY_SEPARATOR :string
Separator for unique vertex keys.
Type:
- string
(constant) VERTEX_SHADER_SOURCE :string
GLSL vertex shader source code.
Requires:
- position attribute at location 0
- normal attribute at location 3
Type:
- string
- Source:
(constant) VERTEX_SHADER_SOURCE :string
GLSL vertex shader source code.
Type:
- string
(constant) VERTEX_SHADER_SOURCE :string
GLSL vertex shader source code.
Type:
- string
- Source:
(constant) VERTEX_SHADER_SOURCE :string
GLSL vertex shader source code.
Requires:
- position attribute at location 0
- normal attribute at location 3
Type:
- string
- Source:
(constant) VERTEX_SHADER_SOURCE :string
GLSL vertex shader source code.
Type:
- string
- Source:
(constant) VERTEX_SHADER_SOURCE :string
GLSL vertex shader source code.
Type:
- string
- Source:
(constant) VERTEX_SHADER_SOURCE :string
GLSL vertex shader source code.
Type:
- string
- Source:
(constant) VERTEX_SHADER_SOURCE :string
Type:
- string
- Source:
(constant) VERTICES_PER_SEGMENT_INCREMENT :number
Adds one vertex per grid intersection, so vertex count along an axis is `segments + 1`.
Type:
- number
- Source:
(constant) VERTICES_PER_SEGMENT_INCREMENT :number
Adds one vertex per grid intersection, so vertex count along an axis is `segments + 1`.
Type:
- number
- Source:
(constant) VERTICES_PER_SEGMENT_INCREMENT :number
Adds one vertex per grid intersection, so vertex count along an axis is `segments + 1`.
Type:
- number
- Source:
(constant) VERTICES_PER_SEGMENT_INCREMENT :number
Adds one vertex per grid intersection, so vertex count along an axis is `segments + 1`.
Type:
- number
- Source:
(constant) VERTICES_PER_SEGMENT_INCREMENT :number
Adds one vertex per grid intersection, so vertex count along an axis is `segments + 1`.
Type:
- number
- Source:
(constant) VERTICES_PER_SEGMENT_INCREMENT :number
Adds one vertex per grid intersection, so vertex count along an axis is `segments + 1`.
Type:
- number
- Source:
(constant) VERTICES_PER_SEGMENT_INCREMENT :number
Adds one vertex per grid intersection, so vertex count along an axis is `segments + 1`.
Type:
- number
- Source:
(constant) VIEWPORT_ORIGIN_X :number
X coordinate of the viewport origin.
Type:
- number
- Source:
(constant) VIEWPORT_ORIGIN_Y :number
Y coordinate of the viewport origin.
Type:
- number
- Source:
(constant) VISIBLE_OPACITY :number
Opacity used, when the gizmo is visible.
Type:
- number
- Source:
(constant) V_INDEX :number
V component index within `vec2`.
Type:
- number
- Source:
(constant) WARNING_KEY_SEPARATOR :string
Warning key separator.
Type:
- string
(constant) WARNING_MTL_AVAILABLE_END :string
Warning list end token for available materials.
Type:
- string
(constant) WARNING_MTL_AVAILABLE_LIMIT :number
Maximum number of available materials included in warnings.
Type:
- number
(constant) WARNING_MTL_AVAILABLE_PREFIX :string
Warning suffix prefix for available materials list.
Type:
- string
(constant) WARNING_MTL_AVAILABLE_SEPARATOR :string
Warning separator for available material names.
Type:
- string
(constant) WARNING_MTL_AVAILABLE_START :string
Warning list start token for available materials.
Type:
- string
(constant) WARNING_MTL_LOAD_FAILED_PREFIX :string
Warning prefix for failed MTL loads.
Type:
- string
(constant) WARNING_MTL_LOAD_FAILED_REASON_PREFIX :string
Warning prefix for failed MTL load reason.
Type:
- string
(constant) WARNING_MTL_LOAD_FAILED_UNKNOWN :string
Warning placeholder for unknown MTL load errors.
Type:
- string
(constant) WARNING_MTL_MATERIAL_NOT_FOUND_PREFIX :string
Warning prefix for missing MTL materials.
Type:
- string
(constant) WARNING_MTL_MISSING_DIFFUSE_BASE_PREFIX :string
Warning suffix prefix for texture base URL.
Type:
- string
(constant) WARNING_MTL_MISSING_DIFFUSE_PREFIX :string
Warning prefix for missing diffuse map URL.
Type:
- string
(constant) WEBGL2_CONTEXT_TYPE :string
String identifier passed to canvas.getContext to request a WebGL2 context.
Type:
- string
- Source:
(constant) WEBGL_FALSE_AS_INTEGER :number
Integer value, used to represent boolean false in WebGL `pixelStorei` calls.
Type:
- number
- Source:
(constant) WEBGL_TRUE_AS_INTEGER :number
Integer value, used to represent boolean true in WebGL `pixelStorei` calls.
Type:
- number
- Source:
(constant) WHEEL_DISTANCE_MULTIPLIER :number
Wheel delta multiplier that is applied to the orbit distance.
Type:
- number
- Source:
(constant) WHEEL_LISTENER_OPTIONS :Object
`wheel` event listener options.
Using `passive: false` allows calling `event.preventDefault()` to stop page scrolling.
Type:
- Object
- Source:
(constant) WHITESPACE_REGEX :RegExp
Whitespace regex for collapsing the repeated spaces.
Type:
- RegExp
(constant) WIDTH_TO_RADIUS_DIVISOR :number
Offset used to compute radius from width.
Type:
- number
- Source:
(constant) WORLD_INVERSE_TRANSPOSE_MATRIX_UNIFORM_NAME :string
Name of the world inverse transpose matrix uniform: `(world ^ -1) ^ T`.
Used to correctly transform normals into world space under non-uniform scale.
Type:
- string
(constant) WORLD_MATRIX_UNIFORM_NAME :string
Name of the world matrix uniform.
Used by materials, that require world-space position reconstruction in shaders.
Type:
- string
(constant) WORLD_Z_AXIS_X_INDEX :number
World matrix index for Z axis X component.
Type:
- number
- Source:
(constant) WORLD_Z_AXIS_Y_INDEX :number
World matrix index for Z axis Y component.
Type:
- number
- Source:
(constant) WORLD_Z_AXIS_Z_INDEX :number
World matrix index for Z axis Z component.
Type:
- number
- Source:
(constant) X_INDEX :number
X component index within `vec3`.
Type:
- number
- Source:
(constant) Y_INDEX :number
Y component index within `vec3`.
Type:
- number
- Source:
(constant) ZERO_COMPONENT :number
Zero component value.
Type:
- number
- Source:
(constant) ZERO_COMPONENT :number
Type:
- number
- Source:
(constant) ZERO_SEGMENT_COUNT :number
Sentinel segment count that would cause division by zero in normalization.
Type:
- number
- Source:
(constant) ZERO_VALUE :number
Zero value constant.
Type:
- number
- Source:
(constant) ZERO_VALUE :number
Zero value constant.
Type:
- number
- Source:
(constant) ZERO_VALUE :number
Used in comparisons (e.g. radius checks).
Type:
- number
- Source:
(constant) ZERO_VALUE :number
Zero value used for numeric comparisons.
Type:
- number
- Source:
(constant) ZERO_VALUE :number
Numeric zero value used for comparisons.
Type:
- number
- Source:
(constant) ZERO_VALUE :number
Common numeric constants.
Type:
- number
- Source:
(constant) ZERO_VALUE :number
Numeric zero used for comparisons and constants.
Type:
- number
- Source:
(constant) ZERO_VALUE :number
Default zero value.
Type:
- number
- Source:
(constant) ZERO_VALUE :number
Zero value used for numeric comparisons.
Type:
- number
- Source:
(constant) ZERO_VALUE :number
Zero value used for numeric comparisons.
Type:
- number
(constant) ZERO_VALUE :number
Zero value, used for the numeric comparisons.
Type:
- number
(constant) ZERO_VALUE :number
Zero value used for numeric comparisons.
Type:
- number
(constant) ZERO_VALUE :number
Zero value used for comparisons.
Type:
- number
(constant) ZERO_VALUE :number
Zero value constant.
Type:
- number
- Source:
(constant) ZERO_VALUE :number
Zero value constant.
Type:
- number
- Source:
(constant) ZERO_VALUE :number
Zero value constant.
Type:
- number
- Source:
(constant) ZERO_VERTEX_COUNT :number
Vertex count used, when an optional part is disabled.
Type:
- number
- Source:
(constant) Z_INDEX :number
Z component index within `vec3`.
Type:
- number
- Source:
Methods
createColorsFromSpec(vertexCount, colors, expectedPerVertexLengthopt) → {Float32Array}
Creates a per-vertex color buffer from a color specification.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
vertexCount |
number | Total vertex count. | ||
colors |
Float32Array | Color specification. | ||
expectedPerVertexLength |
number |
<optional> |
0 | Optional explicit expected per-vertex length. |
- Source:
Returns:
- Per-vertex RGB buffer.
- Type
- Float32Array
createEngine(canvas, optionsopt) → {Engine}
Factory function for `Engine`.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
canvas |
HTMLCanvasElement | Canvas used for rendering. | |
options |
EngineOptions |
<optional> |
Engine options. |
- Source:
Returns:
- Type
- Engine
createIndexArray(vertexCount, indices) → {Uint16Array|Uint32Array}
Chooses the smallest index array type, that can represent the given indices.
Parameters:
| Name | Type | Description |
|---|---|---|
vertexCount |
number | Total vertex count. |
indices |
Array.<number> | Index list. |
- Source:
Returns:
- Typed index array.
- Type
- Uint16Array | Uint32Array
createSequentialIndexArray(vertexCount) → {Uint16Array|Uint32Array}
Creates a sequential index buffer without the intermediate JS-arrays.
Parameters:
| Name | Type | Description |
|---|---|---|
vertexCount |
number | Total vertex count. |
- Source:
Throws:
-
-
When `vertexCount` is not a finite number.
- Type
- TypeError
-
-
-
When `vertexCount` is negative or non-integer.
- Type
- RangeError
-
Returns:
- Sequential index buffer.
- Type
- Uint16Array | Uint32Array
createWireframeIndicesFromSolidIndices(vertexCount, triangleIndices) → {Uint16Array|Uint32Array}
Creates a wireframe line index buffer from a solid triangle index buffer.
This method deduplicates shared edges to keep the line buffer compact.
Parameters:
| Name | Type | Description |
|---|---|---|
vertexCount |
number | Total vertex count. |
triangleIndices |
Uint16Array | Uint32Array | Solid triangle indices. |
- Source:
Returns:
- Wireframe line indices (2 indices per edge).
- Type
- Uint16Array | Uint32Array
resolvePrimitiveMode(renderingContext, primitive) → {number}
Maps engine primitive constants to the WebGL draw modes.
Parameters:
| Name | Type | Description |
|---|---|---|
renderingContext |
WebGL2RenderingContext | WebGL2 rendering context. |
primitive |
string | Geometry primitive name. |
- Source:
Returns:
- WebGL draw mode constant.
- Type
- number
Type Definitions
BoxFaceDefinition
Internal face grid definition for `BoxGeometry`.
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
axisU |
Array.<number> | U axis direction. |
axisV |
Array.<number> | V axis direction. |
normal |
Array.<number> | Face normal. |
fixed |
number | Fixed coordinate value for the remaining axis. |
sizeU |
number | Face size along U. |
sizeV |
number | Face size along V. |
segmentsU |
number | Segment count along U `>= 1`. |
segmentsV |
number | Segment count along V `>= 1`. |
- Source:
BoxGeometryData
Internal geometry buffers produced by `BoxGeometry`.
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
positions |
Float32Array | Vertex positions (xyz). |
normals |
Float32Array | Vertex normals (xyz). |
uvs |
Float32Array | Vertex UVs (uv). |
colors |
Float32Array | Vertex colors (rgb). |
indicesSolid |
Uint16Array | Uint32Array | Triangle index buffer. |
indicesWireframe |
Uint16Array | Uint32Array | Line index buffer for wireframe. |
- Source:
BoxGeometryOptions
Options used by `BoxGeometry` constructor.
`colors` supports:
- Uniform RGB (`length === 3`)
- Per-face RGB (`length === 18`)
- Per-vertex RGB (`length === vertexCount * 3`)
Segment parameters must be `integers >= 1`.
Type:
- Object
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
size |
number |
<optional> |
1.0 | Convenience cube size (applies to `width/height/depth`). |
width |
number |
<optional> |
size | Box width along the X axis. |
height |
number |
<optional> |
size | Box height along the Y axis. |
depth |
number |
<optional> |
size | Box depth along the Z axis. |
widthSegments |
number |
<optional> |
1 | Subdivisions along the X axis. |
heightSegments |
number |
<optional> |
1 | Subdivisions along the Y axis. |
depthSegments |
number |
<optional> |
1 | Subdivisions along the Z axis. |
colors |
Float32Array |
<optional> |
Color specification buffer. |
- Source:
CameraState
Derived camera state computed for the current frame.
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
azimuthRadians |
number | |
polarRadians |
number | |
bobbingOffset |
number | |
bobbingPitch |
number |
- Source:
CameraState
Derived camera state computed for the current frame.
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
azimuthRadians |
number | |
polarRadians |
number | |
bobbingOffset |
number | |
bobbingPitch |
number |
- Source:
CameraState
Derived camera state computed for the current frame.
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
azimuthRadians |
number | |
polarRadians |
number | |
bobbingOffset |
number | |
bobbingPitch |
number |
- Source:
ConeGeometryData
Internal geometry buffers produced by `ConeGeometry`.
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
positions |
Float32Array | Vertex positions (xyz). |
normals |
Float32Array | Vertex normals (xyz). |
uvs |
Float32Array | Vertex UVs (uv). |
colors |
Float32Array | Vertex colors (rgb). |
indicesSolid |
Uint16Array | Uint32Array | Triangle index buffer. |
indicesWireframe |
Uint16Array | Uint32Array | Line index buffer for wireframe. |
- Source:
ConeGeometryOptions
Cone geometry options.
`width` is the base diameter along X. `depth` (optional) is the base diameter along Z.
If `depth` is not provided, it defaults to `width` (circular base).
Segment parameters must be integers:
- `radialSegments >= 3`
- `heightSegments >= 1`
Type:
- Object
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
width |
number |
<optional> |
1.0 | Base diameter along X. |
height |
number |
<optional> |
1.5 | Cone height along Y. |
depth |
number |
<optional> |
width | Base diameter along Z. |
radialSegments |
number |
<optional> |
24 | Segments around the base. |
heightSegments |
number |
<optional> |
1 | Segments along height. |
capped |
boolean |
<optional> |
true | Whether to generate a bottom cap. |
colors |
Float32Array |
<optional> |
Color specification buffer. |
- Source:
CreateBoxMeshOptions
Options used by `Engine.createBoxMesh`.
Ownership rule: if `material` is provided by the user, created `Mesh` must NOT own it.
Type:
- Object
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
size |
number |
<optional> |
1.0 | Edge length of the box. |
material |
Material |
<optional> |
Optional material instance (shared). |
- Source:
CustomGeometryOptions
Options used by `CustomGeometry`.
Type:
- Object
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
positions |
Float32Array | Vertex positions (xyz). | ||
indices |
Array.<number> | Uint16Array | Uint32Array | Solid triangle indices. | ||
wireframeIndices |
Array.<number> | Uint16Array | Uint32Array | null |
<optional> |
null | Wireframe indices (lines). |
colors |
Float32Array | null |
<optional> |
null | Optional colors (rgb) per vertex or uniform spec. |
uvs |
Float32Array | null |
<optional> |
null | Optional UV coordinates (uv). |
normals |
Float32Array | null |
<optional> |
null | Optional normals (xyz). |
- Source:
DirectionalLightMaterialBaseOptions
Material base options used by `DirectionalLightMaterial`.
Type:
- Object
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
ownsShaderProgram |
boolean |
<optional> |
true | Whether this material owns and disposes the shader program. |
DirectionalLightMaterialOptions
Options common to directional-light materials.
Type:
- Object
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
color |
Float32Array | Array.<number> |
<optional> |
Diffuse RGB color [red, green, blue] in [0..1] range. |
lightDirection |
Float32Array | Array.<number> |
<optional> |
Directional light direction (world space), normalized internally. |
ambientStrength |
number |
<optional> |
Ambient term multiplier. |
directionalStrength |
number |
<optional> |
Directional light strength multiplier. |
lightingEnabled |
boolean | number |
<optional> |
Lighting enabled flag (boolean or 0..1 float). |
EngineFrameCallback(deltaTimeSeconds, timeSeconds, engine)
Per-frame callback invoked by `Engine.start`.
Parameters:
| Name | Type | Description |
|---|---|---|
deltaTimeSeconds |
number | Time passed since previous frame, in seconds. |
timeSeconds |
number | Time since engine start, in seconds. |
engine |
Engine | Current engine instance. |
- Source:
EngineOptions
Options used by `createEngine` and `Engine`.
Type:
- Object
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
fieldOfViewRadians |
number |
<optional> |
Math.PI / 4 | Vertical field of view in radians. |
near |
number |
<optional> |
0.1 | Near clipping plane. |
far |
number |
<optional> |
100.0 | Far clipping plane. |
initialCameraZ |
number |
<optional> |
5.0 | Initial camera position on the Z axis. |
fitToWindow |
boolean |
<optional> |
false | When true, the engine will render using `window.innerWidth/innerHeight` as the canvas size source. |
- Source:
FirstPersonCameraOptions
Options used by FirstPersonCamera.
Type:
- Object
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
fieldOfViewRadians |
number |
<optional> |
Math.PI / 4 | Vertical field of view in radians. |
aspectRatio |
number |
<optional> |
1.0 | Viewport aspect ratio (width / height). |
near |
number |
<optional> |
0.1 | Distance to the near clipping plane. |
far |
number |
<optional> |
200.0 | Distance to the far clipping plane. |
mode |
string |
<optional> |
'NORMAL' | Camera mode, see `FirstPersonCamera.Modes`. |
- Source:
FirstPersonControlsOptions
Options used by FirstPersonControls.
Type:
- Object
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
eyeHeight |
number |
<optional> |
1.6 | Eye height above the target. |
- Source:
FpsCounterOptions
Options used by `FpsCounter`.
Type:
- Object
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
label |
string |
<optional> |
'Performance' | Short title shown at the top of the panel. |
updateIntervalMs |
number |
<optional> |
250 | DOM refresh interval (ms). Values are computed every frame. |
smoothingFactor |
number |
<optional> |
0.15 | Exponential smoothing factor in [0..1]. |
showFrameTime |
boolean |
<optional> |
true | When true, also shows the average frame time in milliseconds. |
goodFpsThreshold |
number |
<optional> |
55 | FPS value that should be considered `good`. |
okFpsThreshold |
number |
<optional> |
30 | FPS value that should be considered `ok`. |
- Source:
GeometryPrimitiveOptions
Geometry primitive override options.
Type:
- Object
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
solidPrimitive |
string |
<optional> |
PRIMITIVE_TRIANGLES | Solid primitive type. |
wireframePrimitive |
string |
<optional> |
PRIMITIVE_LINES | Wireframe primitive type. |
- Source:
HeightmapGeometryData
Internal geometry buffers produced by `HeightmapGeometry`.
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
positions |
Float32Array | Vertex positions (xyz). |
normals |
Float32Array | Vertex normals (xyz). |
uvs |
Float32Array | Vertex UVs (uv). |
colors |
Float32Array | Vertex colors (rgb). |
indicesSolid |
Uint16Array | Uint32Array | Triangle index buffer. |
indicesWireframe |
Uint16Array | Uint32Array | Line index buffer for wireframe. |
- Source:
HeightmapGeometryOptions
Heightmap geometry options.
`colors` supports:
- uniform RGB (`length === 3`)
- per-vertex RGB (`length === vertexCount * 3`)
Segment parameters must be `integers >= 1`.
Type:
- Object
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
width |
number |
<optional> |
1.0 | Terrain width along the X axis. |
depth |
number |
<optional> |
1.0 | Terrain depth along the Z axis. |
heightScale |
number |
<optional> |
1.0 | Heightmap scale multiplier. |
heightOffset |
number |
<optional> |
0.0 | Heightmap offset along the Y axis. |
segmentsX |
number |
<optional> |
1 | Segment count along the X axis. |
segmentsZ |
number |
<optional> |
1 | Segment count along the Z axis. |
isWireframe |
boolean |
<optional> |
false | Wireframe hint for consumers. |
colors |
Float32Array |
<optional> |
Color specification buffer. | |
flipY |
boolean |
<optional> |
true | When true, flips heightmap sampling along the Y axis. |
sampling |
string |
<optional> |
'nearest' | Sampling mode: `nearest` or `bilinear`. |
- Source:
HeightmapSource
Heightmap source data.
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
imageData |
ImageData | Heightmap image data. |
- Source:
Intersection
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
object |
Mesh | Intersected mesh. |
distance |
number | Distance from ray origin to the intersection point. |
point |
RaycastPoint | Intersection point in world space. |
- Source:
KeyValues
`KeyboardEvent.key` fallback values used by the controls.
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
FORWARD |
string | Forward key value. |
BACKWARD |
string | Backward key value. |
LEFT |
string | Left key value. |
RIGHT |
string | Right key value. |
RUN |
string | Run key value. |
JUMP |
string | Jump key value (space). |
SPACEBAR |
string | Deprecated legacy key value for space. |
- Source:
KeyboardControlsOptions
Options used by KeyboardControls.
Type:
- Object
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
groundY |
number |
<optional> |
0.0 | Ground height for jumping and landing. |
azimuthRadians |
number |
<optional> |
0 | Initial yaw angle in radians. |
polarRadians |
number |
<optional> |
-0.35 | Initial pitch angle in radians. |
minPolarRadians |
number |
<optional> |
-1.25 | Minimum pitch angle in radians. |
maxPolarRadians |
number |
<optional> |
0.55 | Maximum pitch angle in radians. |
rotationSpeed |
number |
<optional> |
1.0 | Mouse rotation speed multiplier. |
moveSpeed |
number |
<optional> |
3.0 | Walking speed in world units per second. |
runSpeedMultiplier |
number |
<optional> |
1.8 | Speed multiplier when running (Shift). |
jumpSpeed |
number |
<optional> |
4.2 | Jump velocity. |
gravity |
number |
<optional> |
9.8 | Gravity acceleration magnitude. |
bobbingAmplitudeWalk |
number |
<optional> |
0.05 | Camera bobbing height while walking. |
bobbingAmplitudeRun |
number |
<optional> |
0.09 | Camera bobbing height while running. |
bobbingFrequencyWalk |
number |
<optional> |
9.0 | Bobbing angular speed while walking. |
bobbingFrequencyRun |
number |
<optional> |
13.0 | Bobbing angular speed while running. |
bobbingPitchAmplitudeRadians |
number |
<optional> |
0.02 | Camera pitch bobbing amplitude. |
- Source:
LambertMaterialOptions
Options used by `LambertMaterial`.
Type:
- Object
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
color |
Float32Array | Array.<number> |
<optional> |
Diffuse RGB color [red, green, blue] in [0..1] range. |
lightDirection |
Float32Array | Array.<number> |
<optional> |
Directional light direction (world space), normalized internally. |
ambientStrength |
number |
<optional> |
Ambient term multiplier. |
- Source:
MaterialOptions
Options used by Material.
Type:
- Object
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
ownsShaderProgram |
boolean |
<optional> |
false | Whether this material owns and disposes the shader program. |
- Source:
MeshOwnershipOptions
Ownership options for Mesh.
Type:
- Object
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
ownsGeometry |
boolean |
<optional> |
true | When true, `Mesh.dispose()` disposes geometry. |
ownsMaterial |
boolean |
<optional> |
true | When true, `Mesh.dispose()` disposes material. |
- Source:
MovementData
Per-frame movement intent derived from input.
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
moveX |
number | |
moveZ |
number | |
isMoving |
boolean | |
speed |
number |
- Source:
MovementData
Per-frame movement intent derived from input.
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
moveX |
number | |
moveZ |
number | |
isMoving |
boolean | |
speed |
number |
- Source:
MovementData
Per-frame movement intent derived from input.
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
moveX |
number | |
moveZ |
number | |
isMoving |
boolean | |
speed |
number |
- Source:
MtlStandardMaterialMapOptions
Texture map setter options.
Type:
- Object
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
textureUnitIndex |
number |
<optional> |
Texture unit index. |
uvOffset |
Float32Array | Array.<number> |
<optional> |
UV-offset vector. |
uvScale |
Float32Array | Array.<number> |
<optional> |
UV-scale vector. |
MtlStandardMaterialOptions
Options used by `MtlStandardMaterial`.
Type:
- Object
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
diffuseColor |
Float32Array | Array.<number> |
<optional> |
Diffuse RGB color in 0..1 range. |
ambientColor |
Float32Array | Array.<number> |
<optional> |
Ambient RGB color in 0..1 range. |
specularColor |
Float32Array | Array.<number> |
<optional> |
Specular RGB color in 0..1 range. |
emissiveColor |
Float32Array | Array.<number> |
<optional> |
Emissive RGB color in 0..1 range. |
lightDirection |
Float32Array | Array.<number> |
<optional> |
Directional light direction (world space). |
ambientStrength |
number |
<optional> |
Ambient strength multiplier. |
shininess |
number |
<optional> |
Specular exponent. |
specularStrength |
number |
<optional> |
Specular strength multiplier. |
opticalDensity |
number |
<optional> |
Optical density used for reflection blending. |
ObjFaceVertex
Type definition for parsed OBJ face vertex.
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
positionIndex |
number | Position index. |
uvIndex |
number | UV index. |
normalIndex |
number | Normal index. |
ObjFaceVertex
Type definition for the parsed OBJ face vertex.
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
positionIndex |
number | Position index (zero-based). |
uvIndex |
number | UV index (zero-based or -1). |
normalIndex |
number | Normal index (zero-based or -1). |
- Source:
ObjGeometryBuildResult
Result of building OBJ geometry.
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
root |
Object3D | Root object containing all nodes. |
entries |
Array.<ObjMeshEntry> | Mesh creation entries. |
geometries |
Array.<CustomGeometry> | Created geometries. |
ObjMaterialChunk
Type definition for parsed OBJ material chunk.
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
materialName |
string | Material name. |
smoothingGroup |
number | Smoothing group (0 = off). |
triangles |
Array.<Array.<ObjFaceVertex>> | Triangulated faces. |
points |
Array.<number> | Point indices. |
lines |
Array.<Array.<number>> | Line index arrays. |
ObjMaterialChunk
Type definition for the parsed OBJ material chunk.
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
materialName |
string | Material name. |
smoothingGroup |
number | Smoothing group number (0 = off). |
triangles |
Array.<Array.<ObjFaceVertex>> | Triangulated faces (each triangle has 3 vertices). |
points |
Array.<number> | Point indices in this chunk. |
lines |
Array.<Array.<number>> | Line index arrays in this chunk. |
- Source:
ObjMaterialFactoryOptions
Type definition for options used by `ObjMaterialFactory`.
Type:
- Object
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
textureUnitIndex |
number |
<optional> |
0 | Texture unit index for the textured materials. |
defaultColor |
Float32Array | Array.<number> |
<optional> |
Default diffuse color. | |
textureCache |
MtlTextureCache |
<optional> |
Optional shared texture cache. |
ObjMaterialTextureUrls
Type definition for resolved texture URLs.
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
diffuse |
string | null | Diffuse map URL. |
ambient |
string | null | Ambient map URL. |
specular |
string | null | Specular map URL. |
alpha |
string | null | Alpha map URL. |
bump |
string | null | Bump map URL. |
displacement |
string | null | Displacement map URL. |
reflection |
string | null | Reflection map URL. |
ObjMeshEntry
Output entry for mesh creation.
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
entryType |
string | Entry type (mesh/points/line). |
parent |
Object3D | Parent node for the mesh. |
geometry |
CustomGeometry | PointsGeometry | PolylineGeometry | Geometry instance. |
materialName |
string | Material name used by the chunk. |
usesVertexColors |
boolean | True, when geometry includes vertex colors. |
ObjMtlLoadFromFilesOptions
Options used by `ObjMtlLoader.loadFromFiles`.
Type:
- Object
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
objFile |
File | OBJ file. | |
mtlFiles |
Map.<string, File> |
<optional> |
Map of MTL files by normalized path/name. |
assetUrlMap |
Map.<string, string> |
<optional> |
Map of asset blob URLs by normalized path/name. |
baseUrl |
string |
<optional> |
Base URL for resolving relative references. |
textureBaseUrl |
string |
<optional> |
Base URL for resolving texture paths. |
ObjMtlLoadFromUrlsOptions
Options used by `ObjMtlLoader.loadFromUrls`.
Type:
- Object
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
objUrl |
string | URL to the OBJ file. | |
mtlUrl |
string |
<optional> |
Optional URL to the MTL file. |
baseUrl |
string |
<optional> |
Base URL for resolving relative references. |
textureBaseUrl |
string |
<optional> |
Base URL for resolving texture paths. |
ObjMtlLoadResult
Result returned by `ObjMtlLoader.loadFromUrls`.
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
root |
Object3D | Root object, containing all meshes. |
meshes |
Array.<Mesh> | Loaded meshes, points and lines. |
geometries |
Array.<CustomGeometry> | Created geometries. |
materials |
Array.<(LambertMaterial|PhongMaterial|VertexColorMaterial|PointsMaterial|SolidColorMaterial|MtlStandardMaterial)> | Created materials. |
textures |
Array.<Texture2D> | Textures created by the loader. |
ObjMtlLoaderOptions
Options used by `ObjMtlLoader`.
Type:
- Object
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
textureUnitIndex |
number |
<optional> |
0 | Texture unit index for textured materials. |
defaultColor |
Float32Array | Array.<number> |
<optional> |
Default diffuse color. |
ObjParsedData
Parsed OBJ data.
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
positions |
Array.<number> | Flat positions array. |
uvs |
Array.<number> | Flat UV array. |
normals |
Array.<number> | Flat normal array. |
colors |
Array.<number> | Flat vertex color array. |
hasVertexColors |
boolean | True, when vertex colors are provided. |
objects |
Array.<ObjParsedObject> | Parsed objects. |
ObjParsedData
Parsed OBJ data.
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
materialLibraries |
Array.<string> | List of MTL library file names. |
positions |
Array.<number> | Flat positions array. |
uvs |
Array.<number> | Flat UV array. |
normals |
Array.<number> | Flat normal array. |
colors |
Array.<number> | Flat vertex color array. |
hasVertexColors |
boolean | True when vertex colors are provided. |
objects |
Array.<ObjParsedObject> | Parsed objects. |
- Source:
ObjParsedGroup
Type definition for parsed OBJ group.
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
name |
string | Group name. |
materialChunks |
Array.<ObjMaterialChunk> | Material chunks in this group. |
ObjParsedGroup
Type definition for the parsed OBJ group.
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
name |
string | Group name. |
materialChunks |
Array.<ObjMaterialChunk> | Material chunks in this group. |
chunkMap |
Map.<string, ObjMaterialChunk> | Map of chunk keys. |
- Source:
ObjParsedObject
Type definition for parsed OBJ object.
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
name |
string | Object name. |
groups |
Array.<ObjParsedGroup> | Group list. |
ObjParsedObject
Type definition for the parsed OBJ object.
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
name |
string | Object name. |
groups |
Array.<ObjParsedGroup> | Group list. |
groupMap |
Map.<string, ObjParsedGroup> | Map of groups. |
- Source:
ParsedMtlMaterial
Parsed MTL material definition.
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
name |
string | Material name. |
diffuseColor |
Float32Array | Diffuse RGB color. |
ambientColor |
Float32Array | Ambient RGB color (parsed-only). |
specularColor |
Float32Array | Specular RGB color. |
emissiveColor |
Float32Array | Emissive RGB color (parsed-only). |
diffuseMap |
ParsedMtlTextureMap | null | Diffuse texture data, if any. |
ambientMap |
ParsedMtlTextureMap | null | Ambient texture data (parsed-only). |
specularMap |
ParsedMtlTextureMap | null | Specular texture data (parsed-only). |
alphaMap |
ParsedMtlTextureMap | null | Alpha texture data (parsed-only). |
bumpMap |
ParsedMtlTextureMap | null | Bump texture data (parsed-only). |
displacementMap |
ParsedMtlTextureMap | null | Displacement texture data (parsed-only). |
reflectionMap |
ParsedMtlTextureMap | null | Reflection texture data (parsed-only). |
specularExponent |
number | null | Specular exponent (Ns). |
opticalDensity |
number | null | Optical density (parsed-only). |
illuminationModel |
number | null | Illumination model (parsed-only). |
opacity |
number | Opacity multiplier. |
- Source:
ParsedMtlTextureMap
Parsed MTL texture map data.
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
path |
string | Texture path. |
offset |
Float32Array | UV offset as `[u, v]`. |
scale |
Float32Array | UV scale as `[u, v]`. |
clamp |
boolean | True when clamping is enabled. |
bumpMultiplier |
number | Bump multiplier value. |
- Source:
PhongMaterialOptions
Options used by `PhongMaterial`.
Type:
- Object
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
color |
Float32Array | Array.<number> |
<optional> |
Diffuse RGB color [red, green, blue] in [0..1] range. |
lightDirection |
Float32Array | Array.<number> |
<optional> |
Directional light direction (world space), normalized internally. |
ambientStrength |
number |
<optional> |
Ambient term multiplier. |
specularColor |
Float32Array | Array.<number> |
<optional> |
Specular RGB color [red, green, blue] in [0..1] range. |
specularStrength |
number |
<optional> |
Specular term multiplier. |
shininess |
number |
<optional> |
Shininess exponent for specular highlight. |
- Source:
PlaneGeometryData
Internal geometry buffers produced by `PlaneGeometry`.
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
positions |
Float32Array | Vertex positions (xyz). |
normals |
Float32Array | Vertex normals (xyz). |
uvs |
Float32Array | Vertex UVs (uv). |
colors |
Float32Array | Vertex colors (rgb). |
indicesSolid |
Uint16Array | Uint32Array | Triangle index buffer. |
indicesWireframe |
Uint16Array | Uint32Array | Line index buffer for wireframe. |
- Source:
PlaneGeometryOptions
Plane geometry options.
`colors` supports:
- Uniform RGB (`length === 3`)
- Per-vertex RGB (`length === vertexCount * 3`)
Segment parameters must be `integers >= 1`.
Type:
- Object
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
width |
number |
<optional> |
1.0 | Plane width along the X axis. |
height |
number |
<optional> |
1.0 | Plane height along the Y axis. |
widthSegments |
number |
<optional> |
1 | Subdivisions along the X axis. |
heightSegments |
number |
<optional> |
1 | Subdivisions along the Y axis. |
colors |
Float32Array |
<optional> |
Color specification buffer. |
- Source:
PointsGeometryOptions
Options used by PointsGeometry.
Type:
- Object
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
positions |
Array.<Vector3> | Point positions. | |
colors |
Float32Array | null |
<optional> |
Color specification (uniform or per-vertex). |
- Source:
PointsMaterialOptions
Options used by `PointsMaterial`.
Type:
- Object
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
color |
Float32Array | Array.<number> |
<optional> |
RGB color [red, green, blue] in [0..1] range. | |
pointSize |
number |
<optional> |
6.0 | Point size in pixels. |
useVertexColors |
boolean |
<optional> |
false | When true, uses vertex colors. |
- Source:
PolylineGeometryOptions
Options used by PolylineGeometry.
Type:
- Object
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
positions |
Array.<Vector3> | Polyline positions. | ||
loop |
boolean |
<optional> |
false | When true, use `LINE_LOOP`. |
colors |
Float32Array | null |
<optional> |
Color specification (uniform or per-vertex). |
- Source:
PyramidBaseAppendResult
Small result object returned by base appender.
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
vertexCount |
number | Number of vertices appended for the base. |
- Source:
PyramidGeometryData
Internal geometry buffers produced by `PyramidGeometry`.
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
positions |
Float32Array | Vertex positions (xyz). |
normals |
Float32Array | Vertex normals (xyz). |
uvs |
Float32Array | Vertex UVs (uv). |
colors |
Float32Array | Vertex colors (rgb). |
indicesSolid |
Uint16Array | Uint32Array | Triangle index buffer. |
indicesWireframe |
Uint16Array | Uint32Array | Line index buffer for wireframe. |
- Source:
PyramidGeometryOptions
Pyramid geometry options.
`width` is the base size along X. `depth` (optional) is the base size along Z.
If `depth` is not provided, it defaults to `width` (square base).
`colors` supports:
- Uniform RGB (`length === 3`)
- Per-vertex RGB (`length === vertexCount * 3`)
Segment parameters must be integers `>= 1`.
Type:
- Object
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
width |
number |
<optional> |
1.0 | Base width along X. |
height |
number |
<optional> |
1.5 | Pyramid height along Y. |
depth |
number |
<optional> |
width | Base depth along Z. |
widthSegments |
number |
<optional> |
1 | Subdivisions along X (base grid and faces that use X edges). |
depthSegments |
number |
<optional> |
1 | Subdivisions along Z (base grid and faces that use Z edges). |
heightSegments |
number |
<optional> |
1 | Subdivisions along side height. |
capped |
boolean |
<optional> |
true | Whether to generate the bottom face. |
colors |
Float32Array |
<optional> |
Color specification buffer. |
- Source:
RGBAColor
RGBA color represented as [red, green, blue, alpha],
each component in the range [0 -> 1].
Type:
- Array.<number>
- Source:
Ray
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
origin |
RaycastPoint | Ray origin in world space. |
direction |
RaycastPoint | Normalized ray direction in world space. |
- Source:
RaycastOptions
Type:
- Object
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
recursive |
boolean |
<optional> |
true | When true, traverses all descendants of the scene. |
filter |
function |
<optional> |
null | Optional mesh filter. |
sort |
boolean |
<optional> |
true | When true, sorts intersections by distance. |
- Source:
RaycastPoint
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
x |
number | X coordinate. |
y |
number | Y coordinate. |
z |
number | Z coordinate. |
- Source:
ResizeToDisplaySizeOptions
Canvas resize options for `WebGLContext.resizeToDisplaySize()`.
Type:
- Object
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
fitToWindow |
boolean |
<optional> |
If true, resizes the canvas to match the window size. |
- Source:
ResizeToDisplaySizeOptions
Options used by resizeToDisplaySize.
Type:
- Object
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
fitToWindow |
boolean |
<optional> |
false | When true, uses `window.innerWidth/innerHeight`. When false, uses the canvas CSS size (client size) and updates the drawing buffer accordingly. |
- Source:
SolidColorMaterialOptions
Options used by SolidColorMaterial.
Type:
- Object
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
color |
Float32Array | Array.<number> |
<optional> |
RGB color [r,g,b] in 0..1 range. |
- Source:
SphereGeometryData
Internal geometry buffers produced by `SphereGeometry`.
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
positions |
Float32Array | Vertex positions (xyz). |
normals |
Float32Array | Vertex normals (xyz). |
uvs |
Float32Array | Vertex UVs (uv). |
colors |
Float32Array | Vertex colors (rgb). |
indicesSolid |
Uint16Array | Uint32Array | Triangle index buffer. |
indicesWireframe |
Uint16Array | Uint32Array | Line index buffer for wireframe. |
- Source:
SphereGeometryOptions
Sphere geometry options.
`width/height/depth` define full extents (diameters). Use equal values for a perfect sphere.
`colors` supports:
- Uniform RGB (`length === 3`)
- Per-vertex RGB (`length === vertexCount * 3`)
Segment parameters must be integers:
- `widthSegments >= 3`
- `heightSegments >= 2`
Type:
- Object
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
width |
number |
<optional> |
1.0 | Diameter along X axis. |
height |
number |
<optional> |
1.0 | Diameter along Y axis. |
depth |
number |
<optional> |
1.0 | Diameter along Z axis. |
widthSegments |
number |
<optional> |
24 | Longitudinal segments. |
heightSegments |
number |
<optional> |
16 | Latitudinal segments. |
colors |
Float32Array |
<optional> |
Color specification buffer. |
- Source:
Texture2DLoadOptions
Texture2D load options, used by `loadFromUrl`.
Type:
- Object
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
crossOrigin |
"anonymous" | "use-credentials" | null |
<optional> |
Optional cross-origin mode. |
- Source:
Texture2DOptions
Texture2D creation/update options.
Type:
- Object
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
flipY |
boolean |
<optional> |
true | Flip image data vertically on upload. |
wrapS |
number |
<optional> |
WebGL wrap mode for S (REPEAT/CLAMP_TO_EDGE/MIRRORED_REPEAT). | |
wrapT |
number |
<optional> |
WebGL wrap mode for T (REPEAT/CLAMP_TO_EDGE/MIRRORED_REPEAT). | |
minFilter |
number | null |
<optional> |
WebGL min filter (including the mipmap variants). Use `null` to clear explicit override and return to auto behavior. | |
magFilter |
number |
<optional> |
WebGL mag filter (NEAREST/LINEAR). | |
mipmapPolicy |
number |
<optional> |
2 | `MIPMAP_POLICY_*` constants usage. |
- Source:
TexturedMaterialOptions
Options used by `TexturedMaterial` constructor.
Type:
- Object
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
texture |
Texture2D |
<optional> |
Optional `Texture2D` instance. | |
textureUnitIndex |
number |
<optional> |
0 | Texture unit index used for binding. |
ownsTexture |
boolean |
<optional> |
false | If true, dispose will dispose the texture. |
ownsShaderProgram |
boolean |
<optional> |
true | If true, dispose will dispose the shader program. |
- Source:
ThirdPersonCameraOptions
Options used by ThirdPersonCamera.
Type:
- Object
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
fieldOfViewRadians |
number |
<optional> |
Math.PI / 4 | Vertical field of view in radians. |
aspectRatio |
number |
<optional> |
1.0 | Viewport aspect ratio (width / height). |
near |
number |
<optional> |
0.1 | Distance to the near clipping plane. |
far |
number |
<optional> |
200.0 | Distance to the far clipping plane. |
mode |
string |
<optional> |
'NORMAL' | Camera mode, see `ThirdPersonCamera.Modes`. |
- Source:
ThirdPersonControlsOptions
Options used by ThirdPersonControls.
Type:
- Object
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
distance |
number |
<optional> |
6.0 | Camera follow distance. |
targetHeight |
number |
<optional> |
1.4 | Look-at height offset from the target. |
- Source:
TorusGeometryData
Internal geometry buffers produced by `TorusGeometry`.
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
positions |
Float32Array | Vertex positions (xyz). |
normals |
Float32Array | Vertex normals (xyz). |
uvs |
Float32Array | Vertex UVs (uv). |
colors |
Float32Array | Vertex colors (rgb). |
indicesSolid |
Uint16Array | Uint32Array | Triangle index buffer. |
indicesWireframe |
Uint16Array | Uint32Array | Line index buffer for wireframe. |
- Source:
TorusGeometryOptions
Torus geometry options.
`width` and `height` are interpreted as:
- `width` = major diameter (center ring diameter)
- `height` = tube diameter
Segment parameters must be integers `>= 3`.
`colors` supports:
- Uniform RGB `length === 3`
- Per-vertex RGB `length === vertexCount * 3`
Type:
- Object
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
width |
number |
<optional> |
1.5 | Major diameter. |
height |
number |
<optional> |
0.5 | Tube diameter. |
tubularSegments |
number |
<optional> |
32 | Segments around the ring `>= 3`. |
radialSegments |
number |
<optional> |
16 | Segments around the tube `>= 3`. |
colors |
Float32Array |
<optional> |
Color specification buffer. |
- Source:
TubeLineGeometryOptions
Options used by `TubeLineGeometry`.
Type:
- Object
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
positions |
Array.<Vector3> | Path positions. | ||
radius |
number |
<optional> |
0.05 | Tube radius. |
width |
number | null |
<optional> |
null | Optional tube width (overrides the radius). |
radialSegments |
number |
<optional> |
8 | Radial segment count. |
closed |
boolean |
<optional> |
false | Whether to close the tube. |
capType |
string |
<optional> |
'none' | Cap type (none|flat). |
- Source: