Class Layers

Contains a list of layers that can be used for where an effect is being applied. This system can be used to determine which Camera can see a particular Renderable or which Rigidbody is intersected by a PhysicsScene raycast.

Note

A maximum of 8 layers is supported, but RSX could support more.

Constructors

constructor

Properties

allLayers maximumLayerCount

Accessors

names values

Methods

packToBigInt packToNumber unpackBitMask

Constructors

constructor

Properties

Static ReadonlyallLayers

allLayers: rsx.LayerMask

The default bit value for LayerMasks. All layers are enabled.

Static ReadonlymaximumLayerCount

maximumLayerCount = 8

The maximum number of layers.

Accessors

Staticnames

  • get names(): string[]

  • Returns the names of all available layers.

    Returns string[]

Staticvalues

Methods

StaticpackToBigInt

  • packToBigInt(activeBits): rsx.LayerMask

  • Converts the array of activeBits into a single bigint.

    [1, 4, 8] would create a bigint with bits 1,4,8 enabled.

    Parameters

    • activeBits: number[]

      The array of active bits.

    Returns rsx.LayerMask

    Layermask as bigint.

StaticpackToNumber

  • packToNumber(activeBits): number

  • Converts the array of activeBits into a single number.

    [1, 4, 8] would create a number with bits 1,4,8 enabled.

    Parameters

    • activeBits: number[]

      The array of active bits.

    Returns number

    Layermask as number.

StaticunpackBitMask

  • unpackBitMask(layerBitMask): number[]

  • Unpacks a layerBitMask into an array of active bit indices.

    A layerBitMask bits 1,4,8 enabled will result in the array [1,4,8].

    Parameters

    Returns number[]

    Array of active bit indices.

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods