Geometry (Metroid Prime) - Revision history

Antidote: Surface display list size

2024-10-22T06:45:24Z

Surface display list size

← Older revision		Revision as of 06:45, 22 October 2024
Line 83:		Line 83:
	\|-		\|-
	\| 0x10		\| 0x10
	\| ~~u16~~		\|u32
	~~\| 1~~		\|1
	~~\| '''Mantissa'''~~		\|'''Display List Size and Normal Hint'''
	~~\| Always 0x8000.~~		\|The top bit contains an unused "Normal Hint" while the remaining bits are used to specify the display list size.
	\|-
	~~\| 0x12~~
	~~\| u16~~
	\| 1
	\| '''Display List Size'''
	\| ~~'''Important: this value is not always reliable'''~~
	\|-		\|-
	\| 0x14		\| 0x14
Line 143:		Line 137:
	Note that you'll need to check some settings on the material to read the primitive data properly; the material determines which vertex attributes are present. The material also determines whether the surface is using lightmaps; if it is, then the first UV coordinate will be read out of the short UV array instead of the float one.		Note that you'll need to check some settings on the material to read the primitive data properly; the material determines which vertex attributes are present. The material also determines whether the surface is using lightmaps; if it is, then the first UV coordinate will be read out of the short UV array instead of the float one.

	There is no primitive count value; you'll need to continue reading data until you hit the end of the display list. There are a couple values you can use for reference; either the surface's section size, or the surface's end offset. '~~''Do not use~~ the display list size ~~setting from the surface header, though~~'''~~; it~~'~~s usually~~ accurate~~, but on some models it will give you~~ a ~~size smaller than~~ the ~~table actually is~~, ~~and you'll miss a bunch~~ of ~~data. See Metroid3/4a11192a.CMDL~~ from ~~Prime 1 (icicle Ridley) or Metroid1/05778239.CMDL from Echoes (Samus~~'s ~~gunship) for an example of this~~.		There is no primitive count value; you'll need to continue reading data until you hit the end of the display list. There are a couple values you can use for reference; either the surface's section size, or the surface's end offset. It was originally believed that the display list size was incorrect in a very small number of cases, however it's since been determined that the display list size '''is''' accurate is actually a u32 with the top bit being used as a "Normal Hint", the name of the bit was determined from symbols, but it's actual use has not been determined. Masking the field with 0x7FFFFFFF gives you the correct display list size that works in all cases.

	There are 7 primitive types supported by GX, indicated in the upper 5 bits of the flag value. Note that the game only ever actually uses triangles, triangle strips, and triangle fans; however, all of these primitives are supported by GX and are therefore supported by the game, and so they could be used in custom model files.		There are 7 primitive types supported by GX, indicated in the upper 5 bits of the flag value. Note that the game only ever actually uses triangles, triangle strips, and triangle fans; however, all of these primitives are supported by GX and are therefore supported by the game, and so they could be used in custom model files.

Antidote: Reverted edits by Antidote (talk) to last revision by imported>Darkszero

2023-08-17T23:53:20Z

Reverted edits by Antidote (talk) to last revision by [[User:imported>Darkszero|imported>Darkszero]]

← Older revision		Revision as of 23:53, 17 August 2023
Line 83:		Line 83:
	\|-		\|-
	\| 0x10		\| 0x10
	\| ~~u32~~		\| u16
			\| 1
			\| '''Mantissa'''
			\| Always 0x8000.
			\|-
			\| 0x12
			\| u16
	\| 1		\| 1
	\| '''Display List Size'''		\| '''Display List Size'''
	\| ~~In order to get the display list size you need to mask~~ this value ~~with 0x7FFFFFFF, the purpose of the topbit isn~~'~~t known yet~~		\| '''Important: this value is not always reliable'''
	\|-		\|-
	\| 0x14		\| 0x14
Line 137:		Line 143:
	Note that you'll need to check some settings on the material to read the primitive data properly; the material determines which vertex attributes are present. The material also determines whether the surface is using lightmaps; if it is, then the first UV coordinate will be read out of the short UV array instead of the float one.		Note that you'll need to check some settings on the material to read the primitive data properly; the material determines which vertex attributes are present. The material also determines whether the surface is using lightmaps; if it is, then the first UV coordinate will be read out of the short UV array instead of the float one.

	There is no primitive count value; you'll need to continue reading data until you hit the end of the display list. There are a couple values you can use for reference; either the surface's section size, the display list size, or ~~the surface~~'s ~~end offset~~.		There is no primitive count value; you'll need to continue reading data until you hit the end of the display list. There are a couple values you can use for reference; either the surface's section size, or the surface's end offset. '''Do not use the display list size setting from the surface header, though'''; it's usually accurate, but on some models it will give you a size smaller than the table actually is, and you'll miss a bunch of data. See Metroid3/4a11192a.CMDL from Prime 1 (icicle Ridley) or Metroid1/05778239.CMDL from Echoes (Samus's gunship) for an example of this.

	There are 7 primitive types supported by GX, indicated in the upper 5 bits of the flag value. Note that the game only ever actually uses triangles, triangle strips, and triangle fans; however, all of these primitives are supported by GX and are therefore supported by the game, and so they could be used in custom model files.		There are 7 primitive types supported by GX, indicated in the upper 5 bits of the flag value. Note that the game only ever actually uses triangles, triangle strips, and triangle fans; however, all of these primitives are supported by GX and are therefore supported by the game, and so they could be used in custom model files.

Antidote at 17:45, 3 February 2022

2022-02-03T17:45:08Z

← Older revision		Revision as of 17:45, 3 February 2022
Line 137:		Line 137:
	Note that you'll need to check some settings on the material to read the primitive data properly; the material determines which vertex attributes are present. The material also determines whether the surface is using lightmaps; if it is, then the first UV coordinate will be read out of the short UV array instead of the float one.		Note that you'll need to check some settings on the material to read the primitive data properly; the material determines which vertex attributes are present. The material also determines whether the surface is using lightmaps; if it is, then the first UV coordinate will be read out of the short UV array instead of the float one.

	There is no primitive count value; you'll need to continue reading data until you hit the end of the display list. There are a couple values you can use for reference; either the surface's section size, ~~or the surface's end offset. '''Do not use~~ the display list size ~~setting from~~ the surface ~~header, though'''; it~~'s usually accurate, but on some models it will give you a size smaller than the table actually is, and you'll miss a bunch of data. See Metroid3/4a11192a.CMDL from Prime 1 (icicle Ridley) or Metroid1/05778239.CMDL from Echoes (Samus's gunship) for an example of this.		There is no primitive count value; you'll need to continue reading data until you hit the end of the display list. There are a couple values you can use for reference; either the surface's section size, the display list size, or the surface's end offset.

	There are 7 primitive types supported by GX, indicated in the upper 5 bits of the flag value. Note that the game only ever actually uses triangles, triangle strips, and triangle fans; however, all of these primitives are supported by GX and are therefore supported by the game, and so they could be used in custom model files.		There are 7 primitive types supported by GX, indicated in the upper 5 bits of the flag value. Note that the game only ever actually uses triangles, triangle strips, and triangle fans; however, all of these primitives are supported by GX and are therefore supported by the game, and so they could be used in custom model files.

Antidote at 16:48, 3 February 2022

2022-02-03T16:48:55Z

← Older revision		Revision as of 16:48, 3 February 2022
Line 83:		Line 83:
	\|-		\|-
	\| 0x10		\| 0x10
	\| ~~u16~~		\| u32
	~~\| 1~~
	~~\| '''Mantissa'''~~
	~~\| Always 0x8000.~~
	\|-
	~~\| 0x12~~
	~~\| u16~~
	\| 1		\| 1
	\| '''Display List Size'''		\| '''Display List Size'''
	\| ~~'''Important:~~ this value ~~is not always reliable''~~'		\| In order to get the display list size you need to mask this value with 0x7FFFFFFF, the purpose of the topbit isn't known yet
	\|-		\|-
	\| 0x14		\| 0x14

imported>Darkszero: /* Surface Offsets */

2021-06-17T20:05:12Z

Surface Offsets

← Older revision		Revision as of 20:05, 17 June 2021
Line 53:		Line 53:
	\| u32		\| u32
	\| ''Surface Count''		\| ''Surface Count''
	\| '''Surface Offsets'''		\| '''Surface End Offsets'''
	\| Relative to the start address of the first surface.		\| Relative to the start address of the first surface.
	\|-		\|-

>Aruki: /* Surface */

2018-01-20T17:16:23Z

Surface

← Older revision		Revision as of 17:16, 20 January 2018
Line 91:		Line 91:
	\| u16		\| u16
	\| 1		\| 1
	\| '''~~Primitive Table~~ Size'''		\| '''Display List Size'''
	\| '''Important: this value is not always reliable'''		\| '''Important: this value is not always reliable'''
	\|-		\|-
Line 139:		Line 139:
	\|}		\|}

	The primitive data is a ~~standard~~ GX display list. Each primitive begins with a byte that contains the primitive type in the upper 5 bits, and the vertex format setting in the lower 3; see below for possible settings. After that is a 16-bit vertex count, followed by a series of 16-bit vertex attribute indices.		The primitive data is a GX display list. Each primitive begins with a byte that contains the primitive type in the upper 5 bits, and the vertex format setting in the lower 3; see below for possible settings. After that is a 16-bit vertex count, followed by a series of 16-bit vertex attribute indices.

	Note that you'll need to check some settings on the material to read the primitive data properly; the material determines which vertex attributes are present. The material also determines whether the surface is using lightmaps; if it is, then the first UV coordinate will be read out of the short UV array instead of the float one.		Note that you'll need to check some settings on the material to read the primitive data properly; the material determines which vertex attributes are present. The material also determines whether the surface is using lightmaps; if it is, then the first UV coordinate will be read out of the short UV array instead of the float one.

	There is no primitive count value; you'll need to continue reading data until you hit the end of the ~~primitive table~~. There are a couple values you can use for reference; either the surface's section size, or the surface's end offset. '''Do not use the ~~primitive table~~ size setting from the surface header, though'''; it's usually accurate, but on some models it will give you a size smaller than the table actually is, and you'll miss a bunch of data. See Metroid3/4a11192a.CMDL from Prime 1 (icicle Ridley) or Metroid1/05778239.CMDL from Echoes (Samus's gunship) for an example of this.		There is no primitive count value; you'll need to continue reading data until you hit the end of the display list. There are a couple values you can use for reference; either the surface's section size, or the surface's end offset. '''Do not use the display list size setting from the surface header, though'''; it's usually accurate, but on some models it will give you a size smaller than the table actually is, and you'll miss a bunch of data. See Metroid3/4a11192a.CMDL from Prime 1 (icicle Ridley) or Metroid1/05778239.CMDL from Echoes (Samus's gunship) for an example of this.

	There are 7 primitive types supported by GX, indicated in the upper 5 bits of the flag value. Note that the game only ever actually uses triangles, triangle strips, and triangle fans; however, all of these primitives are supported by GX and are therefore supported by the game, and so they could be used in custom model files.		There are 7 primitive types supported by GX, indicated in the upper 5 bits of the flag value. Note that the game only ever actually uses triangles, triangle strips, and triangle fans; however, all of these primitives are supported by GX and are therefore supported by the game, and so they could be used in custom model files.

>Aruki: /* Surface */

2016-05-23T09:41:03Z

Surface

← Older revision		Revision as of 09:41, 23 May 2016
Line 91:		Line 91:
	\| u16		\| u16
	\| 1		\| 1
	\| '''Primitive ~~table size~~'''		\| '''Primitive Table Size'''
	\| '''Important: this value is not always reliable'''		\| '''Important: this value is not always reliable'''
	\|-		\|-
Line 97:		Line 97:
	\| u32		\| u32
	\| 1		\| 1
	\| '''Model Pointer Storage'''		\| '''Parent Model Pointer Storage'''
	\| Always 0; the game uses this space at runtime to store a pointer to the parent CCubeModel instance		\| Always 0; the game uses this space at runtime to store a pointer to the parent CCubeModel instance
	\|-		\|-

>Aruki: /* Surface */

2016-05-23T09:40:25Z

Surface

← Older revision		Revision as of 09:40, 23 May 2016
Line 101:		Line 101:
	\|-		\|-
	\| 0x18		\| 0x18
	\| 4		\| u32
			\| 1
	\| '''Next Surface Pointer Storage'''		\| '''Next Surface Pointer Storage'''
	\| Always 0; the game uses this space at runtime to store a pointer to the next surface		\| Always 0; the game uses this space at runtime to store a pointer to the next surface

>Aruki: /* Surface */

2016-05-23T09:40:11Z

Surface

← Older revision		Revision as of 09:40, 23 May 2016
Line 65:		Line 65:
	{\| class="wikitable"		{\| class="wikitable"
	! Offset		! Offset
	! ~~Size~~		! Type
	! ~~Description~~		! Count
			! Name
	! Notes		! Notes
	\|-		\|-
	\| 0x0		\| 0x0
	\| ~~0xC~~		\| float
	\| '''Center ~~point~~'''		\| 3
			\| '''Center Point'''
	\| Used for depth sorting on CMDL and used as the eye position for reflections		\| Used for depth sorting on CMDL and used as the eye position for reflections
	\|-		\|-
	\| 0xC		\| 0xC
	\| 4		\| u32
	\| '''Material ID'''		\| 1
			\| '''Material Index'''
	\|		\|
	\|-		\|-
	\| 0x10		\| 0x10
	\| 2		\| u16
			\| 1
	\| '''Mantissa'''		\| '''Mantissa'''
	\| ~~Divide short normals/UVs by this value; always~~ 0x8000		\| Always 0x8000.
	\|-		\|-
	\| 0x12		\| 0x12
	\| 2		\| u16
			\| 1
	\| '''Primitive table size'''		\| '''Primitive table size'''
	\| '''Important: this value is not always reliable'''		\| '''Important: this value is not always reliable'''
	\|-		\|-
	\| 0x14		\| 0x14
	\| 4		\| u32
	\| '''~~CCubeModel pointer storage~~'''		\| 1
	\| Always 0 ~~in resource~~; game uses this space to store parent CCubeModel instance ~~pointer~~		\| '''Model Pointer Storage'''
			\| Always 0; the game uses this space at runtime to store a pointer to the parent CCubeModel instance
	\|-		\|-
	\| 0x18		\| 0x18
	\| 4		\| 4
	\| '''Next ~~surface pointer storage~~'''		\| '''Next Surface Pointer Storage'''
	\| Always 0 ~~in resource~~; game uses this space to store next surface ~~data pointer~~		\| Always 0; the game uses this space at runtime to store a pointer to the next surface
	\|-		\|-
	\| 0x1C		\| 0x1C
	\| 4		\| u32
	\| '''Extra ~~data size~~''' ~~(ES)~~		\| 1
			\| '''Extra Data Size'''
	\| Amount of space taken up by extra data. Always 0 on CMDLs, 0x18 on MREAs.		\| Amount of space taken up by extra data. Always 0 on CMDLs, 0x18 on MREAs.
	\|-		\|-
	\| 0x20		\| 0x20
	\| ~~0xC~~		\| float
	\| '''Surface ~~normal~~'''		\| 3
			\| '''Surface Normal'''
	\| On materials that use the Samus reflection, this is used to project the reflection onto the surface		\| On materials that use the Samus reflection, this is used to project the reflection onto the surface
	\|-		\|-
	\| 0x2C		\| 0x2C
	\| 2		\| u16
	\| {{unknown\|~~'''~~Unknown~~'''~~}}		\| 1
	\| Not in Prime 1		\| {{unknown\|Unknown}}
			\| Not in Prime 1.
	\|-		\|-
	\| 0x2E		\| 0x2E
	\| 2		\| u16
	\| {{unknown\|~~'''~~Unknown~~'''~~}}		\| 1
	\| Not in Prime 1		\| {{unknown\|Unknown}}
			\| Not in Prime 1.
	\|-		\|-
	\| 0x30		\| 0x30
	\| ES		\| u8
	\| '''Extra ~~data~~'''		\| ''Extra Data Size''
	\| Empty on CMDL; contains a bounding box used for depth sorting on MREA		\| '''Extra Data'''
			\| Empty on CMDL; contains a bounding box used for depth sorting on MREA.
	\|-		\|-
	\| colspan=4 {{unknown\|End of surface header; pad to multiple of 32 before primitive data starts}}		\| colspan=5 {{unknown\|End of surface header; pad to multiple of 32 before primitive data starts}}
	\|}		\|}

Line 146:		Line 157:
	\|-		\|-
	\| 0x98		\| 0x98
	\| Triangle ~~strip~~		\| Triangle Strip
	\|-		\|-
	\| 0xA0		\| 0xA0
	\| Triangle ~~fan~~		\| Triangle Fan
	\|-		\|-
	\| 0xA8		\| 0xA8
Line 155:		Line 166:
	\|-		\|-
	\| 0xB0		\| 0xB0
	\| Line ~~strip~~		\| Line Strip
	\|-		\|-
	\| 0xB8		\| 0xB8

>Aruki: /* Surface Group IDs */

2016-05-23T09:35:38Z

Surface Group IDs

← Older revision		Revision as of 09:35, 23 May 2016
Line 183:		Line 183:
	=== Surface Group IDs ===		=== Surface Group IDs ===

	This section (and the following one) appears in [[MREA (File Format)\|MREA files]] starting in Metroid Prime 2. In MP2, surfaces in world geometry are now merged together to create as few meshes as possible (meshes are now only split when the vertex count exceeds 65535). Two extra data sections are present to manage the resulting super-meshes to enable the game to extract smaller meshes out when needed.		This section (and the following one) appears in [[MREA (File Format)\|MREA files]] starting in Metroid Prime 2. Starting in MP2, surfaces in world geometry are now merged together to create as few meshes as possible (meshes are now only split when the vertex count exceeds 65535). Two extra data sections are present to manage the resulting super-meshes to enable the game to extract smaller meshes out when needed.

	This first section assigns a group ID to each surface, forming smaller meshes. This ID is used in various places that operate on world geometry, including in the [[AROT (MREA Section)\|area octree]] as well as in the [[EGMC (File Format)\|EGMC format]], among others.		This first section assigns a group ID to each surface, forming smaller meshes. This ID is used in various places that operate on world geometry, including in the [[AROT (MREA Section)\|area octree]] as well as in the [[EGMC (File Format)\|EGMC format]], among others.