diff options
| author | Ruiyu Ni <ruiyu.ni@intel.com> | 2015-11-18 08:53:30 +0000 |
|---|---|---|
| committer | vanjeff <vanjeff@Edk2> | 2015-11-18 08:53:30 +0000 |
| commit | 0d56f058ed2ae43f997425d4902e9250693102f9 (patch) | |
| tree | 7c42871e31b88b8ba549295f5344d960a19ecbe4 /MdeModulePkg/Include | |
| parent | 8fa0a25d5ac17e7c121550e5aff1e57caa0b239c (diff) | |
| download | edk2-platforms-0d56f058ed2ae43f997425d4902e9250693102f9.tar.xz | |
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 <ruiyu.ni@intel.com>
Reviewed-by: Feng Tian <feng.tian@intel.com>
Reviewed-by: Jordan Justen <jordan.l.justen@intel.com>
git-svn-id: https://svn.code.sf.net/p/edk2/code/branches/UDK2015@18882 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdeModulePkg/Include')
| -rw-r--r-- | MdeModulePkg/Include/Library/BootLogoLib.h | 82 |
1 files changed, 82 insertions, 0 deletions
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.<BR>
+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 <Protocol/PlatformLogo.h>
+
+/**
+ 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
|