Intel Extensible Firmware Interface User Manual
Page 344
Extensible Firmware Interface Specification
10-50
12/01/02
Version 1.10
RelativeMovementY
The signed distance in counts that the pointer device has been
moved along the y-axis. The actual distance moved is
RelativeMovementY
/
ResolutionY
millimeters. If the
ResolutionY
field of the
structure is 0, then this pointer device does not support a y-axis,
and this field must be ignored.
RelativeMovementZ
The signed distance in counts that the pointer device has been
moved along the z-axis. The actual distance moved is
RelativeMovementZ
/
ResolutionZ
millimeters. If the
ResolutionZ
field of the
EFI_SIMPLE_POINTER_MODE
structure is 0, then this pointer device does not support a z-axis,
and this field must be ignored.
LeftButton
If
TRUE
, then the left button of the pointer device is being
pressed. If
FALSE
, then the left button of the pointer device is
not being pressed. If the
LeftButton
field of the
EFI_SIMPLE_POINTER_MODE
structure is
FALSE
, then this
field is not valid, and must be ignored.
RightButton
If
TRUE
, then the right button of the pointer device is being
pressed. If
FALSE
, then the right button of the pointer device is
not being pressed. If the
RightButton
field of the
EFI_SIMPLE_POINTER_MODE
structure is
FALSE
, then this
field is not valid, and must be ignored.
Description
The
GetState()
function retrieves the current state of a pointer device. This includes
information on the buttons associated with the pointer device and the distance that each of the axes
associated with the pointer device has been moved. If the state of the pointer device has not
changed since the last call to
GetState()
, then
EFI_NOT_READY
is returned. If the state of the
pointer device has changed since the last call to
GetState()
, then the state information is placed
in
State
, and
EFI_SUCCESS
is returned. If a device error occurs while attempting to retrieve
the state information, then
EFI_DEVICE_ERROR
is returned.
Status Codes Returned
EFI_SUCCESS
The state of the pointer device was returned in
State
.
EFI_NOT_READY
The state of the pointer device has not changed since the last call to
GetState()
.
EFI_DEVICE_ERROR
A device error occurred while attempting to retrieve the pointer device’s
current state.