Header menu logo Mibo

RenderCmd3D Type

A 3D render command.

These commands are queued to a RenderBuffer and executed by Batch3DRenderer.

Union cases

Union case Description

ClearTarget(clearColor, clearDepth)

Full Usage: ClearTarget(clearColor, clearDepth)

Parameters:
    clearColor : Color voption
    clearDepth : bool

Clear the render target. Use between cameras in multi-camera setups.

clearColor : Color voption
clearDepth : bool

DrawBillboardEffect billboardEffect

Full Usage: DrawBillboardEffect billboardEffect

Parameters:

Effect-driven billboard draw: user provides an effect and optional setup callback.

billboardEffect : EffectBillboardCmd

DrawCustom draw

Full Usage: DrawCustom draw

Parameters:

Escape hatch: run an arbitrary draw function.

The function is invoked with the current camera View/Projection matrices (as last set by SetCamera) so userland can integrate custom effects without forking the renderer.

draw : GameContext * Matrix * Matrix -> unit

DrawLine(line, pass)

Full Usage: DrawLine(line, pass)

Parameters:

Draw a single line segment using the built-in BasicEffect.

line : Vector3 * Vector3 * Color
pass : RenderPass

DrawLines(lines, lineCount, pass)

Full Usage: DrawLines(lines, lineCount, pass)

Parameters:

Draw line segments using the built-in BasicEffect (vertex colors).

Lines are batched together; flushes occur on pass/camera/effect changes.

lines : VertexPositionColor[]
lineCount : int
pass : RenderPass

DrawLinesEffect(lines, lineCount, effect, setup, pass)

Full Usage: DrawLinesEffect(lines, lineCount, effect, setup, pass)

Parameters:

Draw line segments using a custom effect.

Use for glowing lines, dashed lines, or other custom line effects.

lines : VertexPositionColor[]
lineCount : int
effect : Effect
setup : EffectSetup voption
pass : RenderPass

DrawMesh(pass, model, transform, diffuseColor, texture, setup)

Full Usage: DrawMesh(pass, model, transform, diffuseColor, texture, setup)

Parameters:

Draws a 3D mesh from a Model.

pass : RenderPass
model : Model
transform : Matrix
diffuseColor : Color voption
texture : Texture2D voption
setup : EffectSetup voption

DrawQuadEffect quadEffect

Full Usage: DrawQuadEffect quadEffect

Parameters:

Effect-driven quad draw: user provides an effect and optional setup callback.

quadEffect : EffectQuadCmd

DrawSkinned(pass, model, transform, bones, diffuseColor, texture, setup)

Full Usage: DrawSkinned(pass, model, transform, bones, diffuseColor, texture, setup)

Parameters:

Contract for skinned/animated models.

If the underlying model uses SkinnedEffect, this renderer will apply bones via SkinnedEffect.SetBoneTransforms.

pass : RenderPass
model : Model
transform : Matrix
bones : Matrix[]
diffuseColor : Color voption
texture : Texture2D voption
setup : EffectSetup voption

DrawSpriteBillboard spriteBillboard

Full Usage: DrawSpriteBillboard spriteBillboard

Parameters:

Sprite-style billboard draw (90% case): unlit textured billboard using built-in sprite effect.

spriteBillboard : SpriteBillboardCmd

DrawSpriteQuad spriteQuad

Full Usage: DrawSpriteQuad spriteQuad

Parameters:

Sprite-style quad draw (90% case): unlit textured quad using built-in sprite effect.

spriteQuad : SpriteQuadCmd

SetCamera camera

Full Usage: SetCamera camera

Parameters:

Sets the camera for subsequent draws.

camera : Camera

SetViewport viewport

Full Usage: SetViewport viewport

Parameters:

Set viewport for multi-camera rendering (split-screen, minimaps, etc).

viewport : Viewport

Instance members

Instance member Description

this.IsClearTarget

Full Usage: this.IsClearTarget

Returns: bool
Returns: bool

this.IsDrawBillboardEffect

Full Usage: this.IsDrawBillboardEffect

Returns: bool
Returns: bool

this.IsDrawCustom

Full Usage: this.IsDrawCustom

Returns: bool
Returns: bool

this.IsDrawLine

Full Usage: this.IsDrawLine

Returns: bool
Returns: bool

this.IsDrawLines

Full Usage: this.IsDrawLines

Returns: bool
Returns: bool

this.IsDrawLinesEffect

Full Usage: this.IsDrawLinesEffect

Returns: bool
Returns: bool

this.IsDrawMesh

Full Usage: this.IsDrawMesh

Returns: bool
Returns: bool

this.IsDrawQuadEffect

Full Usage: this.IsDrawQuadEffect

Returns: bool
Returns: bool

this.IsDrawSkinned

Full Usage: this.IsDrawSkinned

Returns: bool
Returns: bool

this.IsDrawSpriteBillboard

Full Usage: this.IsDrawSpriteBillboard

Returns: bool
Returns: bool

this.IsDrawSpriteQuad

Full Usage: this.IsDrawSpriteQuad

Returns: bool
Returns: bool

this.IsSetCamera

Full Usage: this.IsSetCamera

Returns: bool
Returns: bool

this.IsSetViewport

Full Usage: this.IsSetViewport

Returns: bool
Returns: bool

Type something to start searching.