KPADGetWPADCLRingBuffer

Syntax

#include <revolution/kpad.h>

WPADCLStatus *KPADGetWPADCLRingBuffer( s32 chan );

Arguments

chan One of the WPAD_CHANn values.

Return Values

Returns the start address of the WPADCLStatus structure ring buffer.

Description

The KPAD library, unlike the KPADOld library, does not use the WPAD library auto-sampling. This function is used for maintaining compatibility with the KPADOld library, but it does not necessarily operate the same way.

In the KPADOld library, this function was used as follows:

To reference values in a WPADCLStatus structure directly, use the WPADGetLatestIndexInBuf function in parallel to reference the appropriate value.

However, the controller must be in a stable state where data format does not change, not in a state that immediately follows its connection/disconnection or the insertion/removal of external extension controllers. Because such conditions cannot be guaranteed, the use of this function is not recommended.

In the KPAD library, KPADGetUnifiedWpadStatus should be used instead.

See Also

KPADGetUnifiedWpadStatus

Revision History

2006/10/25 Revised the description to match KPAD version 2.
2006/09/07 Initial version.


CONFIDENTIAL