Header menu logo Mibo.Raylib

Programs & Composition

A Program<'Model,'Msg> is a declarative configuration pipeline for your Mibo.Raylib game. It defines how the runtime should orchestrate your state, services, and rendering loop.

Instead of heavy inheritance or global state, you build your program by starting with a core and layering capabilities using high-level combinators.

Core Definition

Every program starts with Program.mkProgram init update.

Typical Composition

Most Mibo.Raylib games follow this "standard" setup in Program.fs:

let program =
  Program.mkProgram init update
  // 1. Configure window settings via GameConfig
  |> Program.withConfig (fun cfg ->
      { cfg with Width = 1280; Height = 720; Title = "My Game"; TargetFPS = 60 })
  // 2. Add Mibo.Raylib services
  |> Program.withAssets   // No-op currently; caching is automatic in IAssets
  |> Program.withTick Tick // Enqueue a message every frame
  // 3. Define the view
  |> Program.withRenderer (fun () ->
      let pipeline = ForwardPbrPipeline(...)
      Renderer3D.create pipeline View.view)
  |> Program.withRenderer (fun () -> Renderer2D.create viewUi)

// Run the game
let game = new RaylibGame<Model, Msg>(program)
game.Run()

Amenities & Services

withAssets

A no-op placeholder for API consistency. Asset loading and caching are handled automatically through IAssets (via ctx.Assets.Texture(...), ctx.Assets.Font(...), etc.) without needing explicit opt-in. Use withAssetsBasePath to configure a root path.

withInput

Registers the IInput service, enabling Keyboard, Mouse, Touch, Gamepad, and Gesture subscriptions.

withSubscription

Connects your Elmish subscriptions to the runtime. The subscription function is re-evaluated every time your model changes, allowing you to dynamically start/stop listeners.

let subscribe (ctx: GameContext) (model: Model) =
    Sub.batch [ ... ]

Program.mkProgram init update
|> Program.withSubscription subscribe

See The Subscription in the Elmish guide for a detailed breakdown.


Runtime & Performance Knobs

Mibo.Raylib gives you fine-grained control over how the game loop behaves.

withTick

Standard per-frame update. Pass a constructor (e.g., Tick) and the runtime will dispatch it every frame with the current GameTime. Use this for UI animations, camera smoothing, or simple timers.

withFixedStep

Ideal for physics or simulation stability. Unlike withTick, which runs exactly once per frame, withFixedStep might run zero, one, or many times per frame to maintain a precise simulation frequency.

|> Program.withFixedStep {
    StepSeconds = 1f / 60f
    MaxStepsPerFrame = 5
    MaxFrameSeconds = ValueSome 0.25f
    Map = PhysicsTick
}

withDispatchMode

Controls when messages are processed. - DispatchMode.Immediate (Default): Messages dispatched during update are processed immediately. - DispatchMode.FrameBounded: Deferred to the next frame. Use this if you want to strictly prevent "re-entrant" updates within a single frame.


Raylib Integration

withRenderer

Adds an IRenderer to the stack. Renderers run in the order they are added. It is common to add a 3D renderer first, followed by a 2D UI renderer.

|> Program.withRenderer (fun () -> Renderer2D.create view)

Advanced Configuration

withConfig

Gives you direct access to the GameConfig record before the game initializes.

|> Program.withConfig (fun cfg ->
    { cfg with Width = 1280; Height = 720; Title = "My Game"; TargetFPS = 60 })

_TIP_: Cumulative Pipeline: You can call withConfig multiple times; each callback is executed in the order it was added, allowing you to layer configuration. IMPORTANT: Platform Specifics: This is where you should put logic that varies by platform. For example, your Desktop project might set a fixed window size, while your Mobile project might handle screen orientation or full-screen modes.

val program: obj
val game: obj
val subscribe: ctx: 'a -> model: 'b -> 'c
val ctx: 'a
val model: 'b
union case ValueOption.ValueSome: 'T -> ValueOption<'T>
Multiple items
module Map from Microsoft.FSharp.Collections

--------------------
type Map<'Key,'Value (requires comparison)> = interface IReadOnlyDictionary<'Key,'Value> interface IReadOnlyCollection<KeyValuePair<'Key,'Value>> interface IEnumerable interface IStructuralEquatable interface IComparable interface IEnumerable<KeyValuePair<'Key,'Value>> interface ICollection<KeyValuePair<'Key,'Value>> interface IDictionary<'Key,'Value> new: elements: ('Key * 'Value) seq -> Map<'Key,'Value> member Add: key: 'Key * value: 'Value -> Map<'Key,'Value> ...

--------------------
new: elements: ('Key * 'Value) seq -> Map<'Key,'Value>

Type something to start searching.