RSX commands. More...

#include <rsx/gcm_sys.h>
#include <rsx/rsx_program.h>

Functions
void	rsxSetFrontFace (gcmContextData *context, u32 dir)
	Set drawing direction of front face. More...

void	rsxSetCullFace (gcmContextData *context, u32 cull)
	Set culling mode. More...

void	rsxSetCullFaceEnable (gcmContextData *context, u32 enable)
	Enable/Disable face culling. More...

void	rsxSetDepthWriteEnable (gcmContextData *context, u32 enable)
	Enable/Disable write to depth buffer. More...

void	rsxDrawVertexEnd (gcmContextData *context)
	Stop the render sequence. More...

void	rsxSetShadeModel (gcmContextData *context, u32 shadeModel)
	Set the shading model for the render sequence. More...

void	rsxDrawVertexBegin (gcmContextData *context, u32 type)
	Start the render sequence. More...

void	rsxDrawVertex2f (gcmContextData *context, u8 idx, f32 x, f32 y)

void	rsxDrawVertex3f (gcmContextData *context, u8 idx, f32 x, f32 y, f32 z)

void	rsxDrawVertex4f (gcmContextData *context, u8 idx, f32 x, f32 y, f32 z, f32 w)

void	rsxSetScissor (gcmContextData *context, u16 x, u16 y, u16 w, u16 h)

void	rsxSetDepthFunc (gcmContextData *context, u32 func)
	Specify the value used for depth buffer comparisons. More...

void	rsxSetDepthTestEnable (gcmContextData *context, u32 enable)
	Enable or disable the depth test. More...

void	rsxClearSurface (gcmContextData *context, u32 clear_mask)
	Clear the render surface. More...

void	rsxSetClearDepthValue (gcmContextData *context, u32 value)
	Set the clear depth value. More...

void	rsxSetReturnCommand (gcmContextData *context)

void	rsxSetCallCommand (gcmContextData *context, u32 offset)

void	rsxSetJumpCommand (gcmContextData *context, u32 offset)

void	rsxSetNopCommand (gcmContextData *context, u32 count)

void	rsxSetClearColor (gcmContextData *context, u32 color)
	Set the clear color. More...

void	rsxSetColorMask (gcmContextData *context, u32 mask)
	Enable or disable write access to the framebuffer color components. More...

void	rsxSetColorMaskMRT (gcmContextData *context, u32 mask)
	Enable or disable write access to the framebuffer color components (Multiple Render Target output). More...

void	rsxSetSurface (gcmContextData context, gcmSurface surface)
	Setup the render surface. More...

void	rsxSetReferenceCommand (gcmContextData *context, u32 ref_value)

void	rsxSetWaitLabel (gcmContextData *context, u8 index, u32 value)
	Enqueues a Wait for label command. More...

void	rsxSetWriteCommandLabel (gcmContextData *context, u8 index, u32 value)
	Enqueues a Write Command label command. More...

void	rsxSetWriteBackendLabel (gcmContextData *context, u8 index, u32 value)
	Enqueues a Write Backend label command. More...

void	rsxSetViewportClip (gcmContextData *context, u8 sel, u16 width, u16 height)

void	rsxSetViewport (gcmContextData *context, u16 x, u16 y, u16 width, u16 height, f32 min, f32 max, const f32 scale[4], const f32 offset[4])
	Set viewport. More...

void	rsxInvalidateTextureCache (gcmContextData *context, u32 type)
	Invalidates a texture cache. More...

void	rsxLoadTexture (gcmContextData context, u8 index, const gcmTexture texture)
	Loads a texture. More...

void	rsxTextureControl (gcmContextData *context, u8 index, u32 enable, u16 minlod, u16 maxlod, u8 maxaniso)
	Set texture control parameters. More...

void	rsxTextureFilter (gcmContextData *context, u8 index, u8 min, u8 mag, u8 conv)

void	rsxTextureWrapMode (gcmContextData *context, u8 index, u8 wraps, u8 wrapt, u8 wrapr, u8 unsignedRemap, u8 zfunc, u8 gamma)

void	rsxLoadVertexProgram (gcmContextData context, rsxVertexProgram program, const void *ucode)
	Load a compiled vertex shader program. More...

void	rsxLoadFragmentProgramLocation (gcmContextData context, rsxFragmentProgram program, u32 offset, u32 location)
	Load a compiled fragment shader program. More...

void	rsxZControl (gcmContextData *context, u8 cullNearFar, u8 zClampEnable, u8 cullIgnoreW)

void	rsxLoadVertexProgramBlock (gcmContextData context, rsxVertexProgram program, const void *ucode)

void	rsxLoadVertexProgramParameterBlock (gcmContextData context, u32 base_const, u32 const_cnt, const f32 value)

void	rsxSetVertexProgramParameter (gcmContextData context, rsxVertexProgram program, s32 index, const f32 *value)

void	rsxSetFragmentProgramParameter (gcmContextData context, rsxFragmentProgram program, s32 index, const f32 *value, u32 offset)

void	rsxDrawVertexArray (gcmContextData *context, u32 type, u32 start, u32 count)

void	rsxBindVertexArrayAttrib (gcmContextData *context, u8 attr, u32 offset, u8 stride, u8 elems, u8 dtype, u8 location)

void	rsxDrawIndexArray (gcmContextData *context, u32 type, u32 offset, u32 count, u32 data_type, u32 location)

void	rsxInlineTransfer (gcmContextData context, const u32 dstOffset, const void srcAddress, const u32 sizeInWords, const u8 location)

void	rsxSetUserClipPlaneControl (gcmContextData *context, u32 plane0, u32 plane1, u32 plane2, u32 plane3, u32 plane4, u32 plane5)

void	rsxSetBlendFunc (gcmContextData *context, u16 sfcolor, u16 dfcolor, u16 sfalpha, u16 dfalpha)
	Specify pixel arithmetic. More...

void	rsxSetBlendEquation (gcmContextData *context, u16 color, u16 alpha)
	Set the blend equation. More...

void	rsxSetBlendColor (gcmContextData *context, u32 color0, u32 color1)
	Set the blending constant color. More...

void	rsxSetBlendEnable (gcmContextData *context, u32 enable)
	Enable or disable blending. More...

void	rsxSetTransformBranchBits (gcmContextData *context, u32 branchBits)

void	rsxSetTransferDataMode (gcmContextData *context, u8 mode)
	Configuration the mode for an upcoming asynchronous RSX DMA transfer. More...

void	rsxSetTransferDataOffset (gcmContextData *context, u32 dst, u32 src)
	Specify the memory locations for an RSX DMA transfer. This function should be called after rsxSetTransferDataMode() and rsxSetTransferDataFormat(). More...

void	rsxSetTransferDataFormat (gcmContextData *context, s32 inpitch, s32 outpitch, u32 linelength, u32 linecount, u8 inbytes, u8 outbytes)
	Format an upcoming asynchronous RSX DMA transfer. More...

void	rsxSetTransferData (gcmContextData *context, u8 mode, u32 dst, u32 outpitch, u32 src, u32 inpitch, u32 linelength, u32 linecount)
	Initiate an asynchronous RSX DMA transfer. More...

void	rsxSetTransferScaleMode (gcmContextData *context, const u8 mode, const u8 surface)
	Configure an upcoming asynchronous RSX blit. More...

void	rsxSetTransferScaleSurface (gcmContextData context, const gcmTransferScale scale, const gcmTransferSurface *surface)
	Initiate an asynchronous RSX blit. More...

void	rsxSetTransferImage (gcmContextData *context, const u8 mode, const u32 dstOffset, const u32 dstPitch, const u32 dstX, const u32 dstY, const u32 srcOffset, const u32 srcPitch, const u32 srcX, const u32 srcY, const u32 width, const u32 height, const u32 bytesPerPixel)
	Initialiate an asynchronous transfer of a rectangular image from one area of memory to another. More...

void	rsxSetTimeStamp (gcmContextData *context, u32 index)

Detailed Description

RSX commands.

These are functions to enqueue commands into the RSX's command buffer.

Function Documentation

◆ rsxClearSurface()

void rsxClearSurface	(	gcmContextData *	context,
		u32	clear_mask
	)

Clear the render surface.

This function clears the chosen selection of color components, depth and stencil values for all pixels in the destination surface. The clear color can be chosen using rsxSetClearColor, and the clear value for the depth buffer is set using rsxSetClearDepthValue.

Parameters

context	Pointer to the context object.
clear_mask	A selection of components to be cleared. Must be an OR combination of the following values: GCM_CLEAR_Z GCM_CLEAR_S GCM_CLEAR_R GCM_CLEAR_G GCM_CLEAR_B GCM_CLEAR_A The value of GCM_CLEAR_M can also be chosen, to clear all RGBA components, depth and stencil buffers.

◆ rsxDrawVertexBegin()

void rsxDrawVertexBegin	(	gcmContextData *	context,
		u32	type
	)

Start the render sequence.

Starts the rendering for a primitive.

Parameters

context	Pointer to the context object.
type	Type of primitive to render. Possible values are: GCM_TYPE_POINTS GCM_TYPE_LINES GCM_TYPE_LINE_LOOP GCM_TYPE_LINE_STRIP GCM_TYPE_TRIANGLES GCM_TYPE_TRIANGLE_STRIP GCM_TYPE_TRIANGLE_FAN GCM_TYPE_QUADS GCM_TYPE_QUAD_STRIP GCM_TYPE_POLYGON

◆ rsxDrawVertexEnd()

void rsxDrawVertexEnd ( gcmContextData * context )

Stop the render sequence.

Stops the rendering for a primitive, started by rsxDrawVertexBegin.

Parameters

context Pointer to the context object.

◆ rsxInvalidateTextureCache()

void rsxInvalidateTextureCache	(	gcmContextData *	context,
		u32	type
	)

Invalidates a texture cache.

Parameters

context	Pointer to the context object.
type	Type of texture cache to be invalidated. Possible values are: GCM_INVALIDATE_TEXTURE GCM_INVALIDATE_VERTEX_TEXTURE

◆ rsxLoadFragmentProgramLocation()

void rsxLoadFragmentProgramLocation	(	gcmContextData *	context,
		rsxFragmentProgram *	program,
		u32	offset,
		u32	location
	)

Load a compiled fragment shader program.

Parameters

context	Pointer to the context object
program	Pointer to the fragment program configuration
offset	Memory offset of fragment program
location	Memory location type where the program relies. Possible values are: GCM_LOCATION_RSX GCM_LOCATION_CELL

◆ rsxLoadTexture()

void rsxLoadTexture	(	gcmContextData *	context,
		u8	index,
		const gcmTexture *	texture
	)

Loads a texture.

Parameters

context	Pointer to the context object.
index	Texture index.
texture	Pointer to the texture data.

◆ rsxLoadVertexProgram()

void rsxLoadVertexProgram	(	gcmContextData *	context,
		rsxVertexProgram *	program,
		const void *	ucode
	)

Load a compiled vertex shader program.

Parameters

context	Pointer to the context object
program	Pointer to the vertex program configuration
ucode	Pointer to the shader micro code

◆ rsxSetBlendColor()

void rsxSetBlendColor	(	gcmContextData *	context,
		u32	color0,
		u32	color1
	)

Set the blending constant color.

Parameters

context	Pointer to the context object
color0	all A, R, G, B components in 8-bit component mode
color1	reserved for 16-bit components

◆ rsxSetBlendEnable()

void rsxSetBlendEnable	(	gcmContextData *	context,
		u32	enable
	)

Enable or disable blending.

Parameters

context	Pointer to the context object
enable	`GCM_TRUE` : enable blending `GCM_FALSE` : disable blending

◆ rsxSetBlendEquation()

void rsxSetBlendEquation	(	gcmContextData *	context,
		u16	color,
		u16	alpha
	)

Set the blend equation.

The blend equations determine how a new pixel (the “source” color) is combined with a pixel already in the framebuffer (the “destination” color). This function specifies one blend equation for the RGB-color components and one blend equation for the alpha component.

These equations use the source and destination blend factors specified by rsxSetBlendFunc. See rsxSetBlendFunc for a description of the various blend factors.

In the equations that follow, source and destination color components are referred to as R_s, G_s, B_s, A_s and R_d, G_d, B_d, A_d, respectively. The result color is referred to as R_r, G_r, B_r, A_r. The source and destination blend factors are denoted s_R, s_G, s_B, s_A and d_R, d_G, d_B, d_A, respectively. For these equations all color components are understood to have values in the range [0,1].

Mode	R_r	G_r	B_r	A_r
GCM_FUNC_ADD	R_ss_R+R_dd_R	G_ss_G+G_dd_G	B_ss_B+B_dd_B	A_ss_A+A_dd_A
GCM_MIN	min(R_s,R_d)	min(G_s,G_d)	min(B_s,B_d)	min(A_s,A_d)
GCM_MAX	max(R_s,R_d)	max(G_s,G_d)	max(B_s,B_d)	max(A_s,A_d)
GCM_FUNC_SUBTRACT	R_ss_R-R_dd_R	G_ss_G-G_dd_G	B_ss_B-B_dd_B	A_ss_A-A_dd_A
GCM_FUNC_REVERSE_SUBTRACT	R_dd_R-R_ss_R	G_dd_G-G_ss_G	B_dd_B-B_ss_B	A_dd_A-A_ss_A

The results of these equations are clamped to the range [0,1].

The GCM_MIN and GCM_MAX equations are useful for applications that analyze image data (image thresholding against a constant color, for example). The GCM_FUNC_ADD equation is useful for antialiasing and transparency, among other things.

Initially, both the RGB blend equation and the alpha blend equation are set to GCM_FUNC_ADD.

Notes

The GCM_MIN, and GCM_MAX equations do not use the source or destination factors, only the source and destination colors.

Parameters

context	Pointer to the context object
color	Specifies the RGB blend equation, how the red, green, and blue components of the source and destination colors are combined.
alpha	Specifies the alpha blend equation, how the alpha component of the source and destination colors are combined.

◆ rsxSetBlendFunc()

void rsxSetBlendFunc	(	gcmContextData *	context,
		u16	sfcolor,
		u16	dfcolor,
		u16	sfalpha,
		u16	dfalpha
	)

Specify pixel arithmetic.

In RGBA mode, pixels can be drawn using a function that blends the incoming (source) RGBA values with the RGBA values that are already in the frame buffer (the destination values). Blending is initially disabled. Use rsxSetBlendEnable to enable and disable blending.

rsxSetBlendFunc defines the operation of blending when it is enabled. sfcolor and and sfalpha specify which method is used to scale the source color and alpha components. dfcolor and and dfalpha specify which method is used to scale the destination color and alpha components. The possible methods are described in the following table. Each method defines four scale factors, one each for red, green, blue, and alpha. In the table and in subsequent equations, source and destination color components are referred to as R_s, G_s, B_s, A_s and R_d, G_d, B_d, A_d, respectively. The color specified by rsxSetBlendColor is referred to as R_c, G_c, B_c, A_c. They are understood to have integer values between 0 and k_R, k_G, k_B, k_A, where

k_c = 2^m_c - 1

and m_R, m_G, m_B, m_A is the number of red, green, blue, and alpha bitplanes.

Source and destination scale factors are referred to as s_R, s_G, s_B, s_A and d_R, d_G, d_B, d_A. The scale factors described in the table, denoted f_R, f_G, f_B, f_A, represent either source or destination factors. All scale factors have range [0,1].

Parameter	f_R	f_G	f_B	f_A
GCM_ZERO	0	0	0	0
GCM_ONE	1	1	1	1
GCM_SRC_COLOR	R_s/k_R	G_s/k_G	B_s/k_B	A_s/k_A
GCM_ONE_MINUS_SRC_COLOR	1-R_s/k_R	1-G_s/k_G	1-B_s/k_B	1-A_s/k_A
GCM_DST_COLOR	R_d/k_R	G_d/k_G	B_d/k_B	A_d/k_A
GCM_ONE_MINUS_DST_COLOR	1-R_d/k_R	1-G_d/k_G	1-B_d/k_B	1-A_d/k_A
GCM_SRC_ALPHA	A_s/k_A	A_s/k_A	A_s/k_A	A_s/k_A
GCM_ONE_MINUS_SRC_ALPHA	1-A_s/k_A	1-A_s/k_A	1-A_s/k_A	1-A_s/k_A
GCM_DST_ALPHA	A_d/k_A	A_d/k_A	A_d/k_A	A_d/k_A
GCM_ONE_MINUS_DST_ALPHA	1-A_d/k_A	1-A_d/k_A	1-A_d/k_A	1-A_d/k_A
GCM_CONSTANT_COLOR	R_c	G_c	B_c	A_c
GCM_ONE_MINUS_CONSTANT_COLOR	1-R_c	1-G_c	1-B_c	1-A_c
GCM_CONSTANT_ALPHA	A_c	A_c	A_c	A_c
GCM_ONE_MINUS_CONSTANT_ALPHA	1-A_c	1-A_c	1-A_c	1-A_c
GCM_SRC_ALPHA_SATURATE	i	i	i	1

In the table,

i = min(A_s/k_A, 1 - A_d/k_A)

To determine the blended RGBA values of a pixel when drawing in RGBA mode, the equation defined by rsxSetBlendEquation us used. In the default mode (GCM_FUNC_ADD for RGB and alpha equations), the equations are the following:

R_d = min(k_R, R_ss_R + R_dd_R)
G_d = min(k_G, G_ss_G + G_dd_G)
B_d = min(k_B, B_ss_B + B_dd_B)
A_d = min(k_A, A_ss_A + A_dd_A)

Despite the apparent precision of the above equations, blending arithmetic is not exactly specified, because blending operates with imprecise integer color values. However, a blend factor that should be equal to 1 is guaranteed not to modify its multiplicand, and a blend factor equal to 0 reduces its multiplicand to 0. For example, when sfcolor is GCM_SRC_ALPHA, fdcolor is GCM_ONE_MINUS_SRC_ALPHA, and A_s is equal to k_A, the equations reduce to simple replacement:

R_d = R_s ; G_d = G_s ; B_d = B_s

Examples

Transparency is best implemented using blend function (sfcolor = sfalpha = GCM_SRC_ALPHA, dfcolor = dfalpha = GCM_ONE_MINUS_SRC_ALPHA) with primitives sorted from farthest to nearest. Note that this transparency calculation does not require the presence of alpha bitplanes in the frame buffer.

Blend function (GCM_SRC_ALPHA, GCM_ONE_MINUS_SRC_ALPHA) is also useful for rendering antialiased points and lines in arbitrary order.

Polygon antialiasing is optimized using blend function (GCM_SRC_ALPHA_SATURATE, GCM_ONE) with polygons sorted from nearest to farthest. Destination alpha bitplanes, which must be present for this blend function to operate correctly, store the accumulated coverage.

Notes

Incoming (source) alpha is correctly thought of as a material opacity, ranging from 1.0 ( k_A ), representing complete opacity, to 0.0 (0), representing complete transparency.

Parameters

context	Pointer to the context object
sfcolor	Specifies how the red, green, and blue source blending factors are computed.
dfcolor	Specifies how the red, green, and blue source blending factors are computed.
sfalpha	Specifies how the alpha source blending factor is computed.
dfalpha	Specifies how the alpha destination blending factor is computed.

◆ rsxSetClearColor()

void rsxSetClearColor	(	gcmContextData *	context,
		u32	color
	)

Set the clear color.

The clear color value is used by the rsxClearSurface function.

Parameters

context	Pointer to the context object.
color	The clear color value.

◆ rsxSetClearDepthValue()

void rsxSetClearDepthValue	(	gcmContextData *	context,
		u32	value
	)

Set the clear depth value.

This value is used by the rsxClearSurface function.

Parameters

context	Pointer to the context object.
value	Color value

◆ rsxSetColorMask()

void rsxSetColorMask	(	gcmContextData *	context,
		u32	mask
	)

Enable or disable write access to the framebuffer color components.

Parameters

context	Pointer to the context object.
mask	A selection of the components to enable write access. It is an OR combination of the following values: GCM_COLOR_MASK_B GCM_COLOR_MASK_G GCM_COLOR_MASK_R GCM_COLOR_MASK_A

◆ rsxSetColorMaskMRT()

void rsxSetColorMaskMRT	(	gcmContextData *	context,
		u32	mask
	)

Enable or disable write access to the framebuffer color components (Multiple Render Target output).

Parameters

context	Pointer to the context object.
mask	A selection of the components to enable write access. It is an OR combination of the following values: GCM_COLOR_MASK_B GCM_COLOR_MASK_G GCM_COLOR_MASK_R GCM_COLOR_MASK_A

◆ rsxSetCullFace()

void rsxSetCullFace	(	gcmContextData *	context,
		u32	cull
	)

Set culling mode.

Parameters

context	Pointer to context object.
cull	Type of cull mode. Possible values are: GCM_CULL_FRONT GCM_CULL_BACK GCM_CULL_ALL

◆ rsxSetCullFaceEnable()

void rsxSetCullFaceEnable	(	gcmContextData *	context,
		u32	enable
	)

Enable/Disable face culling.

Parameters

context	Pointer to the context object.
enable	Enable flag. Possible values are: GCM_TRUE GCM_FALSE

◆ rsxSetDepthFunc()

void rsxSetDepthFunc	(	gcmContextData *	context,
		u32	func
	)

Specify the value used for depth buffer comparisons.

Parameters

context	Pointer to the context object.
func	Specifies the depth comparison function. Possible values are: GCM_NEVER GCM_LESS GCM_EQUAL GCM_LEQUAL GCM_GREATER GCM_NOTEQUAL GCM_GEQUAL GCM_ALWAYS

◆ rsxSetDepthTestEnable()

void rsxSetDepthTestEnable	(	gcmContextData *	context,
		u32	enable
	)

Enable or disable the depth test.

If depth test is enabled, the GPU performs depth comparisons and updates the depth buffer. Note that even if the depth buffer exists and the depth mask is non-zero, the depth buffer is not updated if the depth test is disabled.

Parameters

context	Pointer to the context object.
enable	Enable flag. Possible values are: GCM_TRUE GCM_FALSE

◆ rsxSetDepthWriteEnable()

void rsxSetDepthWriteEnable	(	gcmContextData *	context,
		u32	enable
	)

Enable/Disable write to depth buffer.

Parameters

context	Pointer to the context object.
enable	Enable flag. Possible values are: GCM_TRUE GCM_FALSE

◆ rsxSetFrontFace()

void rsxSetFrontFace	(	gcmContextData *	context,
		u32	dir
	)

Set drawing direction of front face.

Parameters

context	Pointer to the context object.
dir	Drawing direction of front face. Possible values are: GCM_FRONTFACE_CW GCM_FRONTFACE_CCW

◆ rsxSetShadeModel()

void rsxSetShadeModel	(	gcmContextData *	context,
		u32	shadeModel
	)

Set the shading model for the render sequence.

Parameters

context	Pointer to the context object.
shadeModel	Type of shading model. Possible values are: GCM_SHADE_MODEL_FLAT GCM_SHADE_MODEL_SMOOTH

◆ rsxSetSurface()

void rsxSetSurface	(	gcmContextData *	context,
		gcmSurface *	surface
	)

Setup the render surface.

This function is used to setup the render target where RSX should render the frame into.

Parameters

context	Pointer to the context object.
surface	Pointer to the surface object.

◆ rsxSetTransferData()

void rsxSetTransferData	(	gcmContextData *	context,
		u8	mode,
		u32	dst,
		u32	outpitch,
		u32	src,
		u32	inpitch,
		u32	linelength,
		u32	linecount
	)

Initiate an asynchronous RSX DMA transfer.

Parameters

context	Pointer to the context object
mode	Specify source and destination memory areas. Possible values are: GCM_TRANSFER_LOCAL_TO_LOCAL GCM_TRANSFER_MAIN_TO_LOCAL GCM_TRANSFER_LOCAL_TO_MAIN GCM_TRANSFER_MAIN_TO_MAIN
dst	Destination memory offset, e.g., a value returned by gcmAddressToOffset() or gcmMapMainMemory().
outpitch	Pitch size, in bytes, of the destination buffer (e.g., for a buffer that represents a rectangular image, this would be the width multiplied by the number of bytes in each pixel).
src	Source memory offset, e.g., a value returned by gcmAddressToOffset() or gcmMapMainMemory().
inpitch	Pitch size, in bytes, of the source buffer (e.g., for a buffer that represents a rectangular image, this would be the width multiplied by the number of bytes in each pixel).
linelength	Size, in bytes, of each line of data that will be transfered.
linecount	Number of lines of data to transfer.

◆ rsxSetTransferDataFormat()

void rsxSetTransferDataFormat	(	gcmContextData *	context,
		s32	inpitch,
		s32	outpitch,
		u32	linelength,
		u32	linecount,
		u8	inbytes,
		u8	outbytes
	)

Format an upcoming asynchronous RSX DMA transfer.

Parameters

context	Pointer to the context object
inpitch	Pitch size, in bytes, of the source buffer (e.g., for a buffer that represents a rectangular image, this would be the width multiplied by the number of bytes in each pixel).
outpitch	Pitch size, in bytes, of the destination buffer (e.g., for a buffer that represents a rectangular image, this would be the width multiplied by the number of bytes in each pixel).
linelength	Size, in bytes, of each line of data that will be transfered.
linecount	Number of lines of data to transfer.
inbytes	Number of bytes for each block (e.g., pixel) of data to be transfered: 1, 2, or 4. Will perform scatter-gather transfer if different from outbytes.
outbytes	Number of bytes for each block (e.g., pixel) of data to be transfered: 1, 2, or 4. Will perform scatter-gather transfer if different from inbytes.

◆ rsxSetTransferDataMode()

void rsxSetTransferDataMode	(	gcmContextData *	context,
		u8	mode
	)

Configuration the mode for an upcoming asynchronous RSX DMA transfer.

Parameters

context	Pointer to the context object
mode	Specify source and destination memory areas. Possible values are: GCM_TRANSFER_LOCAL_TO_LOCAL GCM_TRANSFER_MAIN_TO_LOCAL GCM_TRANSFER_LOCAL_TO_MAIN GCM_TRANSFER_MAIN_TO_MAIN

◆ rsxSetTransferDataOffset()

void rsxSetTransferDataOffset	(	gcmContextData *	context,
		u32	dst,
		u32	src
	)

Specify the memory locations for an RSX DMA transfer. This function should be called after rsxSetTransferDataMode() and rsxSetTransferDataFormat().

Parameters

context	Pointer to the context object
dst	Destination memory offset, e.g., a value returned by gcmAddressToOffset() or gcmMapMainMemory().
src	Source memory offset, e.g., a value returned by gcmAddressToOffset() or gcmMapMainMemory().

◆ rsxSetTransferImage()

void rsxSetTransferImage	(	gcmContextData *	context,
		const u8	mode,
		const u32	dstOffset,
		const u32	dstPitch,
		const u32	dstX,
		const u32	dstY,
		const u32	srcOffset,
		const u32	srcPitch,
		const u32	srcX,
		const u32	srcY,
		const u32	width,
		const u32	height,
		const u32	bytesPerPixel
	)

Initialiate an asynchronous transfer of a rectangular image from one area of memory to another.

Parameters

context	Pointer to the context object
mode	Specify source and destination memory areas. Possible values are: GCM_TRANSFER_LOCAL_TO_LOCAL GCM_TRANSFER_MAIN_TO_LOCAL GCM_TRANSFER_LOCAL_TO_MAIN GCM_TRANSFER_MAIN_TO_MAIN
dstOffset	Destination memory offset, e.g., a value returned by gcmAddressToOffset() or gcmMapMainMemory().
dstPitch	Pitch size, in bytes, of the destination image data (width multiplied by the number of bytes in each pixel).
dstX	Origin of the destination data, relative to the beginning of the destination buffer.
dstY	Origin of the destination data, relative to the beginning of the destination buffer.
srcOffset	Source memory offset, e.g., a value returned by gcmAddressToOffset() or gcmMapMainMemory().
srcPitch	Pitch size, in bytes, of the source image data (width multiplied by the number of bytes in each pixel).
srcX	Origin of the source rectangle, relative to the beginning of the source buffer.
srcY	Origin of the source rectangle, relative to the beginning of the source buffer.
width	Width of the transfer rectangle.
height	Height of the transfer rectangle.
bytesPerPixel	Number of bytes per pixel to transfer: 2 or 4.

◆ rsxSetTransferScaleMode()

void rsxSetTransferScaleMode	(	gcmContextData *	context,
		const u8	mode,
		const u8	surface
	)

Configure an upcoming asynchronous RSX blit.

Parameters

context	Pointer to the context object
mode	Specify source and destination memory areas. Possible values are: GCM_TRANSFER_LOCAL_TO_LOCAL GCM_TRANSFER_MAIN_TO_LOCAL GCM_TRANSFER_LOCAL_TO_MAIN GCM_TRANSFER_MAIN_TO_MAIN
surface	Transfer surface mode. Possible values are: GCM_TRANSFER_SURFACE GCM_TRANSFER_SWIZZLE

◆ rsxSetTransferScaleSurface()

void rsxSetTransferScaleSurface	(	gcmContextData *	context,
		const gcmTransferScale *	scale,
		const gcmTransferSurface *	surface
	)

Initiate an asynchronous RSX blit.

Parameters

context	Pointer to the context object
scale	Specify the transfer geometry & parameters.
surface	Specify the surface to blit to.

◆ rsxSetViewport()

void rsxSetViewport	(	gcmContextData *	context,
		u16	x,
		u16	y,
		u16	width,
		u16	height,
		f32	min,
		f32	max,
		const f32	scale[4],
		const f32	offset[4]
	)

Set viewport.

This function sets the viewport.
The origin (0,0) of the normalized device coordinate points to the center of the screen.
Performing viewport conversion, where the upper left corner is the origin is as follows:

x = X;
y = Y;
width = WIDTH;
height = HEIGHT;
min = 0.0f;
max = 1.0f;
scale[0] = width * 0.5f;
scale[1] = height * 0.5f;
scale[2] = (max - min) * 0.5f;
offset[0] = x + width * 0.5f;
offset[1] = y + height * 0.5f;
offset[2] = (max + min) * 0.5f;

Performing viewport conversion, where the lower left corner is the origin is as follows (this is equivalent to glViewport):

x = X;
y = WINDOW_HEIGHT - Y - HEIGHT;
width = WIDTH;
height = HEIGHT;
min = 0.0f;
max = 1.0f;
scale[0] = width * 0.5f;
scale[1] = height * -0.5f;
scale[2] = (max - min) * 0.5f;
offset[0] = x + width * 0.5f;
offset[1] = y + height * 0.5f;
offset[2] = (max + min) * 0.5f;

Parameters

context	Pointer to the context object.
x	Origin of the viewport rectangle in pixels (0 - 4095). Initial value is (0,0).
y	Origin of the viewport rectangle in pixels (0 - 4095). Initial value is (0,0).
width	Width of the viewport (0 - 4096). Initial value is 4096.
height	Height of the viewport (0 - 4096). Initial value is 4096.
min	Minimum Z clip value. Initial value is 0.0.
max	Maximum Z clip value. Initial value is 1.0.
scale	Scale values to be used for viewport conversion. Initial values are (2048.0,2048.0,0.5,0.0).
offset	Offset values to be used for viewport conversion. Initial values are (2048.0,2048.0,0.5,0.0).

◆ rsxSetWaitLabel()

void rsxSetWaitLabel	(	gcmContextData *	context,
		u8	index,
		u32	value
	)

Enqueues a Wait for label command.

Parameters

context	Pointer to the context object.
index	Label index
valuie	Label value

◆ rsxSetWriteBackendLabel()

void rsxSetWriteBackendLabel	(	gcmContextData *	context,
		u8	index,
		u32	value
	)

Enqueues a Write Backend label command.

Parameters

context	Pointer to the context object.
index	Label index
value	Label value

◆ rsxSetWriteCommandLabel()

void rsxSetWriteCommandLabel	(	gcmContextData *	context,
		u8	index,
		u32	value
	)

Enqueues a Write Command label command.

Parameters

context	Pointer to the context object.
index	Label index
value	Label value

◆ rsxTextureControl()

void rsxTextureControl	(	gcmContextData *	context,
		u8	index,
		u32	enable,
		u16	minlod,
		u16	maxlod,
		u8	maxaniso
	)

Set texture control parameters.

Parameters

context	Pointer to the context object.
index	Texture index.
enable	Enable flag. Possible values are: GCM_TRUE GCM_FALSE
minlod	minimum level of detail.
maxlod	maximum level of detail.
maxaniso	sample level of the anisotropic filter. Possible values are: GCM_TEXTURE_MAX_ANISO_1 GCM_TEXTURE_MAX_ANISO_2 GCM_TEXTURE_MAX_ANISO_4 GCM_TEXTURE_MAX_ANISO_6 GCM_TEXTURE_MAX_ANISO_8 GCM_TEXTURE_MAX_ANISO_10 GCM_TEXTURE_MAX_ANISO_12 GCM_TEXTURE_MAX_ANISO_16

Todo:: finish args documentation.

Functions

Detailed Description

Function Documentation

◆ rsxClearSurface()

◆ rsxDrawVertexBegin()

◆ rsxDrawVertexEnd()

◆ rsxInvalidateTextureCache()

◆ rsxLoadFragmentProgramLocation()

◆ rsxLoadTexture()

◆ rsxLoadVertexProgram()

◆ rsxSetBlendColor()

◆ rsxSetBlendEnable()

◆ rsxSetBlendEquation()

◆ rsxSetBlendFunc()

◆ rsxSetClearColor()

◆ rsxSetClearDepthValue()

◆ rsxSetColorMask()

◆ rsxSetColorMaskMRT()

◆ rsxSetCullFace()

◆ rsxSetCullFaceEnable()

◆ rsxSetDepthFunc()

◆ rsxSetDepthTestEnable()

◆ rsxSetDepthWriteEnable()

◆ rsxSetFrontFace()

◆ rsxSetShadeModel()

◆ rsxSetSurface()

◆ rsxSetTransferData()

◆ rsxSetTransferDataFormat()

◆ rsxSetTransferDataMode()

◆ rsxSetTransferDataOffset()

◆ rsxSetTransferImage()

◆ rsxSetTransferScaleMode()

◆ rsxSetTransferScaleSurface()

◆ rsxSetViewport()

◆ rsxSetWaitLabel()

◆ rsxSetWriteBackendLabel()

◆ rsxSetWriteCommandLabel()

◆ rsxTextureControl()