KPADGetUnifiedWpadStatus

Syntax

#include <cafe/pads/kpad/kpad.h>

void KPADGetUnifiedWpadStatus( s32 chan, KPADUnifiedWpadStatus *dst, u32 count );

Parameters

chan One of the WPAD_CHANn values.
dst Pointer to the buffer that stores the controller data.
count Number of stored data. This value cannot exceed KPAD_RING_BUFS.

Return Values

None.

Description

To the application-created buffer, copies the controller data stored in the internal buffer by the KPAD library.

Regardless of the number of sampling-completed data in the KPAD library, the number of stored data will always be specified by count. The top most element will be the newest sampling data.

NOTE:
This function will not decrement the "number of sampling-completed data" counter in the KPAD library. KPADRead function decrements the counter to prevent repeat use of data already processed.

Using the KPADRead function return value immediately preceding this will provide a number close to the actual sampling-completed data count. However, a controller data sampling (interrupt) may occur after the KPADRead function call. To use the exact same number of data or to obtain the same data processed by the immediately preceding KPADRead function, KPADRead and this function need to be called in interrupt-prohibited state.

The application should reference the copied data through the following method. For error status and controller type definitions, see the description of the WPADStatus structure.

Do Not Call From

Background Do not call this function from the background.
Interrupt handler Do not call this function from any interrupt handler.
Exception handler Do not call this function from any exception handler.
Multiple Cores Do not call this function from more than one Core.

See Also

KPADUnifiedWpadStatus
KPADRead
WPADStatus

Revision History

2008-09-30 Updated the structure declarations.
2008-04-30 Updated the structure declarations.
2006-10-25 Initial version.


CONFIDENTIAL