Class Constants

Nothing

On center pick

On double pick

On every frame

On intersection enter

On intersection exit

On key down

On key up

On left pick

On long press

On pick down

On pick out. This trigger will only be raised if you also declared a OnPickDown

On pick

On pick up

On pointer out

On pointer over

On right pick

Defines that alpha blending is COLOR=SRC_ALPHA * SRC + DEST, ALPHA=DEST_ALPHA

Defines that alpha blending is COLOR=DEST_ALPHA * SRC + DST, ALPHA=0

Defines that alpha blending is COLOR=SRC_ALPHA * SRC + (1 - SRC_ALPHA) * DEST, ALPHA=SRC_ALPHA + DEST_ALPHA Go-to for transparency. 100% alpha means source, 0% alpha means background. Glass, UI fade, smoke

Defines that alpha blending is disabled

Defines that alpha blending uses dual source blending and is COLOR=SRC + SRC1 * DEST, ALPHA=DST_ALPHA

Defines that alpha blending equation a SUM

Defines that alpha blending equation a DARKEN operation: It takes the min of the src and sums the alpha channels.

Defines that alpha blending equation a MAX operation

Defines that alpha blending equation a MIN operation

Defines that alpha blending equation a REVERSE SUBSTRACTION

Defines that alpha blending equation a SUBSTRACTION

Defines that alpha blending is COLOR=(1 - DEST) * SRC + (1 - SRC) * DEST, ALPHA=DEST_ALPHA Produces inverted look (negative space), like 'exclusion' mode in photoshop

Defines that alpha blending is COLOR=CST * SRC + (1 - CST) * DEST, ALPHA=CST_ALPHA * SRC + (1 - CST_ALPHA) * DEST_ALPHA Where CST is user-supplied color

Defines that alpha blending is COLOR=SRC_ALPHA * SRC + (1 - SRC ALPHA) * DEST, ALPHA=SRC_ALPHA + (1 - SRC_ALPHA) * DEST_ALPHA Great for layered rendering (particles, fog volumes), accumulates transparency in a more physically accurate way

Defines that alpha blending is COLOR=MAX(SRC, DEST), ALPHA=MAX(SRC_ALPHA, DEST_ALPHA)

Defines that alpha blending is COLOR=SRC_ALPHA * SRC + (1 - SRC) * DEST, ALPHA=SRC_ALPHA + DEST_ALPHA Prioritizes area with high source alpha, strongly emphasizes the source

Defines that alpha blending is COLOR=MIN(SRC, DEST), ALPHA=MIN(SRC_ALPHA, DEST_ALPHA)

Defines that alpha blending is COLOR=DEST * SRC, ALPHA=SRC_ALPHA + DEST_ALPHA

Defines that alpha blending is COLOR=SRC + DEST, ALPHA=DEST_ALPHA Source color is added to the destination color without alpha affecting the result. Great for additive glow effects (fire, magic, lasers)

Defines that alpha blending is COLOR=SRC + DST, ALPHA=SRC_ALPHA + DEST_ALPHA Straight addition of color and alpha- use when you want both source and destination colors and opacities to stack

Defines that alpha blending is COLOR=SRC + DST, ALPHA=SRC_ALPHA Color stacks, but only source alpha is kept

Defines that alpha blending is COLOR=SRC + (1 - SRC_ALPHA) * DEST, ALPHA=SRC_ALPHA + DEST_ALPHA

Defines that alpha blending is COLOR=SRC + (1 - SRC_ALPHA) * DEST, ALPHA=SRC_ALPHA + (1 - SRC_ALPHA) * DEST_ALPHA

Defines that alpha blending is COLOR=SRC, ALPHA=SRC_ALPHA + (1 - SRC_ALPHA) * DEST_ALPHA

Defines that alpha blending is COLOR=(1 - DEST) * SRC + (1 - SRC) * DEST, ALPHA=(1 - DEST_ALPHA) * SRC_ALPHA + (1 - SRC_ALPHA) * DEST_ALPHA Result is between source and destination, used for experimental blending or styled effects

Defines that alpha blending is COLOR=SRC + (1 - SRC) * DEST, ALPHA=SRC_ALPHA + (1 - SRC_ALPHA) * DEST_ALPHA Brightens, good for soft light or UI highlights (like photoshop's screen blend)

Defines that alpha blending is ALPHA=SRC + (1 - SRC ALPHA) * DEST, ALPHA=SRC_ALPHA + (1 - SRC ALPHA) * DEST_ALPHA Smooths blending between source and destination, useful in layered alpha masks

Defines that alpha blending is COLOR=(1 - SRC) * DEST, ALPHA=SRC_ALPHA + DEST_ALPHA Subtracts source from destination, leading to darker results

Passed to depthFunction or stencilFunction to specify depth or stencil tests will always pass. i.e. Pixels will be drawn in the order they are drawn

Color3 animation type

Color3 animation type

Float animation type

Matrix animation type

Quaternion animation type

Size animation type

Vector2 animation type

Vector3 animation type

Sampler suffix when associated with a texture name

Flag to create a buffer suitable to be used as an index buffer

Flag to create a buffer suitable to be used for indirect calls, such as dispatchIndirect

Flag to create a readable buffer (the buffer can be the source of a copy)

Flag to create a readable and writable buffer

Flag to create a buffer suitable to be used as a storage buffer

Flag to create a buffer suitable to be used as a uniform buffer

Flag to create a buffer suitable to be used as a vertex buffer

Flag to create a writable buffer (the buffer can be the destination of a copy)

The byte type.

Instance Colors

Colors

Passed to stencilOperation to specify that stencil value must be decremented

Passed to stencilOperation to specify that stencil value must be decremented with wrapping

Defines that the resource was successfully delay loaded

Defines that the resource is currently delay loading

Defines that the resource is not delayed

Defines that the resource is delayed and has not started loading

Flag used to disable diagnostics for WebGPU

Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value

The float type.

The fog density is following an exponential function

The fog density is following an exponential function faster than FOGMODE_EXP

The fog density is following a linear function.

The fog is deactivated

This setting aligns the left and right bounds of the viewport to the left and right bounds of the camera frustum.

This is the default FOV mode for perspective cameras. This setting aligns the upper and lower bounds of the viewport to the upper and lower bounds of the camera frustum.

Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than or equal to the stored value

Alpha blend equation: ADD

Alpha equation: MAX

Alpha equation: MIN

Alpha equation: REVERSE_SUBTRACT

Alpha equation: SUBTRACT

Alpha blend function: CONSTANT_ALPHA

Alpha blend function: CONSTANT

Alpha blend function: DST_ALPHA

Alpha blend function: ONE_MINUS_DST

Alpha blend function: ONE_MINUS_CONSTANT_ALPHA

Alpha blend function: ONE_MINUS_CONSTANT

Alpha blend function: ONE_MINUS_DST_ALPHA

Alpha blend function: ONE_MINUS_DST

Alpha blend function: ONE_MINUS_SRC_ALPHA

Alpha blend function: ONE_MINUS_SRC

Alpha blend function: SRC1

Alpha blend function: SRC1

Alpha blend function: SRC

Alpha blend function: SRC_ALPHA

Alpha blend function: SRC_ALPHA_SATURATED

Alpha blend function: SRC1

Alpha blend function: SRC1

Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value

The half float type.

Passed to stencilOperation to specify that stencil value must be incremented

Passed to stencilOperation to specify that stencil value must be incremented with wrapping

Constant used as key code for Alt key

Constant used as key code for Ctrl key

Constant used as key code for Meta key (Left Win, Left Cmd)

Constant used as key code for Meta key (Right Win)

Constant used as key code for Meta key (Right Win, Right Cmd)

Constant used as key code for Shift key

The integer type.

Passed to stencilOperation to specify that stencil value must be inverted

Passed to stencilOperation to specify that stencil value must be kept

Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than or equal to the stored value

Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value

The all dirty flag value

The dirty attribute flag value

Stores the clock-wise side orientation

Specular lighting for metals follows the logic in the glTF specification. Base colour is applied at F0 while glancing angles tend towards white.

Specular lighting for metals follows the logic in the OpenPBR specification. Specular colour is applied to glancing angles using the F82 spec.

Stores the counter clock-wise side orientation

Specular lighting for dielectric materials follows the logic in the glTF specification and KHR_materials_specular extension. Specular colour is applied only at normal incidence (i.e. F0) while glancing angles (i.e. F90) tend towards white.

Specular lighting for dielectric materials follows the logic in the OpenPBR specification. Specular colour is applied to all dielectric reflection, not just at normal incidence (i.e. F0).

Burley diffuse model type.

Energy-conserving Oren Nayar diffuse model type.

Lambertian diffuse model type.

Babylon.js version less than 8.x IBL Lambert + Burley diffuse model type.

The dirty fresnel flag value

The dirty image processing flag value

The dirty light flag value

Returns the line list draw mode

Returns the line loop draw mode

Returns the line strip draw mode

The dirty misc flag value

Returns the point fill mode

Returns the point list draw mode

The dirty prepass flag value

The dirty texture flag value

Returns the triangle fan draw mode

Returns the triangle fill mode

Returns the triangle strip draw mode

Returns the wireframe mode

Additional matrix indices (for bones)

Matrix indices (for bones)

Additional matrix weights (for bones)

Matrix weights (for bones)

Maximum number of uv sets supported

Culling strategy : Bounding Sphere Only. This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested. It's also less accurate than the standard because some not visible objects can still be selected. Test : is the bounding sphere outside the frustum ? If not, then the cullable object is in the frustum.

Culling strategy : Optimistic Inclusion. This in an inclusion test first, then the standard exclusion test. This can be faster when a cullable object is expected to be almost always in the camera frustum. This could also be a little slower than the standard test when the tested object center is not the frustum but one of its bounding box vertex is still inside. Anyway, it's as accurate as the standard strategy. Test : Is the cullable object bounding sphere center in the frustum ? If not, apply the default culling strategy.

Culling strategy : Optimistic Inclusion then Bounding Sphere Only. This in an inclusion test first, then the bounding sphere only exclusion test. This can be the fastest test when a cullable object is expected to be almost always in the camera frustum. This could also be a little slower than the BoundingSphereOnly strategy when the tested object center is not in the frustum but its bounding sphere still intersects it. It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy. Test : Is the cullable object bounding sphere center in the frustum ? If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.

Default culling strategy : this is an exclusion test and it's the more accurate. Test order : Is the bounding sphere outside the frustum ? If not, are the bounding box vertices outside the frustum ? It not, then the cullable object is in the frustum.

Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn

Normals

Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is not equal to the stored value

This helps creating camera with an orthographic mode. Orthographic is commonly used in engineering as a means to produce object specifications that communicate dimensions unambiguously, each line of 1 unit length (cm, meter..whatever) will appear to have the same length everywhere on the drawing. This allows the drafter to dimension only a subset of lines and let the reader know that other lines of that length on the drawing are also that length in reality. Every parallel line in the drawing is also parallel in the object.

Used for Selection Outline Layer sampling methods

Brute force 8 directional sampling

This method uses 1 center sample and 8 additional samples to compute the outline mask It is more precise but less optimized.

Used for Selection Outline Layer sampling methods

Optimized brute force 3 directional sampling

This method uses 1 center sample and 3 additional samples to compute the outline mask It is optimized but may produce artifacts when the outline thickness is set to high values.

Billboard mode will apply to all axes

Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction

Special billboard mode where the particle will be billboard to the camera but only around the axis of the direction of particle emission

Billboard mode will only apply to Y axis

This is the default projection mode used by the cameras. It helps recreating a feeling of perspective and better appreciate depth. This is the best way to simulate real life cameras.

Positions

Constant used to retrieve (sqrt) albedo index in the textures array in the prepass using the getIndex(Constants.PREPASS_ALBEDO_SQRT_TEXTURE_TYPE)

Constant used to retrieve albedo index in the textures array in the prepass using the getIndex(Constants.PREPASS_ALBEDO_TEXTURE_TYPE)

Constant used to retrieve the lit color texture index in the textures array in the prepass using the getIndex(Constants.PREPASS_COLOR_TEXTURE_TYPE)

Constant used to retrieve (camera view) depth index in the textures array in the prepass using the getIndex(Constants.PREPASS_DEPTH_TEXTURE_TYPE)

Constant used to retrieve the legacy irradiance texture index in the textures array in the prepass using getIndex(Constants.PREPASS_IRRADIANCE_LEGACY_TEXTURE_TYPE)

Constant used to retrieve the irradiance texture index in the textures array in the prepass using getIndex(Constants.PREPASS_IRRADIANCE_TEXTURE_TYPE)

Constant used to retrieve the local position texture index in the textures array in the prepass using getIndex(Constants.PREPASS_LOCAL_POSITION_TEXTURE_TYPE)

Constant used to retrieve the packed mesh-blending tag texture index in geometry rendering textures.

Constant used to retrieve normal index in the textures array in the prepass using the getIndex(Constants.PREPASS_NORMAL_TEXTURE_TYPE)

Constant used to retrieve normalized camera view depth geometry texture

Constant used to retrieve the object ID texture index in geometry rendering textures. Object IDs are stored as 24-bit RGB values or 8-bit RED values, depending on the texture format.

Constant used to retrieve the position texture index in the textures array in the prepass using getIndex(Constants.PREPASS_POSITION_TEXTURE_TYPE)

Constant used to retrieve the reflectivity texture index in the textures array in the prepass using the getIndex(Constants.PREPASS_REFLECTIVITY_TEXTURE_TYPE)

Constant used to retrieve screen-space (non-linear) depth index in the textures array in the prepass using the getIndex(Constants.PREPASS_SCREENSPACE_DEPTH_TEXTURE_TYPE)

Constant used to retrieve the velocity texture index in the textures array in the prepass using getIndex(Constants.PREPASS_VELOCITY_LINEAR_TEXTURE_TYPE)

Constant used to retrieve the velocity texture index in the textures array in the prepass using getIndex(Constants.PREPASS_VELOCITY_TEXTURE_TYPE)

Constant used to retrieve world normal index in the textures array in the prepass using the getIndex(Constants.PREPASS_WORLD_NORMAL_TEXTURE_TYPE)

Passed to stencilOperation to specify that stencil value must be replaced

Custom rig mode allowing rig cameras to be populated manually with any number of cameras

This specifies there is no need for a camera rig. Basically only one eye is rendered corresponding to the camera.

Simulates a camera Rig with one blue eye and one red eye. This can be use with 3d blue and red glasses.

Defines that both eyes of the camera will be rendered on successive lines interlaced for passive 3d monitors.

Defines that both eyes of the camera will be rendered over under each other.

Defines that both eyes of the camera will be rendered side by side with a none parallel target.

Defines that both eyes of the camera will be rendered side by side with a parallel target.

Defines that both eyes of the camera should be renderered in a VR mode (carbox).

Defines that texture rescaling will use a ceil to find the closer power of 2 size

Defines that texture rescaling will use a floor to find the closer power of 2 size

Defines that texture rescaling will look for the nearest power of 2 size

Detailed logging while loading

Minimal logging while loading

No logging while loading

Summary logging while loading

The default maxZ value for the far plane of a frustum light

The default minZ value for the near plane of a frustum light

The short type.

Fast snapshot rendering. In this mode, everything is static and only some limited form of dynamic behaviour is possible

Standard snapshot rendering. In this mode, some form of dynamic behavior is possible (for eg, uniform buffers are still updated)

URL to the snippet server. Points to the public snippet server by default

Tangents

2D Texture target

2D Array Texture target

3D Texture target

Bilinear is mag = linear and min = linear and no mip

Texture is not repeating outside of 0..1 UVs

Flag to create a storage texture

Cube Map Texture target

Cube Map Array Texture target

Cubic coordinates mode

Equirectangular coordinates mode

Explicit coordinates mode

High quality for texture filtering

Low quality for texture filtering

Medium quality for texture filtering

Offline (baking) quality for texture filtering

Equirectangular Fixed Mirrored coordinates mode

Equirectangular Fixed coordinates mode

Inverse Cubic coordinates mode

mag = linear and min = linear and mip = none

Trilinear is mag = linear and min = linear and mip = linear

Bilinear is mag = linear and min = linear and mip = nearest

mag = linear and min = nearest and mip = none

mag = linear and min = nearest and mip = linear

mag = linear and min = nearest and mip = nearest

Texture is repeating and mirrored

mag = nearest and min = linear and mip = none

mag = nearest and min = linear and mip = linear

mag = nearest and min = linear and mip = nearest

mag = nearest and min = nearest and mip = none

nearest is mag = nearest and min = nearest and mip = linear

mag = nearest and min = nearest and mip = nearest

nearest is mag = nearest and min = nearest and no mip

Planar coordinates mode

Projection coordinates mode

Hex-tile grid with per-tile rotation and luminance-weighted blending (3 texture fetches). Based on Mikkelsen, "Practical Real-Time Hex-Tiling", JCGT 2022.

Noise-driven offset blending to break texture repetition (3 texture fetches). Based on Inigo Quilez's technique 3.

No texture repetition breaking — standard tiling (1 texture fetch)

Per-tile random offset and mirror to break texture repetition (4 texture fetches). Based on Inigo Quilez's technique 1.

Smooth Voronoi bombing with Gaussian-weighted blending (9 texture fetches). Based on Inigo Quilez's technique 2.

Skybox coordinates mode

Spherical coordinates mode

Trilinear is mag = linear and min = linear and mip = linear

Texture is repeating outside of 0..1 UVs

ALPHA

BGRA

Compressed BC6 signed float

Compressed BC6 unsigned float

Compressed ETC1 (RGB)

Compressed BC1 (RGB)

Compressed ETC2 (RGB)

Compressed ETC2 (RGB+A1)

Compressed ASTC 10x10

Compressed ASTC 10x5

Compressed ASTC 10x6

Compressed ASTC 10x8

Compressed ASTC 12x10

Compressed ASTC 12x12

Compressed ASTC 4x4

Compressed ASTC 5x4

Compressed ASTC 5x5

Compressed ASTC 6x5

Compressed ASTC 6x6

Compressed ASTC 8x5

Compressed ASTC 8x6

Compressed ASTC 8x8

Compressed BC7

Compressed BC1 (RGBA)

Compressed BC2

Compressed BC3

Compressed ETC2 (RGBA)

Compressed BC7 (SRGB+A)

Compressed BC1 (SRGB+A)

Compressed BC2 (SRGB+A)

Compressed BC3 (SRGB+A)

Compressed BC1 (SRGB)

Compressed ASTC 10x10 (SRGB+A)

Compressed ASTC 10x5 (SRGB+A)

Compressed ASTC 10x6 (SRGB+A)

Compressed ASTC 10x8 (SRGB+A)

Compressed ASTC 12x10 (SRGB+A)

Compressed ASTC 12x12 (SRGB+A)

Compressed ASTC 4x4 (SRGB+A)

Compressed ASTC 5x4 (SRGB+A)

Compressed ASTC 5x5 (SRGB+A)

Compressed ASTC 6x5 (SRGB+A)

Compressed ASTC 6x6 (SRGB+A)

Compressed ASTC 8x5 (SRGB+A)

Compressed ASTC 8x6 (SRGB+A)

Compressed ASTC 8x8 (SRGB+A)

Compressed ETC2 (SRGB+A)

Compressed ETC2 (SRGB)

Compressed ETC2 (SRGB+A1)

Depth 16 bits

Depth 24 bits

Depth 24 bits + Stencil 8 bits

Depth 24 bits unorm + Stencil 8 bits

Depth 32 bits float

Depth 32 bits float + Stencil 8 bits

LUMINANCE

LUMINANCE_ALPHA

RED (2nd reference)

RED_INTEGER (2nd reference)

RED signed short normed to [-1, 1] *

RED unsigned short normed to [0, 1] *

RED

RED_INTEGER

RG

RG_INTEGER

RG signed short normed to [-1, 1] *

RG unsigned short normed to [0, 1] *