Skip to content

std.os.uefi.protocol.absolute_pointer

Standard libraryZig 0.17.1Official documentation
Sourcestd/os/uefi/protocol/absolute_pointer.zig

Source line 1

std.os.uefi.protocol.absolute_pointer.AbsolutePointer

container

Source line 9

Protocol for touchscreens.

Fields

_reset: *const fn (*AbsolutePointer, bool) callconv(cc) Status
_get_state: *const fn (*const AbsolutePointer, *State) callconv(cc) Status
wait_for_input: Event
mode: *Mode

std.os.uefi.protocol.absolute_pointer.AbsolutePointer.getState

function

Source line 28

Retrieves the current state of a pointer device.

pub fn getState(self: *const AbsolutePointer) GetStateError!State

Parameters

self: *const AbsolutePointer

Errors

DeviceError
NotReady
Unexpected UnexpectedError

std.os.uefi.protocol.absolute_pointer.AbsolutePointer.GetStateError

error-set

Source line 16

Errors

DeviceError
NotReady
Unexpected UnexpectedError

std.os.uefi.protocol.absolute_pointer.AbsolutePointer.guid

constant

Source line 38

std.os.uefi.protocol.absolute_pointer.AbsolutePointer.Mode

container

Source line 47

Fields

absolute_min_x: u64
absolute_min_y: u64
absolute_min_z: u64
absolute_max_x: u64
absolute_max_y: u64
absolute_max_z: u64
attributes: Attributes

std.os.uefi.protocol.absolute_pointer.AbsolutePointer.Mode.Attributes

container

Source line 56

Fields

supports_alt_active: bool
supports_pressure_as_z: bool
_pad: u30 = 0

std.os.uefi.protocol.absolute_pointer.AbsolutePointer.reset

function

Source line 19

Resets the pointer device hardware.

pub fn reset(self: *AbsolutePointer, verify: bool) ResetError!void

Parameters

self: *AbsolutePointer
verify: bool

Errors

DeviceError
Unexpected UnexpectedError

std.os.uefi.protocol.absolute_pointer.AbsolutePointer.ResetError

error-set

Source line 15

Errors

DeviceError
Unexpected UnexpectedError

std.os.uefi.protocol.absolute_pointer.AbsolutePointer.State

container

Source line 63

Fields

current_x: u64
current_y: u64
current_z: u64
active_buttons: ActiveButtons

std.os.uefi.protocol.absolute_pointer.AbsolutePointer.State.ActiveButtons

container

Source line 69

Fields

touch_active: bool
alt_active: bool
_pad: u30 = 0

std.os.uefi.protocol.absolute_pointer.cc

alias

Source line 6

Alias of std.os.uefi.cc

std.os.uefi.protocol.absolute_pointer.Event

alias

Source line 3

Alias of std.os.uefi.Event

std.os.uefi.protocol.absolute_pointer.Guid

alias

Source line 4

Alias of std.os.uefi.Guid

std.os.uefi.protocol.absolute_pointer.Status

alias

Source line 5

Alias of std.os.uefi.Status

std.os.uefi.protocol.absolute_pointer.std

alias

Source line 1

Alias of std

std.os.uefi.protocol.absolute_pointer.uefi

alias

Source line 2

Alias of std.os.uefi

Source code

std/os/uefi/protocol/absolute_pointer.zig

const std = @import("std");
const uefi = std.os.uefi;
const Event = uefi.Event;
const Guid = uefi.Guid;
const Status = uefi.Status;
const cc = uefi.cc;

/// Protocol for touchscreens.
pub const AbsolutePointer = extern struct {
    _reset: *const fn (*AbsolutePointer, bool) callconv(cc) Status,
    _get_state: *const fn (*const AbsolutePointer, *State) callconv(cc) Status,
    wait_for_input: Event,
    mode: *Mode,

    pub const ResetError = uefi.UnexpectedError || error{DeviceError};
    pub const GetStateError = uefi.UnexpectedError || error{ NotReady, DeviceError };

    /// Resets the pointer device hardware.
    pub fn reset(self: *AbsolutePointer, verify: bool) ResetError!void {
        switch (self._reset(self, verify)) {
            .success => {},
            .device_error => return error.DeviceError,
            else => |status| return uefi.unexpectedStatus(status),
        }
    }

    /// Retrieves the current state of a pointer device.
    pub fn getState(self: *const AbsolutePointer) GetStateError!State {
        var state: State = undefined;
        switch (self._get_state(self, &state)) {
            .success => return state,
            .not_ready => return error.NotReady,
            .device_error => return error.DeviceError,
            else => |status| return uefi.unexpectedStatus(status),
        }
    }

    pub const guid align(8) = Guid{
        .time_low = 0x8d59d32b,
        .time_mid = 0xc655,
        .time_high_and_version = 0x4ae9,
        .clock_seq_high_and_reserved = 0x9b,
        .clock_seq_low = 0x15,
        .node = [_]u8{ 0xf2, 0x59, 0x04, 0x99, 0x2a, 0x43 },
    };

    pub const Mode = extern struct {
        absolute_min_x: u64,
        absolute_min_y: u64,
        absolute_min_z: u64,
        absolute_max_x: u64,
        absolute_max_y: u64,
        absolute_max_z: u64,
        attributes: Attributes,

        pub const Attributes = packed struct(u32) {
            supports_alt_active: bool,
            supports_pressure_as_z: bool,
            _pad: u30 = 0,
        };
    };

    pub const State = extern struct {
        current_x: u64,
        current_y: u64,
        current_z: u64,
        active_buttons: ActiveButtons,

        pub const ActiveButtons = packed struct(u32) {
            touch_active: bool,
            alt_active: bool,
            _pad: u30 = 0,
        };
    };
};