Filter
Top Products
Protocols — Console Support
Version 1.10 12/01/02 10-49
EFI_SIMPLE_POINTER.GetState()
Summary
Retrieves the current state of a pointer device.
Prototype
typedef
EFI_STATUS
(EFIAPI *EFI_SIMPLE_POINTER_GET_STATE)
IN EFI_SIMPLE_POINTER_PROTOCOL *This,
IN OUT EFI_SIMPLE_POINTER_STATE *State
);
Parameters
This A pointer to the EFI_SIMPLE_POINTER_PROTOCOL
instance. Type EFI_SIMPLE_POINTER_PROTOCOL is
defined in Section 10.10.
State A pointer to the state information on the pointer device. Type
EFI_SIMPLE_POINTER_STATE is defined in “Related
Definitions” below.
Related Definitions
//*******************************************************
// EFI_SIMPLE_POINTER_STATE
//*******************************************************
typedef struct {
INT32 RelativeMovementX;
INT32 RelativeMovementY;
INT32 RelativeMovementZ;
BOOLEAN LeftButton;
BOOLEAN RightButton;
} EFI_SIMPLE_POINTER_STATE;
RelativeMovementX The signed distance in counts that the pointer device has been
moved along the x-axis. The actual distance moved is
RelativeMovementX / ResolutionX millimeters. If the
ResolutionX field of the EFI_SIMPLE_POINTER_MODE
structure is 0, then this pointer device does not support an x-axis,
and this field must be ignored.