# Cauldron2D.Wx v0.1.3 - Table of Contents

> A Cauldron2D game in a wx window: the desktop front end.

## Pages

- [Cauldron2D.Wx](readme.md)
- [Changelog](changelog.md)

## Modules

- [Cauldron2D.Wx.Client](Cauldron2D.Wx.Client.md): The window that puts a game's worlds in front of one player: a title, a lobby of
arenas, settings, the arena, a summary, the guide and the game's own pages, from a
`Cauldron2D.Client.Game` — the desktop's twin of the terminal's
`Cauldron2D.Drafter.Client`.
- [Cauldron2D.Wx.Client.Screens](Cauldron2D.Wx.Client.Screens.md): What `Cauldron2D.Wx.Client`'s screens look like, as items `Cauldron2D.Wx.Text` draws:
the title, the lobby, the settings, the summary, the guide and a game's own pages,
from the client's state. Pure: nothing here touches wx.
- [Cauldron2D.Wx.Const](Cauldron2D.Wx.Const.md): The wxWidgets constants this package uses, by the names `wx.hrl` gives them, as
functions: the fixed ones as numbers, the ones wx decides at runtime through
wx's `wxe_util:get_const/1` (so `wx:new/0` must have run).
- [Cauldron2D.Wx.Input](Cauldron2D.Wx.Input.md): The keys and buttons a desktop player holds, as the input message the server takes.
- [Cauldron2D.Wx.Keys](Cauldron2D.Wx.Keys.md): A game's keymap as a wx window reads it: `Cauldron2D.Input` key specs become wx key
codes, and mouse buttons stay `{:mouse, button}` as `Cauldron2D.Wx.Input` takes them.
- [Cauldron2D.Wx.Painter](Cauldron2D.Wx.Painter.md): Where everything goes on a canvas: the map's tiles around the focus and the movers, as
sheet indices at pixel positions, for a frame and map in the shapes `Cauldron2D.Net.Wire`
gives.
- [Cauldron2D.Wx.Sheet](Cauldron2D.Wx.Sheet.md): A sprite sheet PNG as wx bitmaps: the sheet scaled up once with nearest-neighbour
sampling, and a bitmap per index cut from it on first use.
- [Cauldron2D.Wx.Text](Cauldron2D.Wx.Text.md): A wx panel that draws text items on a dark canvas and hands its keys to its owner —
the screens a game puts around its worlds, drawn as a game draws them rather than
built from widgets.
- [Cauldron2D.Wx.View](Cauldron2D.Wx.View.md): A wx panel that shows a world: the canvas drawn from the sheet around the focus, the
hud beside or below it if the game sends one, the keys and the pointer as input, the
sound through the speaker.