Aperture

Collaboration diagram for Aperture:

Typedefs
typedef uint32_t	GX2ApertureHandle

Functions
void	GX2AllocateTilingApertureEx (GX2Surface *surface, uint32_t level, uint32_t depth, GX2EndianSwapMode endian, GX2ApertureHandle *outHandle, void **outAddress)
	Allocates a tiling aperture. More...
void	GX2FreeTilingAperture (GX2ApertureHandle handle)
	Frees an allocated tiling aperture. More...

Detailed Description

Typedef Documentation

GX2ApertureHandle

typedef uint32_t GX2ApertureHandle

Definition at line 16 of file aperture.h.

Function Documentation

GX2AllocateTilingApertureEx()

void GX2AllocateTilingApertureEx	(	GX2Surface *	surface,
		uint32_t	level,
		uint32_t	depth,
		GX2EndianSwapMode	endian,
		GX2ApertureHandle *	outHandle,
		void **	outAddress
	)

Allocates a tiling aperture.

This function creates a linear and untiled buffer to read from and write to the surface. The total size of the buffer will be width * height * bpp.

Parameters

surface	A pointer to the surface to create the tiling aperture for.
level	The level of the surface to create the tiling aperture for.
depth	The depth of the surface to create the tiling aperture for.
endian	The endian swap mode.
outHandle	A pointer to store the handle for the aperture.
outAddress	A pointer to store the address for the aperture.

GX2FreeTilingAperture()

void GX2FreeTilingAperture

(

GX2ApertureHandle

handle

)

Frees an allocated tiling aperture.

Parameters

handle

The handle of the tiling aperture which should be freed.