MdeModulePkg: Add BootLogoLib to provide interfaces about logo display.

[mirror_edk2.git] / MdeModulePkg / Include / Library / BootLogoLib.h

/** @file\r
  This library is only intended to be used by PlatformBootManagerLib\r
  to show progress bar and LOGO.\r
\r
Copyright (c) 2011 - 2015, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials are licensed and made available under\r
the terms and conditions of the BSD License that accompanies this distribution.\r
The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php.\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#ifndef _BOOT_LOGO_LIB_H_\r
#define _BOOT_LOGO_LIB_H_\r
\r
#include <Protocol/PlatformLogo.h>\r
\r
/**\r
  Show LOGO on all consoles.\r
\r
  @param[in]  ImageFormat Format of the image file.\r
  @param[in]  LogoFile    The file name of logo to display.\r
  @param[in]  Attribute   The display attributes of the image returned.\r
  @param[in]  CoordinateX The X coordinate of the image.\r
  @param[in]  CoordinateY The Y coordinate of the image.\r
\r
  @retval EFI_SUCCESS     Logo was displayed.\r
  @retval EFI_UNSUPPORTED Logo was not found or cannot be displayed.\r
**/\r
EFI_STATUS\r
EFIAPI\r
BootLogoEnableLogo (\r
  IN  IMAGE_FORMAT                          ImageFormat,\r
  IN  EFI_GUID                              *Logo,\r
  IN  EDKII_PLATFORM_LOGO_DISPLAY_ATTRIBUTE Attribute,\r
  IN  UINTN                                 CoordinateX,\r
  IN  UINTN                                 CoordinateY\r
  );\r
\r
\r
/**\r
  Use SystemTable ConOut to turn on video based Simple Text Out consoles. The \r
  Simple Text Out screens will now be synced up with all non-video output devices.\r
\r
  @retval EFI_SUCCESS     UGA devices are back in text mode and synced up.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
BootLogoDisableLogo (\r
  VOID\r
  );\r
\r
/**\r
\r
  Update progress bar with title above it. It only works in Graphics mode.\r
\r
  @param TitleForeground Foreground color for Title.\r
  @param TitleBackground Background color for Title.\r
  @param Title           Title above progress bar.\r
  @param ProgressColor   Progress bar color.\r
  @param Progress        Progress (0-100)\r
  @param PreviousValue   The previous value of the progress.\r
\r
  @retval  EFI_STATUS    Successly update the progress bar\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
BootLogoUpdateProgress (\r
  IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL TitleForeground,\r
  IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL TitleBackground,\r
  IN CHAR16                        *Title,\r
  IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL ProgressColor,\r
  IN UINTN                         Progress,\r
  IN UINTN                         PreviousValue\r
  );\r
\r
#endif\r