_gcmSurface Struct Reference

RSX target surface data structure. More...

#include <gcm_sys.h>

Data Fields
u8	type
	Type of render target. More...
u8	antiAlias
	Antialiasing format type. More...
u8	colorFormat
	Format of the color buffer. More...
u8	colorTarget
	Target of the color buffer. More...
u8	colorLocation [GCM_MAX_MRT_COUNT]
	Location of the color buffer. More...
u32	colorOffset [GCM_MAX_MRT_COUNT]
	Offset from the base address of the color buffer. More...
u32	colorPitch [GCM_MAX_MRT_COUNT]
	Size of a color buffer line in bytes. More...
u8	depthFormat
	Format of the depth buffer. More...
u8	depthLocation
	Location of the depth buffer. More...
u8	_pad [2]
	unused padding bytes. most be 0.
u32	depthOffset
	Offset from the base address of the depth buffer. More...
u32	depthPitch
	Size of a depth buffer line in bytes.
u16	width
	Width of the render buffer (1 - 4096).
u16	height
	Height of the render buffer (1 - 4096).
u16	x
	Window offset in x direction (0 - 4095).
u16	y
	Window offset in y direction (0 - 4095).

Detailed Description

RSX target surface data structure.

This structure holds settings of the render target that is to be the render buffer. Set the buffer to use for rendering by passing this structure as the argument when calling rsxSetSurface.

Field Documentation

antiAlias

u8 _gcmSurface::antiAlias

Antialiasing format type.

Specifies the mode of multiple samples. Possible values are:

• GCM_TF_CENTER_1

colorFormat

u8 _gcmSurface::colorFormat

Format of the color buffer.

Possible values are:

• GCM_TF_COLOR_R5G5B5

colorLocation

u8 _gcmSurface::colorLocation[GCM_MAX_MRT_COUNT]

Location of the color buffer.

When using multiple render targets, set as many locations as the number of color buffers enabled in colorTarget. In this system, up to 4 color buffers can be specified for multiple render targets, and the location of each individual color buffer can be specified independently. Possible values are:

• GCM_LOCATION_RSX
• GCM_LOCATION_CELL

colorOffset

u32 _gcmSurface::colorOffset[GCM_MAX_MRT_COUNT]

Offset from the base address of the color buffer.

When using multiple render targets, set as many addresses as the number of color buffers specified in colorTarget. Use rsxAddressToOffset to convert the effective addresses into offset values when specifying the buffer offset. colorOffset should be aligned on a 64 bytes boundery.

colorPitch

u32 _gcmSurface::colorPitch[GCM_MAX_MRT_COUNT]

Size of a color buffer line in bytes.

When using multiple render targets, specify as many pitch sizes as the number of color buffers specified in colorTarget. The pitch size should be 64 when rendering in the swizzle format. For all others, the pitch size should be a multiple of 64.

colorTarget

u8 _gcmSurface::colorTarget

Target of the color buffer.

Specifies the render target to use as a surface. Possible values are:

• GCM_TF_TARGET_NONE
• GCM_TF_TARGET_0
• GCM_TF_TARGET_1
• GCM_TF_TARGET_MRT1
• GCM_TF_TARGET_MRT2
• GCM_TF_TARGET_MRT3

depthFormat

u8 _gcmSurface::depthFormat

Format of the depth buffer.

Possible values are:

• GCM_TF_ZETA_Z16
• GCM_TF_ZETA_Z24S8

depthLocation

u8 _gcmSurface::depthLocation

Location of the depth buffer.

Possible values are:

• GCM_LOCATION_RSX
• GCM_LOCATION_CELL

depthOffset

u32 _gcmSurface::depthOffset

Offset from the base address of the depth buffer.

As in colorOffset use rsxAddressToOffset to convert effective addresses into offset values. depthOffset should be aligned on a 64 bytes boundery.

type

u8 _gcmSurface::type

Type of render target.

Possible values are:

• GCM_TF_TYPE_LINEAR
• GCM_TF_TYPE_SWIZZLE

---

The documentation for this struct was generated from the following file:

• ppu/include/rsx/gcm_sys.h