OBD:TXMP

ONI BINARY DATA TXMB << Other file types >> TxtC TXMP : Texture Map switch to XML:TXMP page Overview @ Oni Stuff

TXMP is the only known instance type that is interpreted differently by the three kinds of Oni engines on the three plaftorms (Windows, Mac and PS2).

The difference between "PC" (Windows retail) and "Mac" (Windows demo and Mac proper) is minor, at least from the point of view of disk storage (the structural difference is limited to runtime fields grouped at the end of the instance, which is why they haven't been documented or implemented in OniSplit). A more obvious difference is that "PC" TXMPs store their pixel data in the .raw file, and "Mac" TXMPs use the .sep file, but this merely amounts to using different fields within the same structure. Thus, even though the template checksums for "Mac" and "PC" are different, both formats can easily be described in common.

The PS2 implementation is significantly different from the other two, in that it systematically uses indexed colors: instead of color being stored in the pixel data itself, each pixel is merely an 8-bit index into a 256-color palette (palettes are stored per-level, in files named level0_palette.pal etc). This difference is detailed in a separate section at the bottom of the page.

Windows and Mac TXMP

Offset	Type	Raw Hex	Value	Description
0x00	res_id	01 1F 00 00	31	00031-rl_1.TXMP
0x04	lev_id	01 00 00 06	3	level 3
0x08	char[128]	rl_1		name of the texture; unused
0x88	int32	00 10 00 00	0x1000	options; possible option flags (from left to right): 0x01 00 00 00 - has mipmaps 0x04 00 00 00 - U wrapping disabled 0x08 00 00 00 - V wrapping disabled 0x10 00 00 00 - ignored 0x40 00 00 00 - animation order: play back to back (frames 0 to n then n-1 to 0) 0x80 00 00 00 - animation order: play in random order 0x00 01 00 00 - animation time: add local (particle) time (see below) 0x00 02 00 00 - has environment map texture 0x00 04 00 00 - additive alpha blending 0x00 10 00 00 - little endian data 0x00 40 00 00 - animation time: ignore game time (see below) 0x00 80 00 00 - effect: shield (blue) 0x00 00 01 00 - effect: invisibility 0x00 00 02 00 - effect: daodan shield (red)
0x8C	int16	80 00	128	width of the image in pixels
0x8E	int16	80 00	128	height of the image in pixels
0x90	int32	01 00 00 00	1	texture format #1 (RGB555); see below for list of available formats. 0 - ARGB4444, 16 bits/pixel (stored as a little-Endian int16, swaps to big Endian at runtime on Mac) Four 4-bit channels, with bitmasks 0x000F (Blue), 0x00F0 (Green), 0x0F00 (Red) and 0xF000 (Alpha). 1 - RGB555, 16 bits/pixel (stored as a little-Endian int16, swaps to big Endian at runtime on Mac) Three 5-bit channels, with bitmasks 0x001F (Blue), 0x03E0 (Green) and 0x7C00 (Red). N.B. The high bit (0x8000) is unused, but the convention is to always set it to 1. 2 - ARGB1555, 16 bits/pixel (stored as a little-Endian int16, swaps to big Endian at runtime on Mac) Three 5-bit channels with bitmasks 0x001F (Blue), 0x03E0 (Green) and 0x7C00 (Red), 1-bit alpha (0x8000). 3 (never used in Vanilla TXMPs) - I8, 8 bits/pixel, stored as a single byte. Monochrome "intensity" (256 levels of gray). 4 (never used in Vanilla TXMPs) - I1, 8 pixels/byte. Pixel rows, bottom to top. Monochrome "intensity" (black-or-white). 5 (never used in Vanilla TXMPs) - A8, 8 bits/pixel, stored as a single byte. Standalone alpha (256 levels of opacity). 6 (never used in Vanilla TXMPs) - A4I4, 8 bits/pixel, stored as a single byte. Intensity (bit mask 0x0F), alpha (0xF0). 7 (never used in Vanilla TXMPs) - ARGB8888, 32 bits/pixel (stored as a little-Endian int32, swaps to big Endian at runtime on a PowerPC Mac) Four 8-bit channels, with bitmasks 0x000000FF (Blue), 0x0000FF00 (Green), 0x00FF0000 (Red) and 0xFF000000 (Alpha). 8 - RGB888, 32 bits/pixel (stored as a little-Endian int32, swaps to big Endian at runtime on Mac) Three 8-bit channels, with bitmasks 0x000000FF (Blue), 0x0000FF00 (Green) and 0x00FF0000 (Red). N.B. The high byte (0xFF000000) is unused, but the convention is to always set it to 0x00. 9 - S3TC/DXT1, RGB565 compressed 4 times (GL_COMPRESSED_RGB_S3TC_DXT1_EXT OpenGL texture format) 10 (never used in Vanilla TXMPs) - RGB_Bytes, 24 bits/pixel, stored as 3 consecutive bytes: first Red, then Green, then Blue. N.B. Unlike for RGB888 (type 8), the storage is compact, with no unused alpha bit. 11 (never used in Vanilla TXMPs) - RGBA_Bytes, 32 bits/pixel, stored as 4 consecutive bytes: first Red, then Green, then Blue, then Alpha. 12 (never used in Vanilla TXMPs) - RGBA5551, 16 bits/pixel (stored as a little-Endian int16, swaps to big Endian at runtime on Mac) Three 5-bit channels with bitmasks 0x003E (Blue), 0x07C0 (Green) and 0xF800 (Red), 1-bit alpha (0x0001). 13 (never used in Vanilla TXMPs) - RGBA4444, 16 bits/pixel (stored as a little-Endian int16, swaps to big Endian at runtime on Mac) Four 4-bit channels, with bitmasks 0x00F0 (Blue), 0x0F00 (Green), 0xF000 (Red) and 0x000F (Alpha). 14 (never used in Vanilla TXMPs) - RGB565, 16 bits/pixel (stored as a little-Endian int16, swaps to big Endian at runtime on Mac) Two 5-bit channels with bitmasks 0x001F (Blue) and 0xF800 (Red), 6-bit Green channel (0x07E0). 15 (never used in Vanilla TXMPs) - ABGR1555, 16 bits/pixel (stored as a little-Endian int16, swaps to big Endian at runtime on Mac) Three 5-bit channels with bitmasks 0x001F (Red), 0x03E0 (Green) and 0x7C00 (Blue), 1-bit alpha (0x8000).
0x94	link	00 00 00 00	unused	link to a TXAN file; used if this texture is animated
0x98	link	00 00 00 00	unused	link to a TXMP file that contain the environment map
0x9C	offset	20 00 00 00	00 00 00 20	at this position starts the texture part in the raw file (Windows retail only)
0xA0	offset	00 00 00 00	unused	at this position starts the texture part in the separate file (Windows demo and Mac only)
0xA4	char[12]	AD DE	dead	The layout of these 12 bytes is different for the "PC" and "Mac" versions (i.e. Windows retail vs. Windows demo and Mac): For a Mac or Windows demo TXMP, the four bytes at 0xA4-A7 are "00 00 00 00" instead of "AD DE AD DE", and correspond to a "material type" attributed at runtime (from TMBD), which is then used for impact/breakability lookup. The Windows retail TXMPs apparently have no such "material type" field. The fields at 0xA8-AF (for Windows demo and Mac) or 0xA4-AB (for Windows retail) are used only at runtime (and somehow obfuscated by "DEAD" when written to disk). Judging by the Windows demo and Mac engine, we can assume they are the same in both engines, and serve for rendering optimization (there is a texture name pointer, a "dirty" flag stored as a byte and 3 extra bytes used as flags). For Windows retail, the four bytes at 0xAC-AF are completely unused (not part of the template). Since runtime fields are grouped at the end, PC and Mac TXMPs are treated by OniSplit under the same template, merely switching between the .raw and .sep links, and blanking out everything past 0xA4.
0xB0	char[16]	AD DE	dead	completely unused bytes (not part of the PC or Mac TXMP template)

Effect options

"Shield", "Invisibility" and "Daodan shield" options do not affect the texture reading/drawing in any way. The texture data is still RGB555 or whatever format the texture format field says it is. The effect of these flags is that the engine uses vertex shading with a colour that varies with time.

Animation time

When using animated textures the image to display is selected using the game time and animation speed. For textures that are used by particles the local (particle) time can be used either to replace or offset the game time.

Pixel storage order

Pixels are stored in row-major order, meaning that all the pixels forming a scanline (image row) are grouped together (stored in left-to right order); the rows are stored in bottom-to-top order (see illustration below).

In the case of the DXT1 storage format, the row-major, left-to-right, bottom-to-top order applies to the 4x4 blocks composing the image, and also inside each 4x4 block for the storage of 2-bit pixels.

In the case of the I1 format (several pixels per byte), the row-major, left-to-right, bottom-to-top order applies to the 1-bit pixels composing the image.

Pixel arrangement

how it's stored		how you'll see it

PS2 implementation

The TXMP layout is mostly the same on the PS2 platform as on the other two, with differences only in the last few bytes.

• There are 4 extra bytes of storage as compared to a Windows demo and Mac TXMP (which is already 4 bytes larger than a Windows retail TXMP).
• The extra 4 bytes come from a palette index (int32) inserted at 0x90, before the pixel format (which is shifted to 0x94 along with everything else that follows).
• Valid palette indices start at 1. Palettes are stored per-level in level#_palette.pal files. Each palette consists of 256 32-bit colors and takes up 1024 bytes.
• The level#_palette.pal files have between 85 and 179 palettes, not counting the first palette (index 0) at the start of each .pal file, which is always blank.
• The pixel format (shifted to 0x94) has only two variants: 0x10 for opaque textures, meaning 32-bit RGB with ignored alpha, or 0x11 for transparent textures.
• The pixel data (color indices) can be stored either in the .raw file (pointer field at 0xA0) or in the .sep file (pointer at 0xA4). See below for an overview.

Here is how the end of the rl_1 TXMP looks in level3_Final.dat of the English retail PS2 version.

Offset	Type	Raw Hex	Value	Description
0x90	int32	56 00 00 00	86	index of the 256-color palette used by this texture (starts at 0x15800 in level3_palette.pal)
0x94	int32	10 00 00 00	16	palette pixel format #16 (32-bit RGB, with inactive alpha); the other recurrent format is #17 (32-bit RGBA)
0x98	link	00 00 00 00	unused	link to a TXAN file; used if this texture is animated
0x9C	link	00 00 00 00	unused	link to a TXMP file that contains the environment map
0xA0	offset	C0 05 00 00	00 00 05 C0	position of the pixel data in the .raw file
0xA4	offset	00 00 00 00	unused	position of the pixel data in the .sep file (unused)
0xA8	int32	00 00 00 00	0	always 0; supposedly the same "material type" (set at runtime) as for Windows demo and Mac
0xAC	char[4]	AD DE AD DE	dead	supposedly the same texture name pointer (used at runtime) as for Windows demo and Mac
0xB0	char[4]	AD DE AD DE	dead	supposedly the same rendering optimization flags (runtime) as for Windows demo and Mac
0xB4	char[12]	AD DE	dead	completely unused bytes (not part of the template)

Alternative use of .raw or .sep storage

Unlike for PC or Mac game data (where pixel data is stored exclusively in .raw or exclusively in .sep for all TXMPs), PS2 TXMPs use .raw and .sep storage alternatively, depending on the TXMP. The engine apparently uses the .sep pointer only if there is no .raw pointer (or vice-versa).

Examples of textures using .sep storage are: all fly-in portraits; all splashscreen components; some illustrations in Konoko's Data Comlink (namely, combat move illustrations and item illustrations; objectives and weapon illustrations use .raw storage).

Environment/character/particle TXMPs seem to be using .raw storage consistently (not checked beyond level1_Final). As a notable anomaly, .sep storage is used for the following three textures (console screens) in level0_Final: _CON_SAVEGAME (main TXMP only; the animation frames use .raw storage), _CON_SAVEGAME_USED, _CON_USED.

Notes

ONI BINARY DATA
TXMB << Other file types >> TxtC
TXMP : Texture Map
General file