Header menu logo Mibo

Batch2DConfig Type

Configuration for Batch2DRenderer.

These settings configure the *rendering pass* (Clear + SpriteBatch.Begin parameters), not individual sprites (those are controlled by RenderCmd2D / Draw2DBuilder).

Record fields

Record Field Description

BlendState

Full Usage: BlendState

Field type: BlendState

Blend state for sprite drawing.

Field type: BlendState

ClearColor

Full Usage: ClearColor

Field type: Color voption

Optional color to clear the screen with before drawing.

Field type: Color voption

DepthStencilState

Full Usage: DepthStencilState

Field type: DepthStencilState

Depth stencil state.

Field type: DepthStencilState

Effect

Full Usage: Effect

Field type: Effect

Optional shader effect for all sprites.

Field type: Effect

RasterizerState

Full Usage: RasterizerState

Field type: RasterizerState

Rasterizer state.

Field type: RasterizerState

SamplerState

Full Usage: SamplerState

Field type: SamplerState

Sampler state for texture filtering.

Field type: SamplerState

SortCommands

Full Usage: SortCommands

Field type: bool

Whether to sort the command buffer by `RenderLayer` before issuing draws. Keep this enabled if you rely on `RenderLayer` for deterministic ordering.

Field type: bool

SortMode

Full Usage: SortMode

Field type: SpriteSortMode

SpriteBatch sort mode (Deferred, Immediate, etc).

Field type: SpriteSortMode

TransformMatrix

Full Usage: TransformMatrix

Field type: Matrix voption

Global transform matrix for the batch. Note: If using `SetCamera` commands, this initial matrix might be overridden during the pass.

Field type: Matrix voption

Type something to start searching.