GXLoadLightObjImm

Syntax

#include <revolution/gx.h>

void GXLoadLightObjImm(
    const GXLightObj* lt_obj,
    GXLightID         light );

Arguments

lt_obj	Pointer to a light object.
light	Light ID. Accepted values are: `GX_LIGHT0`, `GX_LIGHT1`, `GX_LIGHT2`, ... , `GX_LIGHT7`.

Return Values

None.

Description

This function loads a light object (a structure that includes precompiled register settings for various light parameters) into a set of hardware registers associated with a light ID. The light object must first be initialized using the required GXInitLight* function.

This function copies the light object data into the graphics FIFO through the CPU write-gather buffer mechanism. This guarantees that the light object is coherent with the CPU cache. Another way to load a light object is with the GXLoadLightObjIndx function.

Revision History

2006/03/01 Initial version.