KPADGetUnifiedWpadStatus

Syntax

#include <revolution/kpad.h>

typedef struct KPADUnifiedWpadStatus {
    union {
        WPADStatus      core;
        WPADFSStatus    fs;
        WPADCLStatus    cl;
        WPADTRStatus    tr;
        WPADBLStatus    bl;
    } u;
    u8     fmt;
    u8     padding;
} KPADUnifiedWpadStatus;

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

Arguments

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 give 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.

First, check the error status (member u.core.err). The offset of this member is shared and can be checked, regardless of whether the external extension controller is connected.
If that value is WPAD_ERR_NONE, a sampling-completed data is stored in the u member. Even if the value is not WPAD_ERR_NONE, some of the data may be properly sampled.
Next, check the controller type (member u.core.dev). The offset of this member is also shared regardless of whether the external extension controller is connected.
Finally, if both the error status and the controller type have the expected values, check the data format (fmt) member. The WPADGetDataFormat function's return value at sampling is stored in a u8 type.
Perform an appropriate processing based on the obtained error status, controller type, and data format. The error status, controller type, and data format may change for each element.

Revision History

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