uefi.protocols.simpletextout

Based on Protocol/SimpleTextOut.h, original notice:

Simple Text Out protocol from the UEFI 2.0 specification.

Abstraction of a very simple text based output device like VGA text mode or a serial terminal. The Simple Text Out protocol instance can represent a single hardware device or a virtual device that is an aggregation of multiple physical devices.

Copyright (c) 2006 - 2015, Intel Corporation. All rights reserved. This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php.

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

Members

Aliases

EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
alias EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL = _EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
EFI_TEXT_CLEAR_SCREEN
alias EFI_TEXT_CLEAR_SCREEN = EFI_STATUS function(EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL* This) @(nogc) nothrow

Clears the output device(s) display to the currently selected background color.

EFI_TEXT_ENABLE_CURSOR
alias EFI_TEXT_ENABLE_CURSOR = EFI_STATUS function(EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL* This, BOOLEAN Visible) @(nogc) nothrow

Makes the cursor visible or invisible

EFI_TEXT_QUERY_MODE
alias EFI_TEXT_QUERY_MODE = EFI_STATUS function(EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL* This, UINTN ModeNumber, UINTN* Columns, UINTN* Rows) @(nogc) nothrow

Returns information for an available text mode that the output device(s) supports.

EFI_TEXT_RESET
alias EFI_TEXT_RESET = EFI_STATUS function(EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL* This, BOOLEAN ExtendedVerification) @(nogc) nothrow

Reset the text output device hardware and optionaly run diagnostics

EFI_TEXT_SET_ATTRIBUTE
alias EFI_TEXT_SET_ATTRIBUTE = EFI_STATUS function(EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL* This, UINTN Attribute) @(nogc) nothrow

Sets the background and foreground colors for the OutputString () and ClearScreen () functions.

EFI_TEXT_SET_CURSOR_POSITION
alias EFI_TEXT_SET_CURSOR_POSITION = EFI_STATUS function(EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL* This, UINTN Column, UINTN Row) @(nogc) nothrow

Sets the current coordinates of the cursor position

EFI_TEXT_SET_MODE
alias EFI_TEXT_SET_MODE = EFI_STATUS function(EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL* This, UINTN ModeNumber) @(nogc) nothrow

Sets the output device(s) to a specified mode.

EFI_TEXT_STRING
alias EFI_TEXT_STRING = EFI_STATUS function(EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL* This, CHAR16* String) @(nogc) nothrow

Write a string to the output device.

EFI_TEXT_TEST_STRING
alias EFI_TEXT_TEST_STRING = EFI_STATUS function(EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL* This, CHAR16* String) @(nogc) nothrow

Verifies that all characters in a string can be output to the target device.

SIMPLE_TEXT_OUTPUT_INTERFACE
alias SIMPLE_TEXT_OUTPUT_INTERFACE = EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL

Backward-compatible with EFI1.1.

Manifest constants

ARROW_DOWN
enum ARROW_DOWN;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
ARROW_LEFT
enum ARROW_LEFT;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
ARROW_RIGHT
enum ARROW_RIGHT;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
ARROW_UP
enum ARROW_UP;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
BLOCKELEMENT_FULL_BLOCK
enum BLOCKELEMENT_FULL_BLOCK;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
BLOCKELEMENT_LIGHT_SHADE
enum BLOCKELEMENT_LIGHT_SHADE;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
BOXDRAW_DOUBLE_DOWN_HORIZONTAL
enum BOXDRAW_DOUBLE_DOWN_HORIZONTAL;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
BOXDRAW_DOUBLE_DOWN_LEFT
enum BOXDRAW_DOUBLE_DOWN_LEFT;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
BOXDRAW_DOUBLE_DOWN_RIGHT
enum BOXDRAW_DOUBLE_DOWN_RIGHT;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
BOXDRAW_DOUBLE_HORIZONTAL
enum BOXDRAW_DOUBLE_HORIZONTAL;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
BOXDRAW_DOUBLE_UP_HORIZONTAL
enum BOXDRAW_DOUBLE_UP_HORIZONTAL;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
BOXDRAW_DOUBLE_UP_LEFT
enum BOXDRAW_DOUBLE_UP_LEFT;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
BOXDRAW_DOUBLE_UP_RIGHT
enum BOXDRAW_DOUBLE_UP_RIGHT;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
BOXDRAW_DOUBLE_VERTICAL
enum BOXDRAW_DOUBLE_VERTICAL;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
BOXDRAW_DOUBLE_VERTICAL_HORIZONTAL
enum BOXDRAW_DOUBLE_VERTICAL_HORIZONTAL;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
BOXDRAW_DOUBLE_VERTICAL_LEFT
enum BOXDRAW_DOUBLE_VERTICAL_LEFT;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
BOXDRAW_DOUBLE_VERTICAL_RIGHT
enum BOXDRAW_DOUBLE_VERTICAL_RIGHT;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
BOXDRAW_DOWN_DOUBLE_HORIZONTAL
enum BOXDRAW_DOWN_DOUBLE_HORIZONTAL;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
BOXDRAW_DOWN_DOUBLE_LEFT
enum BOXDRAW_DOWN_DOUBLE_LEFT;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
BOXDRAW_DOWN_DOUBLE_RIGHT
enum BOXDRAW_DOWN_DOUBLE_RIGHT;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
BOXDRAW_DOWN_HORIZONTAL
enum BOXDRAW_DOWN_HORIZONTAL;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
BOXDRAW_DOWN_HORIZONTAL_DOUBLE
enum BOXDRAW_DOWN_HORIZONTAL_DOUBLE;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
BOXDRAW_DOWN_LEFT
enum BOXDRAW_DOWN_LEFT;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
BOXDRAW_DOWN_LEFT_DOUBLE
enum BOXDRAW_DOWN_LEFT_DOUBLE;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
BOXDRAW_DOWN_RIGHT
enum BOXDRAW_DOWN_RIGHT;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
BOXDRAW_DOWN_RIGHT_DOUBLE
enum BOXDRAW_DOWN_RIGHT_DOUBLE;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
BOXDRAW_HORIZONTAL
enum BOXDRAW_HORIZONTAL;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
BOXDRAW_UP_DOUBLE_HORIZONTAL
enum BOXDRAW_UP_DOUBLE_HORIZONTAL;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
BOXDRAW_UP_DOUBLE_LEFT
enum BOXDRAW_UP_DOUBLE_LEFT;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
BOXDRAW_UP_DOUBLE_RIGHT
enum BOXDRAW_UP_DOUBLE_RIGHT;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
BOXDRAW_UP_HORIZONTAL
enum BOXDRAW_UP_HORIZONTAL;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
BOXDRAW_UP_HORIZONTAL_DOUBLE
enum BOXDRAW_UP_HORIZONTAL_DOUBLE;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
BOXDRAW_UP_LEFT
enum BOXDRAW_UP_LEFT;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
BOXDRAW_UP_LEFT_DOUBLE
enum BOXDRAW_UP_LEFT_DOUBLE;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
BOXDRAW_UP_RIGHT
enum BOXDRAW_UP_RIGHT;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
BOXDRAW_UP_RIGHT_DOUBLE
enum BOXDRAW_UP_RIGHT_DOUBLE;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
BOXDRAW_VERTICAL
enum BOXDRAW_VERTICAL;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
BOXDRAW_VERTICAL_DOUBLE_HORIZONTAL
enum BOXDRAW_VERTICAL_DOUBLE_HORIZONTAL;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
BOXDRAW_VERTICAL_DOUBLE_LEFT
enum BOXDRAW_VERTICAL_DOUBLE_LEFT;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
BOXDRAW_VERTICAL_DOUBLE_RIGHT
enum BOXDRAW_VERTICAL_DOUBLE_RIGHT;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
BOXDRAW_VERTICAL_HORIZONTAL
enum BOXDRAW_VERTICAL_HORIZONTAL;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
BOXDRAW_VERTICAL_HORIZONTAL_DOUBLE
enum BOXDRAW_VERTICAL_HORIZONTAL_DOUBLE;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
BOXDRAW_VERTICAL_LEFT
enum BOXDRAW_VERTICAL_LEFT;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
BOXDRAW_VERTICAL_LEFT_DOUBLE
enum BOXDRAW_VERTICAL_LEFT_DOUBLE;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
BOXDRAW_VERTICAL_RIGHT
enum BOXDRAW_VERTICAL_RIGHT;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
BOXDRAW_VERTICAL_RIGHT_DOUBLE
enum BOXDRAW_VERTICAL_RIGHT_DOUBLE;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
EFI_BACKGROUND_BLACK
enum EFI_BACKGROUND_BLACK;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
EFI_BACKGROUND_BLUE
enum EFI_BACKGROUND_BLUE;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
EFI_BACKGROUND_BROWN
enum EFI_BACKGROUND_BROWN;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
EFI_BACKGROUND_CYAN
enum EFI_BACKGROUND_CYAN;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
EFI_BACKGROUND_GREEN
enum EFI_BACKGROUND_GREEN;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
EFI_BACKGROUND_LIGHTGRAY
enum EFI_BACKGROUND_LIGHTGRAY;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
EFI_BACKGROUND_MAGENTA
enum EFI_BACKGROUND_MAGENTA;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
EFI_BACKGROUND_RED
enum EFI_BACKGROUND_RED;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
EFI_BLACK
enum EFI_BLACK;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
EFI_BLUE
enum EFI_BLUE;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
EFI_BRIGHT
enum EFI_BRIGHT;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
EFI_BROWN
enum EFI_BROWN;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
EFI_CYAN
enum EFI_CYAN;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
EFI_DARKGRAY
enum EFI_DARKGRAY;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
EFI_GREEN
enum EFI_GREEN;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
EFI_LIGHTBLUE
enum EFI_LIGHTBLUE;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
EFI_LIGHTCYAN
enum EFI_LIGHTCYAN;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
EFI_LIGHTGRAY
enum EFI_LIGHTGRAY;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
EFI_LIGHTGREEN
enum EFI_LIGHTGREEN;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
EFI_LIGHTMAGENTA
enum EFI_LIGHTMAGENTA;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
EFI_LIGHTRED
enum EFI_LIGHTRED;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
EFI_MAGENTA
enum EFI_MAGENTA;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
EFI_RED
enum EFI_RED;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
EFI_WHITE
enum EFI_WHITE;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
EFI_WIDE_ATTRIBUTE
enum EFI_WIDE_ATTRIBUTE;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
EFI_YELLOW
enum EFI_YELLOW;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
GEOMETRICSHAPE_DOWN_TRIANGLE
enum GEOMETRICSHAPE_DOWN_TRIANGLE;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
GEOMETRICSHAPE_LEFT_TRIANGLE
enum GEOMETRICSHAPE_LEFT_TRIANGLE;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
GEOMETRICSHAPE_RIGHT_TRIANGLE
enum GEOMETRICSHAPE_RIGHT_TRIANGLE;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
GEOMETRICSHAPE_UP_TRIANGLE
enum GEOMETRICSHAPE_UP_TRIANGLE;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
SIMPLE_TEXT_OUTPUT_PROTOCOL
enum SIMPLE_TEXT_OUTPUT_PROTOCOL;

Protocol GUID defined in EFI1.1.

Structs

EFI_SIMPLE_TEXT_OUTPUT_MODE
struct EFI_SIMPLE_TEXT_OUTPUT_MODE

@par Data Structure Description: Mode Structure pointed to by Simple Text Out protocol.

_EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
struct _EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL

The SIMPLE_TEXT_OUTPUT protocol is used to control text-based output devices. It is the minimum required protocol for any handle supplied as the ConsoleOut or StandardError device. In addition, the minimum supported text mode of such devices is at least 80 x 25 characters.

Variables

EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL_GUID
enum EFI_GUID EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL_GUID;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.

Meta