Skip to content

Commit 385bb95

Browse files
authored
Minor GX documentation improvements (#182)
* doc: fix reference to GX_COLORZERO * doc: correct parameter type for GX_SetTevKColorS10 It takes the same input register as GX_SetTevKColor(). * doc: specify supported registers for GX_SetTevColor*() While setting GX_TEVPREV works in Dolphin, it does not work on a real hardware.
1 parent 070c2ea commit 385bb95

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

gc/ogc/gx.h

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2566,7 +2566,7 @@ void GX_SetTevOp(u8 tevstage,u8 mode);
25662566
*
25672567
* \note This function can only set unsigned 8-bit colors. To set signed, 10-bit colors use GX_SetTevColorS10().
25682568
*
2569-
* \param[in] tev_regid \ref tevcoloutreg.
2569+
* \param[in] tev_regid \ref tevcoloutreg. Only GX_TEVREG0, GX_TEVREG1 and GX_TEVREG2 are supported.
25702570
* \param[in] color Constant color value.
25712571
*
25722572
* \return none
@@ -2582,7 +2582,7 @@ void GX_SetTevColor(u8 tev_regid,GXColor color);
25822582
*
25832583
* \note This function enables the color components to be signed 10-bit numbers. To set 8-bit unsigned colors (the common case), use GX_SetTevColor().
25842584
*
2585-
* \param[in] tev_regid \ref tevcoloutreg.
2585+
* \param[in] tev_regid \ref tevcoloutreg. Only GX_TEVREG0, GX_TEVREG1 and GX_TEVREG2 are supported.
25862586
* \param[in] color Constant color value in S10 format.
25872587
*
25882588
* \return none
@@ -3035,7 +3035,7 @@ void GX_SetNumChans(u8 num);
30353035
* available for all the active TEV stages is set using GX_SetNumChans(). Active TEV stages should not reference more texture coordinates or colors
30363036
* than are being generated.<br><br>
30373037
*
3038-
* \note There are some special settings for the \a color argument. If you specify <tt>GX_COLOR_ZERO</tt>, you always get zero as rasterized color. If you specify
3038+
* \note There are some special settings for the \a color argument. If you specify <tt>GX_COLORZERO</tt>, you always get zero as rasterized color. If you specify
30393039
* <tt>GX_ALPHA_BUMP</tt> or <tt>GX_ALPHA_BUMPN</tt>, you can use "Bump alpha" component from indirect texture unit as rasterized color input (see GX_SetTevIndirect()
30403040
* for details about how to configure bump alpha). Since bump alpha contains only 5-bit data, <tt>GX_ALPHA_BUMP</tt> shifts them to higher bits, which makes the
30413041
* value range 0-248. Meanwhile <tt>GX_ALPHA_BUMPN</tt> performs normalization and you can get the value range 0-255.
@@ -3156,7 +3156,7 @@ void GX_SetTevKAlphaSel(u8 tevstage,u8 sel);
31563156
*
31573157
* \note This function takes 10-bit signed values as color values; use GX_SetTevColor() to give 8-bit values.
31583158
*
3159-
* \param[in] sel \ref tevcoloutreg
3159+
* \param[in] sel \ref tevkcolorid
31603160
* \param[in] col constant color value
31613161
*
31623162
* \return none

0 commit comments

Comments
 (0)