F3DZEX2/Opcode Details - Revision history

Mzxrules at 17:36, 23 March 2021

2021-03-23T17:36:54Z

Mzxrules at 16:17, 23 March 2021

2021-03-23T16:17:02Z

PPLToast: PPLToast moved page F3DZEX/Opcode Details to F3DZEX2/Opcode Details

2020-09-04T09:05:51Z

PPLToast moved page F3DZEX/Opcode Details to F3DZEX2/Opcode Details

JackWalker: Fixed typo.

2020-01-29T02:28:58Z

Fixed typo.

CloudMax: Updating table to use new color classes

2019-10-14T15:31:26Z

Updating table to use new color classes

Mzxrules: /* 0xDC — G_MOVEMEM */

2019-04-28T10:15:51Z

‎0xDC — G_MOVEMEM

Mzxrules: /* 0xDB — G_MOVEWORD */

2019-02-21T07:34:41Z

‎0xDB — G_MOVEWORD

Mzxrules: fixed for real

2019-02-18T20:37:59Z

fixed for real

Mzxrules: /* Argument Mapping */ fix on argument

2019-02-18T11:42:43Z

‎Argument Mapping: fix on argument

Mzxrules: /* 0x00 — G_NOOP */

2019-02-09T06:27:33Z

‎0x00 — G_NOOP

@@ Line 900: / Line 900: @@
 * <tt>G_MDSFT_RENDERMODE   = 3</tt>
-The structure of the lower modes is provided in the [[F3DZEX|main page]].
+The structure of the lower modes is provided in the [[F3DZEX2|main page]].
 ==<tt>0xE3</tt> — <tt>G_SETOTHERMODE_H</tt>==
@@ Line 950: / Line 950: @@
 * <tt>G_MDSFT_PIPELINE    = 23</tt>
-The layout of the high word is describe in the [[F3DZEX|main page]].
+The layout of the high word is describe in the [[F3DZEX2|main page]].
 ==<tt>0xE4</tt> — <tt>G_TEXRECT</tt>==
@@ Line 1,330: / Line 1,330: @@
 The difference from either <tt>E3</tt> or <tt>E2</tt> is that this command sets all the bits in both halves of the RDP word (that is, this opcode has no way of limiting what bits are actually affected).
-See the [[F3DZEX|main page]] for what the other mode bits mean
+See the [[F3DZEX2|main page]] for what the other mode bits mean
 ==<tt>0xF0</tt> — <tt>G_LOADTLUT</tt>==
@@ Line 1,838: / Line 1,838: @@
 This is performed on all sets of parameters. <tt>a0</tt>, <tt>b0</tt>, <tt>c0</tt>, and <tt>d0</tt>; <tt>a1</tt>, <tt>b1</tt>, <tt>c1</tt>, and <tt>d1</tt>; <tt>Aa0</tt>, <tt>Ab0</tt>, <tt>Ac0</tt>, and <tt>Ad0</tt>; and <tt>Aa1</tt>, <tt>Ab1</tt>, <tt>Ac1</tt>, and <tt>Ad1</tt> are those sets of parameters.
-The values taken in each parameter are part of an enumeration of potential sources for that value, but which differs for various pieces: all of the color <tt>A</tt>, <tt>B</tt>, <tt>C</tt>, <tt>D</tt> components have different enumerations, and alpha <tt>C</tt> is different from the other alpha components. See the [[F3DZEX|main page]] on the color combiner for details on how it works.
+The values taken in each parameter are part of an enumeration of potential sources for that value, but which differs for various pieces: all of the color <tt>A</tt>, <tt>B</tt>, <tt>C</tt>, <tt>D</tt> components have different enumerations, and alpha <tt>C</tt> is different from the other alpha components. See the [[F3DZEX2|main page]] on the color combiner for details on how it works.
 ==<tt>0xFD</tt> — <tt>G_SETTIMG</tt>==
@@ Line 1,870: / Line 1,870: @@
 This opcode sets the location in RAM of the image that will be used when using any of the texture loading opcodes. <tt>imgaddr</tt> is the RAM location of the image to be pulling textures from. <tt>width</tt> is the width of the image, necessary in finding out when next rows start. The maximum allowed with is <tt>4096</tt>, or <tt>0x1000</tt>. <tt>www</tt> is the width minus one so that it can fit within three nybbles.
-<tt>fmt</tt> and <tt>siz</tt> are the usual image format enumerations, explained on [[F3DZEX|the main page]].
+<tt>fmt</tt> and <tt>siz</tt> are the usual image format enumerations, explained on [[F3DZEX2|the main page]].
 ==<tt>0xFE</tt> — <tt>G_SETZIMG</tt>==
@@ Line 1,924: / Line 1,924: @@
 ===Description===
-Sets the location of the color framebuffer, usually a framebuffer that's displayed to the screen. The color buffer is set to RAM location <tt>imgaddr</tt>, with a width of <tt>width</tt>. <tt>fmt</tt> and <tt>siz</tt> are the typical image format enumerations, described on [[F3DZEX|the main page]].
+Sets the location of the color framebuffer, usually a framebuffer that's displayed to the screen. The color buffer is set to RAM location <tt>imgaddr</tt>, with a width of <tt>width</tt>. <tt>fmt</tt> and <tt>siz</tt> are the typical image format enumerations, described on [[F3DZEX2|the main page]].
 The location is usually some place set as the framebuffer to show (which is not handled by display lists), but oftentimes will be set to a depth buffer. This is usually done to fill (aka clear) the depth buffer in fill mode.

@@ Line 1: / Line 1: @@
 {{subpage}}
-This is a detailed explanation of all the opcodes known in F3DEX2 (presumed very similar, if not identical, to F3DZEX). Parameters are explained in terms of various macros N64 programmers had access to, since those parameters will in quite a few cases be easier to describe than their transformed version in the microcode.
+This is a detailed explanation of all the opcodes known in F3DZEX2. Parameters are explained in terms of various macros N64 programmers had access to, since those parameters will in quite a few cases be easier to describe than their raw GBI form.
 ==<tt>0x00</tt> — <tt>G_NOOP</tt>==

@@ Line 451: / Line 451: @@
 ! Microcode !! Reference Function
 |-
-| <tt>D9cccccc ssssssss</tt> || <tt>gsSPGeomentryMode(clearbits, setbits)</tt>
+| <tt>D9cccccc ssssssss</tt> || <tt>gsSPGeometryMode(clearbits, setbits)</tt>
 |-
 |}

@@ Line 428: / Line 428: @@
 | <tt>num</tt> || <tt>num * 64</tt> || <tt>aaaaaaaa / 64</tt> || The number of matrices to pop
 |-
-| <tt>which</tt> || style="background-color:#a2a2a2;"| Ignored || style="background-color:#a2a2a2;"| Ignored || Specifies which matrix stack to pop from
+| <tt>which</tt> || class="bg-no"| Ignored || class="bg-no"| Ignored || Specifies which matrix stack to pop from
 |-
 |}
@@ Line 784: / Line 784: @@
 ! Function Param !! To Microcode !! From Microcode !! Explanation
 |-
-|colspan=4 style="background-color:#a2a2a2; text-align:center;"| <i><tt>pp</tt> determined by choice of function; see below</i>
+|colspan=4 class="bg-info" style="text-align:center;"| <i><tt>pp</tt> determined by choice of function; see below</i>
 |-
 | <tt>dl</tt> || <tt>dl</tt> || <tt>dddddddd</tt> || Address of new display list to jump to

@@ Line 721: / Line 721: @@
 ===Description===
-Takes a block of memory <tt>size</tt> bytes in size from <tt>address</tt> and puts it in the location pointed to by <tt>index</tt> and <tt>offset</tt>.
+Transfers a block of data from RDRAM to DMEM, in 8 byte chunks. <tt>Size</tt> is the number of bytes to copy from RDRAM <tt>address</tt>, placing it at the DMEM location pointed to by <tt>index</tt>, plus <tt>offset</tt>.
 <tt>index</tt> is an index into a table of addresses of DMEM. Given enumerations for <tt>index</tt> are:

← Older revision	Revision as of 09:05, 4 September 2020
(No difference)

@@ Line 526: / Line 526: @@
 ! Microcode !! Reference Function
 |-
-| <tt>DBiioooo dddddddd</tt> || <tt>gsMoveWd(index, offset, data)</tt>
+| <tt>DBiioooo dddddddd</tt>
 |-
 |}
@@ Line 548: / Line 550: @@
 <tt>index</tt> is an index into a table of DMEM addresses. The enumerations given for this for F3DEX2 are:
-* <tt>G_MW_MATRIX    = 0x00</tt>
+{|class="wikitable" {{ts|ml5|font-family: monospace}}
-* <tt>G_MW_NUMLIGHT  = 0x02</tt>
+! Define || Value
-* <tt>G_MW_CLIP      = 0x04</tt>
+|-
-* <tt>G_MW_SEGMENT   = 0x06</tt>
+|G_MW_MATRIX || 0x00
-* <tt>G_MW_FOG       = 0x08</tt>
+|-
-* <tt>G_MW_LIGHTCOL  = 0x0A</tt>
+|G_MW_NUMLIGHT || 0x02
-* <tt>G_MW_FORCEMTX  = 0x0C</tt>
+|-
-* <tt>G_MW_PERSPNORM = 0x0E</tt>
+|G_MW_CLIP || 0x04
-The <tt>offset</tt> is, as the name suggests, an offset from the address that <tt>index</tt> resolves to. Enumerations are also provided for this value, for each of the enumerated <tt>index</tt> values. (XXX where to put them? It's a bit of a list.)
+==== Values ====
 ==<tt>0xDC</tt> — <tt>G_MOVEMEM</tt>==

@@ Line 380: / Line 380: @@
 ! Microcode !! Reference Function
 |-
-| <tt>D700____ sssstttt</tt><br/><tt>____ -> 00LL Lddd nnn0 (binary)</tt> || <tt>gsSPTexture(scaleS, scaleT, level, tile, on)</tt>
+| <tt>D700____ sssstttt</tt><br/><tt>____ -> 00LL Lddd nnnn nnn0 (binary)</tt> || <tt>gsSPTexture(scaleS, scaleT, level, tile, on)</tt>
 |-
 |}
@@ Line 392: / Line 392: @@
 | <tt>tile</tt> || <tt>tile & 0x07</tt> || <tt>ddd</tt> || Tile descriptor number
 |-
-| <tt>on</tt> || <tt>on & 0x07</tt> || <tt>nn</tt> || Decides whether to turn the given texture on or off
+| <tt>on</tt> || <tt>on & 0x7F</tt> || <tt>n</tt> || Decides whether to turn the given texture on or off
 |-
 | <tt>scaleS</tt> || <tt>scaleS</tt> || <tt>ssss</tt> || Scaling factor for the S-axis (horizontal)

@@ Line 11: / Line 11: @@
 ! Microcode !! Reference Function
 |-
-| <tt>00000000 tttttttt</tt> || <tt>gsDPNoOpTag(tag)</tt>
+| <tt>00000000 tttttttt</tt> || <tt>gsDPNoOp()</tt><br><tt>gsDPNoOpTag(tag)</tt>
 |-
 |}
@@ Line 19: / Line 19: @@
 ! Function Param !! To Microcode !! From Microcode !! Explanation
 |-
-| <tt>tag</tt> || <tt>tag</tt> || <tt>tttttttt</tt> || Tag number
+| <tt>tag</tt> || <tt>tag</tt> || <tt>tttttttt</tt> || Pointer to a string tag
 |-
 |}
@@ Line 25: / Line 25: @@
 ===Description===
-Does nothing except stall the RDP for a few cycles. Typically used in debugging, with the tag number used for debugging purposes. ''The tag is usually zero'', however. There is another macro provided, <tt>gsDPNoOp()</tt>, that the same as specifying a tag of <tt>0</tt>.
+Does nothing except stall the RDP for a few cycles. Typically used in debugging. In the Z64 games (specifically the debug builds), <tt>tag</tt> is set to a pointer to a string commenting the display list, which would then likely be output when calling the SDK's guParseGbiDL function.
 ==<tt>0x01</tt> — <tt>G_VTX</tt>==