Skip to content
YAGE Logo YAGE

CreateLayerOptions

Defined in: renderer/src/RenderLayer.ts:18

Options for creating a layer.

Properties

Section titled “Properties”

eventMode?

Section titled “eventMode?”

optional eventMode?: EventMode

Defined in: renderer/src/RenderLayer.ts:20

Per-layer override for PixiJS event mode. Falls back to the manager default.

isRenderGroup?

Section titled “isRenderGroup?”

optional isRenderGroup?: boolean

Defined in: renderer/src/RenderLayer.ts:33

Promote the layer’s container to a Pixi v8 render group. See LayerDef.isRenderGroup for the full rationale — isolates filter uniforms from sibling layers that read globalUniforms directly.

sort?

Section titled “sort?”

optional sort?: LayerSortFn

Defined in: renderer/src/RenderLayer.ts:40

Depth-key function. See LayerDef.sort — when set, DisplaySystem writes child.zIndex = sort(child) on every child each frame, and flips container.sortableChildren = true so Pixi orders the layer by zIndex at render time. Default: undefined (insertion order).

space?

Section titled “space?”

optional space?: LayerSpace

Defined in: renderer/src/RenderLayer.ts:27

Coordinate space. "world" (default) layers are auto-bound by every camera unless it sets autoBind: false; "screen" layers are skipped so they stay fixed to the viewport. Cameras can still explicitly bind screen-space layers by naming them in bindings.

Coding agents: fetch https://yage.dev/llms.txt first and prefer the Markdown references it links over these HTML pages. This page's Markdown counterpart is /llms/packages/renderer.md.