# Nirvana2D [RCBasic Doc]

## Nirvana2D API

Function Nirvana_GetLayerIndex(layer_name$)

- Returns the internal nirvana index associated with the given layer name or -1 if layer name is not an existing layer

Function Nirvana_GetLayerCanvasID(layer_index)

- Returns the RCBasic canvas of the given nirvana layer index or -1 if layer_index is not a valid layer

Function Nirvana_GetLayerType(layer_index)

- Returns the layer type or -1 if layer_index is not a valid layer
- Possible Layer Types
  - NIRVANA_LAYER_TYPE_TILEMAP
  - NIRVANA_LAYER_TYPE_SPRITE
  - NIRVANA_LAYER_TYPE_CANVAS_2D
  - NIRVANA_LAYER_TYPE_CANVAS_3D

Function Nirvana_GetLayerName$(layer_index)

- Returns the name of the given layer or an empty string if layer is not valid

Function Nirvana_GetLayerAlpha(layer_index)

- Returns the layer alpha value set in the layer settings in Nirvana

Function Nirvana_GetLayerScrollSpeed(layer_index) As Nirvana_Vector2D

- Returns the HScroll and VScroll speed as a vector