Header menu logo Mibo

Draw2D Module

Functions for building and submitting 2D draw commands.

Functions and values

Function or value Description

atLayer layer b

Full Usage: atLayer layer b

Parameters:
Returns: Draw2DBuilder

blendState blendState layer buffer

Full Usage: blendState blendState layer buffer

Parameters:

Set the SpriteBatch blend state for subsequent draws.

blendState : BlendState
layer : int<MeasureProduct<RenderLayer, MeasureOne>>
buffer : RenderBuffer<RenderCmd2D>

camera cam layer buffer

Full Usage: camera cam layer buffer

Parameters:

Submits a camera change command to the buffer.

cam : Camera
layer : int<MeasureProduct<RenderLayer, MeasureOne>>
buffer : RenderBuffer<RenderCmd2D>

clear color clearDepth layer buffer

Full Usage: clear color clearDepth layer buffer

Parameters:

Clear color and/or depth buffer. Useful between cameras in multi-camera setups.

color : Color voption
clearDepth : bool
layer : int<MeasureProduct<RenderLayer, MeasureOne>>
buffer : RenderBuffer<RenderCmd2D>

custom draw layer buffer

Full Usage: custom draw layer buffer

Parameters:

Submits a custom drawing command to the buffer.

The SpriteBatch is ended before calling draw, and restarted after.

draw : GameContext -> unit
layer : int<MeasureProduct<RenderLayer, MeasureOne>>
buffer : RenderBuffer<RenderCmd2D>

depthStencilState depthStencilState layer buffer

Full Usage: depthStencilState depthStencilState layer buffer

Parameters:

Set the SpriteBatch depth-stencil state for subsequent draws.

depthStencilState : DepthStencilState
layer : int<MeasureProduct<RenderLayer, MeasureOne>>
buffer : RenderBuffer<RenderCmd2D>

effect effect layer buffer

Full Usage: effect effect layer buffer

Parameters:

Set the SpriteBatch effect for subsequent draws.

Use ValueNone to revert to the renderer's configured default.

effect : Effect voption
layer : int<MeasureProduct<RenderLayer, MeasureOne>>
buffer : RenderBuffer<RenderCmd2D>

rasterizerState rasterizerState layer buffer

Full Usage: rasterizerState rasterizerState layer buffer

Parameters:

Set the SpriteBatch rasterizer state for subsequent draws.

rasterizerState : RasterizerState
layer : int<MeasureProduct<RenderLayer, MeasureOne>>
buffer : RenderBuffer<RenderCmd2D>

samplerState samplerState layer buffer

Full Usage: samplerState samplerState layer buffer

Parameters:

Set the SpriteBatch sampler state for subsequent draws.

samplerState : SamplerState
layer : int<MeasureProduct<RenderLayer, MeasureOne>>
buffer : RenderBuffer<RenderCmd2D>

sprite tex dest

Full Usage: sprite tex dest

Parameters:
Returns: Draw2DBuilder

Starts a sprite drawing command.

tex : Texture2D
dest : Rectangle
Returns: Draw2DBuilder

submit buffer b

Full Usage: submit buffer b

Parameters:

Submits the draw command to the renderer's buffer.

buffer : RenderBuffer<RenderCmd2D>
b : Draw2DBuilder

viewport vp layer buffer

Full Usage: viewport vp layer buffer

Parameters:

Submits a viewport change command to the buffer.

vp : Viewport
layer : int<MeasureProduct<RenderLayer, MeasureOne>>
buffer : RenderBuffer<RenderCmd2D>

withColor col b

Full Usage: withColor col b

Parameters:
Returns: Draw2DBuilder
col : Color
b : Draw2DBuilder
Returns: Draw2DBuilder

withSource src b

Full Usage: withSource src b

Parameters:
Returns: Draw2DBuilder

Type something to start searching.