MdePkg/Include/Library/GraphicsLib.h

   1 /** @file
   2   Graphics Library
   3
   4   Copyright (c) 2006 - 2008, Intel Corporation.<BR>
   5   All rights reserved. This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef __EFI_GRAPHICS_LIB_H__
  16 #define __EFI_GRAPHICS_LIB_H__
  17
  18 #include <Protocol/GraphicsOutput.h>
  19
  20
  21 /**
  22   Return the graphics image file named FileNameGuid into Image and return it's
  23   size in ImageSize. All Firmware Volumes (FV) in the system are searched for the
  24   file name.
  25
  26   @param[in]  FileNameGuid  File Name of graphics file in the FV(s).
  27   @param[out] Image         Pointer to pointer to return graphics image.  If NULL, a
  28                             buffer will be allocated.
  29   @param[out] ImageSize     Size of the graphics Image in bytes. Zero if no image found.
  30
  31   @retval   EFI_INVALID_PARAMETER  invalid parameter
  32   @retval   EFI_UNSUPPORTED        Range can not be erased
  33   @retval   EFI_SUCCESS            Image and ImageSize are valid.
  34   @retval   EFI_BUFFER_TOO_SMALL   Image not big enough. ImageSize has required size
  35   @retval   EFI_NOT_FOUND          FileNameGuid not found
  36
  37 **/
  38 EFI_STATUS
  39 EFIAPI
  40 GetGraphicsBitMapFromFV (
  41   IN  EFI_GUID      *FileNameGuid,
  42   OUT VOID          **Image,
  43   OUT UINTN         *ImageSize
  44   );
  45
  46 /**
  47   Return the graphics image file named FileNameGuid into Image and return it's
  48   size in ImageSize. All Firmware Volumes (FV) in the system are searched for the
  49   file name.
  50
  51   @param[in]  ImageHandle   The driver image handle of the caller. The parameter is used to
  52                             optimize the loading of the image file so that the FV from which
  53                             the driver image is loaded will be tried first.
  54   @param[in]  FileNameGuid  File Name of graphics file in the FV(s).
  55   @param[out] Image         Pointer to pointer to return graphics image.  If NULL, a
  56                             buffer will be allocated.
  57   @param[out] ImageSize     Size of the graphics Image in bytes. Zero if no image found.
  58
  59   @retval   EFI_INVALID_PARAMETER  invalid parameter
  60   @retval   EFI_UNSUPPORTED        Range can not be erased
  61   @retval   EFI_SUCCESS            Image and ImageSize are valid.
  62   @retval   EFI_BUFFER_TOO_SMALL   Image not big enough. ImageSize has required size
  63   @retval   EFI_NOT_FOUND          FileNameGuid not found
  64
  65 **/
  66 EFI_STATUS
  67 EFIAPI
  68 GetGraphicsBitMapFromFVEx (
  69   IN  EFI_HANDLE    ImageHandle,
  70   IN  EFI_GUID      *FileNameGuid,
  71   OUT VOID          **Image,
  72   OUT UINTN         *ImageSize
  73   );
  74
  75
  76 /**
  77   Use Console Control to turn off UGA based Simple Text Out consoles from going
  78   to the UGA device. Put up LogoFile on every UGA device that is a console
  79
  80   @param[in]  LogoFile   File name of logo to display on the center of the screen.
  81
  82   @retval EFI_SUCCESS     ConsoleControl has been flipped to graphics and logo displayed.
  83   @retval EFI_UNSUPPORTED Logo not found
  84
  85 **/
  86 EFI_STATUS
  87 EFIAPI
  88 EnableQuietBoot (
  89   IN  EFI_GUID  *LogoFile
  90   );
  91
  92 /**
  93   Use Console Control to turn off GOP/UGA based Simple Text Out consoles from going
  94   to the UGA device. Put up LogoFile on every UGA device that is a console
  95
  96   @param  LogoFile    File name of logo to display on the center of the screen.
  97   @param  ImageHandle The driver image handle of the caller. The parameter is used to
  98                       optimize the loading of the logo file so that the FV from which
  99                       the driver image is loaded will be tried first.
 100
 101   @retval EFI_SUCCESS     ConsoleControl has been flipped to graphics and logo displayed.
 102   @retval EFI_UNSUPPORTED Logo not found
 103
 104 **/
 105 EFI_STATUS
 106 EFIAPI
 107 EnableQuietBootEx (
 108   IN  EFI_GUID    *LogoFile,
 109   IN  EFI_HANDLE  ImageHandle
 110   );
 111
 112
 113 /**
 114   Use Console Control to turn on UGA based Simple Text Out consoles. The UGA
 115   Simple Text Out screens will now be synced up with all non UGA output devices
 116
 117   @retval EFI_SUCCESS     UGA devices are back in text mode and synced up.
 118
 119 **/
 120 EFI_STATUS
 121 EFIAPI
 122 DisableQuietBoot (
 123   VOID
 124   );
 125
 126
 127 /**
 128   Use Console Control Protocol to lock the Console In Spliter virtual handle.
 129   This is the ConInHandle and ConIn handle in the EFI system table. All key
 130   presses will be ignored until the Password is typed in. The only way to
 131   disable the password is to type it in to a ConIn device.
 132
 133   @param[in]  Password   Password used to lock ConIn device.
 134
 135   @retval EFI_SUCCESS     ConsoleControl has been flipped to graphics and logo
 136                           displayed.
 137   @retval EFI_UNSUPPORTED Password not found
 138
 139 **/
 140 EFI_STATUS
 141 EFIAPI
 142 LockKeyboards (
 143   IN  CHAR16    *Password
 144   );
 145
 146
 147 /**
 148   Print to graphics screen at the given X,Y coordinates of the graphics screen.
 149   see definition of Print to find rules for constructing Fmt.
 150
 151   @param[in]  X            Row to start printing at
 152   @param[in]  Y            Column to start printing at
 153   @param[in]  ForeGround   Foreground color
 154   @param[in]  BackGround   background color
 155   @param[in]  Fmt          Print format sting. See definition of Print
 156   @param[in]  ...          Argumnet stream defined by Fmt string
 157
 158   @return  Number of Characters printed.
 159
 160 **/
 161 UINTN
 162 EFIAPI
 163 PrintXY (
 164   IN UINTN                            X,
 165   IN UINTN                            Y,
 166   IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL    *ForeGround, OPTIONAL
 167   IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL    *BackGround, OPTIONAL
 168   IN CHAR16                           *Fmt,
 169   ...
 170   );
 171
 172
 173 #endif