BootLogoLib.h File Reference

#include <Protocol/PlatformLogo.h>
#include <Protocol/GraphicsOutput.h>

Go to the source code of this file.

Functions
EFI_STATUS EFIAPI	BootLogoEnableLogo (VOID)
EFI_STATUS EFIAPI	BootLogoDisableLogo (VOID)
EFI_STATUS EFIAPI	BootLogoUpdateProgress (IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL TitleForeground, IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL TitleBackground, IN CHAR16 *Title, IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL ProgressColor, IN UINTN Progress, IN UINTN PreviousValue)

Detailed Description

This library is only intended to be used by PlatformBootManagerLib to show progress bar and LOGO.

Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file BootLogoLib.h.

Function Documentation

BootLogoDisableLogo()

EFI_STATUS EFIAPI BootLogoDisableLogo

(

VOID

)

Use SystemTable ConOut to turn on video based Simple Text Out consoles. The Simple Text Out screens will now be synced up with all non-video output devices.

Return values

EFI_SUCCESS

UGA devices are back in text mode and synced up.

Use SystemTable Conout to turn on video based Simple Text Out consoles. The Simple Text Out screens will now be synced up with all non video output devices

Return values

EFI_SUCCESS

UGA devices are back in text mode and synced up.

Definition at line 376 of file BootLogoLib.c.

BootLogoEnableLogo()

EFI_STATUS EFIAPI BootLogoEnableLogo

(

VOID

)

Show LOGO returned from Edkii Platform Logo protocol on all consoles.

Show LOGO returned from Edkii Platform Logo protocol on all consoles.

Return values

EFI_SUCCESS	Logo was displayed.
EFI_UNSUPPORTED	Logo was not found or cannot be displayed.

Definition at line 34 of file BootLogoLib.c.

BootLogoUpdateProgress()

EFI_STATUS EFIAPI BootLogoUpdateProgress	(	IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL	TitleForeground,
		IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL	TitleBackground,
		IN CHAR16 *	Title,
		IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL	ProgressColor,
		IN UINTN	Progress,
		IN UINTN	PreviousValue
	)

Update progress bar with title above it. It only works in Graphics mode.

Parameters

TitleForeground	Foreground color for Title.
TitleBackground	Background color for Title.
Title	Title above progress bar.
ProgressColor	Progress bar color.
Progress	Progress (0-100)
PreviousValue	The previous value of the progress.

Return values

EFI_STATUS

Successly update the progress bar

Update progress bar with title above it. It only works in Graphics mode.

Parameters

TitleForeground	Foreground color for Title.
TitleBackground	Background color for Title.
Title	Title above progress bar.
ProgressColor	Progress bar color.
Progress	Progress (0-100)
PreviousValue	The previous value of the progress.

Return values

EFI_STATUS

Success update the progress bar

Definition at line 403 of file BootLogoLib.c.