Sprites.Media.Text

Sprites.Media.Text.Atlas Array

Sprites.Media.Text.Atlas(font)

The atlas of a font: a list of glyphs, each a flat one bit cell list of the font's cell size, in charset order. Grid.Two.Tile places a glyph by its index, so the atlas is the tile set a character screen draws from. A boot helper over DecodeGlyph, plain data built once as the editor opens.

Returns a plain list of glyph cell lists, one per character.

Sprites.Media.Text.Blank Undefined

The blank cell of a character list: an absent value, undefined. A blank cell shows the paper colour and no glyph, and a fresh inline screen starts every cell blank.

undefined

Sprites.Media.Text.BlankDocument Object

Sprites.Media.Text.BlankDocument(platform, mode, first, w, h)

A new blank text document: every character, ink, paper and special cell undefined, so an inline screen opens clear and reads the default colours. A boot factory a page hands to the store, plain data rather than a live reactive.

Returns a plain { platform, mode, w, h, first, character, ink, paper, special } document.

Sprites.Media.Text.CellIndex Value

Sprites.Media.Text.CellIndex(w, x, y)

The flat index of a cell from its column and row, on a screen of a given width: row times width plus column. A composite over Sprites.Maths, for a handler that lays one cell.

Returns a reactive number, the cell's index in a flat list.

Sprites.Media.Text.CharObjects Array

Sprites.Media.Text.CharObjects(atlas)

A list of plain character objects for the character palette: each glyph of the font as a { pixels } of its decoded one bit cells, in charset order. The font editor's characters window reads this list to draw the glyphs the char tool picks from. A boot helper over the atlas, plain data built once as the editor opens.

Returns a plain list of { pixels } glyph objects.

Sprites.Media.Text.Colourise Value

Sprites.Media.Text.Colourise(colours, indexed, slots)

A colour grid resolved to packed RGBA: each cell mapped through the slots for an indexed machine, or kept as it stands for a free one. A composite over Sprites.Array.Lookup, one node over the whole array, so a slot index becomes its colour while a packed colour passes through, and only the cells whose colour changed pass it on. indexed chooses the path.

Returns a reactive { w, h, cells } grid of packed colours.

Sprites.Media.Text.DecodeGlyph Array

Sprites.Media.Text.DecodeGlyph(bytes, w, h)

One glyph decoded from a machine charset row list to a flat one bit cell list: for each row a byte, top row first, the leftmost pixel the top bit, a set bit one and a clear bit zero. A boot helper: it reads the raw bytes to build the atlas the screen tiles from.

Returns a plain list of w times h one bit cells.

Sprites.Media.Text.DefaultInk Number

The default ink of a fresh screen when the machine names none: white, as a packed RGBA integer, each byte a channel. A machine pack overrides it with its own colour.

0xFFFFFFFF

Sprites.Media.Text.DefaultPaper Number

The default paper of a fresh screen when the machine names none: black, as a packed RGBA integer, each byte a channel. A machine pack overrides it with its own colour.

0x000000FF

Sprites.Media.Text.Editor Void

Sprites.Media.Text.Editor(data, thumb, info, font, charWidth, charHeight, optionalModes, optionalModeName, optionalSlots, wholeCell, optionalDefaultInk, optionalDefaultPaper)

The text screen editor. Builds the screen view on the host, the pan and zoom overlay, the Tools window, the ink and paper palette windows, the file, history and characters panels, and the info window. It edits one screen, laying characters and attributes into the cells. It reuses the shared pixel parts under Sprites.Media.Sprite and the font editor's characters window, so a screen drives them the way a sprite drives the canvas. It builds interface and returns nothing; the doc fields it is given are where the edits land.

Returns nothing.

Sprites.Media.Text.EffectiveColour Value

Sprites.Media.Text.EffectiveColour(colours, wholeCell, fallback)

The resolved colour of every cell after the attribute model. For an inline machine, wholeCell true, each cell takes the nearest set value to its left, or the fallback; for a per cell machine each cell takes its own value, or the fallback when absent. A composite over Grid.Two.FillAcross, Grid.Two.Default and Sprites.Logic.Select, each one node over the whole array.

Returns a reactive { w, h, cells } grid of the resolved colour of every cell.

Sprites.Media.Text.NewDocument Object

Sprites.Media.Text.NewDocument(platform, mode, font, w, h)

A new text document seeded to spaces: every character cell the space glyph, every ink, paper and special cell undefined, so a per cell screen opens on the machine's blank screen at the default colours. A boot factory, plain data for the store.

Returns a plain text document seeded to spaces.

Sprites.Media.Text.PaintChar Value

Sprites.Media.Text.PaintChar(data, w, h, col, row, brush, wholeCell)

The screen with one character cell set to a glyph index, at a column and a row. When wholeCell is true a character and an attribute are exclusive in a cell, so laying a character clears the ink, paper and special of that cell; otherwise only the character changes. A composite over SetCell, Object.With and Sprites.Logic.Select, for the char tool.

Returns a reactive screen-data value with the one cell changed.

Sprites.Media.Text.PaintInk Value

Sprites.Media.Text.PaintInk(data, w, h, col, row, brush, wholeCell)

The screen with one cell's ink set to a colour, at a column and a row. When wholeCell is true the cell carries an attribute alone, so the character, paper and special of that cell clear; otherwise only the ink changes. A composite over SetCell, Object.With and Sprites.Logic.Select, for the ink tool.

Returns a reactive screen-data value with the one cell changed.

Sprites.Media.Text.PaintPaper Value

Sprites.Media.Text.PaintPaper(data, w, h, col, row, brush, wholeCell)

The screen with one cell's paper set to a colour, at a column and a row. When wholeCell is true the cell carries an attribute alone, so the character, ink and special of that cell clear; otherwise only the paper changes. A composite over SetCell, Object.With and Sprites.Logic.Select, for the paper tool.

Returns a reactive screen-data value with the one cell changed.

Sprites.Media.Text.RenderData Value

Sprites.Media.Text.RenderData(data, atlas, charWidth, charHeight, indexed, slots, wholeCell, defaultInk, defaultPaper)

The whole screen of a document drawn to packed RGBA pixels: it reads the four lists and the size, resolves the ink and paper by the attribute model, and tiles the glyphs coloured by them. A composite over EffectiveColour and ScreenPixels, the value the canvas and the thumbnail read. It takes the document, so it serves the live screen and a freshly painted candidate alike.

Returns a reactive { w, h, cells } grid of packed pixels.

Sprites.Media.Text.ResizeAll Value

Sprites.Media.Text.ResizeAll(data, width, height)

The same screen resized to a new width and height in characters, cropping or padding every one of the four lists with the blank cell, undefined. A composite over Grid.Two.Resize and ReadOnly, keeping the platform, mode and first code point.

Returns a reactive screen-data value at the new size.

Sprites.Media.Text.ResizeList Value

Sprites.Media.Text.ResizeList(data, key, oldW, oldH, width, height)

One field of the document resized to a new width and height, cropping or padding with the blank cell. A composite over Grid.Two.Resize, shared by the four lists in ResizeAll.

Returns a reactive list at the new size.

Sprites.Media.Text.ScreenPixels Value

Sprites.Media.Text.ScreenPixels(characters, effectiveInk, effectivePaper, atlas, charWidth, charHeight, indexed, slots)

The whole screen drawn to packed RGBA pixels: every cell's glyph stamped from the atlas, its set pixels the resolved ink and its clear pixels the resolved paper. A composite: it tiles the glyph mask with Grid.Two.Tile, resolves and stretches the ink and paper to pixel size with Colourise and Grid.Two.Stretch, and picks ink or paper per pixel with Grid.Two.Choose.

Returns a reactive { w, h, cells } grid of packed pixels, w times charWidth by h times charHeight.

Sprites.Media.Text.SetCell Value

Sprites.Media.Text.SetCell(cells, w, h, col, row, value)

One flat cell list with a single cell set to a value, at a column and a row on a screen of a width and a height. A composite over Grid.Two.Set, which clips a cell outside the screen, so an out of bounds paint changes nothing.

Returns a reactive cell list with the one cell changed.

Sprites.Media.Text.Space Number

The code point of the space character, the first printable character. A new screen seeds every cell to the space glyph, so it opens on the machine's blank screen.

32

Sprites.Media.Text.Summary String

Sprites.Media.Text.Summary(modeName, w, h)

The meta info summary for a text screen: its mode and screen size as one short string, for the meta record a listing reads. A composite over Sprites.Text.Concat and Sprites.Logic.Select, dropping the mode when there is none.

Returns a reactive summary string, for example Standard · 32×24.

Sprites.Media.Text.CellImage Void

Sprites.Media.Text.CellImage(index, characterCells, inkCells, paperCells, atlas, blankGlyph, charWidth, charHeight, width)

One character cell drawn as an image: the glyph at the cell coloured by the cell's resolved ink and paper, placed as a PNG in the surface with Sprites.Image.Draw.Image. So a whole character is one image element, not a square per pixel. A blank cell, an absent character index, shows the paper alone. A composite over Sprites.Array.Choose and Sprites.Image.Draw.Image.

Returns nothing.

Sprites.Media.Text.CellImages Void

Sprites.Media.Text.CellImages(characterCells, inkCells, paperCells, atlas, blankGlyph, charWidth, charHeight, width, count)

The cell images: one image per character cell, built with Repeat over the cell count, so a resize rebuilds the set and each cell follows its own character, ink and paper. A composite over CellImage.

Returns nothing.

Sprites.Media.Text.GridColour String

The colour of the grid on the character cells, a faint black.

'rgba(0, 0, 0, 0.35)'

Sprites.Media.Text.GridLineWidth Number

The width of the grid lines, in world units, where one unit is one pixel of a character. The grid falls on the character cells, not the pixels.

0.4

Sprites.Media.Text.OutlineColour String

The colour of the outline around the whole screen, a dark green.

'#020d02'

Sprites.Media.Text.OutlineWidth Number

The width of the outline around the whole screen, in world units.

0.7

Sprites.Media.Text.View Void

Sprites.Media.Text.View(characterCells, inkCells, paperCells, atlas, blankGlyph, charWidth, charHeight, width, height, pan, show)

The screen view: a checkerboard backdrop, then a Vector over it with one image per character cell, a grid on the character cells, and a dark outline around the screen. One world unit is one pixel of a character, so a cell spans charWidth by charHeight units. A composite over CellImages, Sprites.Image.Draw.Grid and Sprites.Image.Draw.Rectangle.

Returns nothing.