From 0d56f058ed2ae43f997425d4902e9250693102f9 Mon Sep 17 00:00:00 2001 From: Ruiyu Ni Date: Wed, 18 Nov 2015 08:53:30 +0000 Subject: MdeModulePkg: Add BootLogoLib to provide interfaces about logo display. (Sync patch r18772 from main trunk.) Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Ruiyu Ni Reviewed-by: Feng Tian Reviewed-by: Jordan Justen git-svn-id: https://svn.code.sf.net/p/edk2/code/branches/UDK2015@18882 6f19259b-4bc3-4df7-8a09-765794883524 --- MdeModulePkg/Include/Library/BootLogoLib.h | 82 ++++++++++++++++++++++++++++++ 1 file changed, 82 insertions(+) create mode 100644 MdeModulePkg/Include/Library/BootLogoLib.h (limited to 'MdeModulePkg/Include') diff --git a/MdeModulePkg/Include/Library/BootLogoLib.h b/MdeModulePkg/Include/Library/BootLogoLib.h new file mode 100644 index 0000000000..3637405371 --- /dev/null +++ b/MdeModulePkg/Include/Library/BootLogoLib.h @@ -0,0 +1,82 @@ +/** @file + This library is only intended to be used by PlatformBootManagerLib + to show progress bar and LOGO. + +Copyright (c) 2011 - 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. + +**/ + +#ifndef _BOOT_LOGO_LIB_H_ +#define _BOOT_LOGO_LIB_H_ + +#include + +/** + Show LOGO on all consoles. + + @param[in] ImageFormat Format of the image file. + @param[in] LogoFile The file name of logo to display. + @param[in] Attribute The display attributes of the image returned. + @param[in] CoordinateX The X coordinate of the image. + @param[in] CoordinateY The Y coordinate of the image. + + @retval EFI_SUCCESS Logo was displayed. + @retval EFI_UNSUPPORTED Logo was not found or cannot be displayed. +**/ +EFI_STATUS +EFIAPI +BootLogoEnableLogo ( + IN IMAGE_FORMAT ImageFormat, + IN EFI_GUID *Logo, + IN EDKII_PLATFORM_LOGO_DISPLAY_ATTRIBUTE Attribute, + IN UINTN CoordinateX, + IN UINTN CoordinateY + ); + + +/** + 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. + + @retval EFI_SUCCESS UGA devices are back in text mode and synced up. + +**/ +EFI_STATUS +EFIAPI +BootLogoDisableLogo ( + VOID + ); + +/** + + Update progress bar with title above it. It only works in Graphics mode. + + @param TitleForeground Foreground color for Title. + @param TitleBackground Background color for Title. + @param Title Title above progress bar. + @param ProgressColor Progress bar color. + @param Progress Progress (0-100) + @param PreviousValue The previous value of the progress. + + @retval EFI_STATUS Successly update the progress bar + +**/ +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 + ); + +#endif -- cgit v1.2.3