跳转到内容

std.os.uefi.protocol.graphics_output

标准库Zig 0.17.0官方原文
源码std/os/uefi/protocol/graphics_output.zig

第 1 行

std.os.uefi.protocol.graphics_output.cc

别名

第 5 行

别名目标 std.os.uefi.cc

std.os.uefi.protocol.graphics_output.GraphicsOutput

容器

第 7 行

字段

_query_mode: *const fn (*const GraphicsOutput, u32, *usize, **Mode.Info) callconv(cc) Status
_set_mode: *const fn (*GraphicsOutput, u32) callconv(cc) Status
_blt: *const fn (*GraphicsOutput, ?[*]BltPixel, BltOperation, usize, usize, usize, usize, usize, usize, usize) callconv(cc) Status
mode: *Mode

std.os.uefi.protocol.graphics_output.GraphicsOutput.blt

函数

第 49 行

对图形屏幕上的像素矩形执行 Blt。Blt 表示块传输(BLock Transfer)。

pub fn blt( self: *GraphicsOutput, blt_buffer: ?[*]BltPixel, blt_operation: BltOperation, source_x: usize, source_y: usize, destination_x: usize, destination_y: usize, width: usize, height: usize, delta: usize, ) BltError!void

参数

self: *GraphicsOutput
blt_buffer: ?[*]BltPixel
blt_operation: BltOperation
source_x: usize
source_y: usize
destination_x: usize
destination_y: usize
width: usize
height: usize
delta: usize

错误

DeviceError
InvalidParameter
Unexpected UnexpectedError

std.os.uefi.protocol.graphics_output.GraphicsOutput.BltError

错误集合

第 21 行

错误

DeviceError
InvalidParameter
Unexpected UnexpectedError

std.os.uefi.protocol.graphics_output.GraphicsOutput.BltOperation

容器

第 128 行

字段

blt_video_fill
blt_video_to_blt_buffer
blt_buffer_to_video
blt_video_to_video
graphics_output_blt_operation_max

std.os.uefi.protocol.graphics_output.GraphicsOutput.BltPixel

容器

第 121 行

字段

blue: u8
green: u8
red: u8
reserved: u8 = undefined

std.os.uefi.protocol.graphics_output.GraphicsOutput.guid

常量

第 80 行

std.os.uefi.protocol.graphics_output.GraphicsOutput.Mode

容器

第 89 行

字段

max_mode: u32
mode: u32
info: *Info
size_of_info: usize
frame_buffer_base: u64
frame_buffer_size: usize

std.os.uefi.protocol.graphics_output.GraphicsOutput.Mode.Info

容器

第 97 行

字段

version: u32
horizontal_resolution: u32
vertical_resolution: u32
pixel_format: PixelFormat
pixel_information: PixelBitmask
pixels_per_scan_line: u32

std.os.uefi.protocol.graphics_output.GraphicsOutput.PixelBitmask

容器

第 114 行

字段

red_mask: u32
green_mask: u32
blue_mask: u32
reserved_mask: u32

std.os.uefi.protocol.graphics_output.GraphicsOutput.PixelFormat

容器

第 107 行

字段

red_green_blue_reserved_8_bit_per_color
blue_green_red_reserved_8_bit_per_color
bit_mask
blt_only

std.os.uefi.protocol.graphics_output.GraphicsOutput.queryMode

函数

第 27 行

返回图形设备及当前活动视频输出设备集合所支持的某个可用图形模式的信息。

pub fn queryMode(self: *const GraphicsOutput, mode_id: u32) QueryModeError!*Mode.Info

参数

self: *const GraphicsOutput
mode_id: u32

错误

DeviceError
InvalidParameter
Unexpected UnexpectedError

std.os.uefi.protocol.graphics_output.GraphicsOutput.QueryModeError

错误集合

第 13 行

错误

DeviceError
InvalidParameter
Unexpected UnexpectedError

std.os.uefi.protocol.graphics_output.GraphicsOutput.setMode

函数

第 39 行

将视频设备设置为指定模式,并将输出显示的可见部分清为黑色。

pub fn setMode(self: *GraphicsOutput, mode_id: u32) SetModeError!void

参数

self: *GraphicsOutput
mode_id: u32

错误

DeviceError
Unexpected UnexpectedError
Unsupported

std.os.uefi.protocol.graphics_output.GraphicsOutput.SetModeError

错误集合

第 17 行

错误

DeviceError
Unexpected UnexpectedError
Unsupported

std.os.uefi.protocol.graphics_output.Guid

别名

第 3 行

别名目标 std.os.uefi.Guid

std.os.uefi.protocol.graphics_output.Status

别名

第 4 行

别名目标 std.os.uefi.Status

std.os.uefi.protocol.graphics_output.std

别名

第 1 行

别名目标 std

std.os.uefi.protocol.graphics_output.uefi

别名

第 2 行

别名目标 std.os.uefi

源码

std/os/uefi/protocol/graphics_output.zig

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

pub const GraphicsOutput = extern struct {
    _query_mode: *const fn (*const GraphicsOutput, u32, *usize, **Mode.Info) callconv(cc) Status,
    _set_mode: *const fn (*GraphicsOutput, u32) callconv(cc) Status,
    _blt: *const fn (*GraphicsOutput, ?[*]BltPixel, BltOperation, usize, usize, usize, usize, usize, usize, usize) callconv(cc) Status,
    mode: *Mode,

    pub const QueryModeError = uefi.UnexpectedError || error{
        DeviceError,
        InvalidParameter,
    };
    pub const SetModeError = uefi.UnexpectedError || error{
        DeviceError,
        Unsupported,
    };
    pub const BltError = uefi.UnexpectedError || error{
        InvalidParameter,
        DeviceError,
    };

    /// 返回图形设备及当前活动视频输出设备集合所支持的某个可用图形模式的信息。
    pub fn queryMode(self: *const GraphicsOutput, mode_id: u32) QueryModeError!*Mode.Info {
        var size_of_info: usize = undefined;
        var info: *Mode.Info = undefined;
        switch (self._query_mode(self, mode_id, &size_of_info, &info)) {
            .success => return info,
            .device_error => return error.DeviceError,
            .invalid_parameter => return error.InvalidParameter,
            else => |status| return uefi.unexpectedStatus(status),
        }
    }

    /// 将视频设备设置为指定模式,并将输出显示的可见部分清为黑色。
    pub fn setMode(self: *GraphicsOutput, mode_id: u32) SetModeError!void {
        switch (self._set_mode(self, mode_id)) {
            .success => {},
            .device_error => return error.DeviceError,
            .unsupported => return error.Unsupported,
            else => |status| return uefi.unexpectedStatus(status),
        }
    }

    /// 对图形屏幕上的像素矩形执行 Blt。Blt 表示块传输(BLock Transfer)。
    pub fn blt(
        self: *GraphicsOutput,
        blt_buffer: ?[*]BltPixel,
        blt_operation: BltOperation,
        source_x: usize,
        source_y: usize,
        destination_x: usize,
        destination_y: usize,
        width: usize,
        height: usize,
        delta: usize,
    ) BltError!void {
        switch (self._blt(
            self,
            blt_buffer,
            blt_operation,
            source_x,
            source_y,
            destination_x,
            destination_y,
            width,
            height,
            delta,
        )) {
            .success => {},
            .device_error => return error.DeviceError,
            .invalid_parameter => return error.InvalidParameter,
            else => |status| return uefi.unexpectedStatus(status),
        }
    }

    pub const guid align(8) = Guid{
        .time_low = 0x9042a9de,
        .time_mid = 0x23dc,
        .time_high_and_version = 0x4a38,
        .clock_seq_high_and_reserved = 0x96,
        .clock_seq_low = 0xfb,
        .node = [_]u8{ 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a },
    };

    pub const Mode = extern struct {
        max_mode: u32,
        mode: u32,
        info: *Info,
        size_of_info: usize,
        frame_buffer_base: u64,
        frame_buffer_size: usize,

        pub const Info = extern struct {
            version: u32,
            horizontal_resolution: u32,
            vertical_resolution: u32,
            pixel_format: PixelFormat,
            pixel_information: PixelBitmask,
            pixels_per_scan_line: u32,
        };
    };

    pub const PixelFormat = enum(u32) {
        red_green_blue_reserved_8_bit_per_color,
        blue_green_red_reserved_8_bit_per_color,
        bit_mask,
        blt_only,
    };

    pub const PixelBitmask = extern struct {
        red_mask: u32,
        green_mask: u32,
        blue_mask: u32,
        reserved_mask: u32,
    };

    pub const BltPixel = extern struct {
        blue: u8,
        green: u8,
        red: u8,
        reserved: u8 = undefined,
    };

    pub const BltOperation = enum(u32) {
        blt_video_fill,
        blt_video_to_blt_buffer,
        blt_buffer_to_video,
        blt_video_to_video,
        graphics_output_blt_operation_max,
    };
};