com.almasb.fxgl.entity

Interface RenderLayer

public interface RenderLayer

Represents a layer which is used to group objects being rendered. Layers are rendered from lower index value to higher index value. Objects with higher index value will be rendered on top of objects with lower index value.

Author:

Almas Baimagambetov (AlmasB) (almaslvl@gmail.com)

Field Summary

Fields

Modifier and Type	Field and Description
static RenderLayer	BACKGROUND Convenience render layer for background.
static RenderLayer	BOTTOM Note: this is the lowest layer that can be used.
static RenderLayer	DEFAULT Default render layer for entities with no specified render layer.
static RenderLayer	TOP Note: this is the highest layer that can be used.

Method Summary

Modifier and Type	Method and Description
default String	asString()
int	index() Returns index value for this layer.
String	name() Returns a human readable name for this layer.

Field Detail

DEFAULT

static final RenderLayer DEFAULT

Default render layer for entities with no specified render layer.

TOP

static final RenderLayer TOP

Note: this is the highest layer that can be used.

BOTTOM

static final RenderLayer BOTTOM

Note: this is the lowest layer that can be used.

BACKGROUND

static final RenderLayer BACKGROUND

Convenience render layer for background. Note: value of 1000 leaves some scope for using parallax backgrounds.

Method Detail

name

String name()

Returns a human readable name for this layer.

Returns:

layer name

index

int index()

Returns index value for this layer.

Returns:

layer index

asString

default String asString()

Returns:

string representation of render layer