diff options
Diffstat (limited to 'MdePkg/Include/Library/GraphicsLib.h')
-rw-r--r-- | MdePkg/Include/Library/GraphicsLib.h | 110 |
1 files changed, 78 insertions, 32 deletions
diff --git a/MdePkg/Include/Library/GraphicsLib.h b/MdePkg/Include/Library/GraphicsLib.h index f503561708..c9fa564a8c 100644 --- a/MdePkg/Include/Library/GraphicsLib.h +++ b/MdePkg/Include/Library/GraphicsLib.h @@ -22,18 +22,18 @@ Return the graphics image file named FileNameGuid into Image and return it's
size in ImageSize. All Firmware Volumes (FV) in the system are searched for the
file name.
- - @param[in] FileNameGuid File Name of graphics file in the FV(s). +
+ @param[in] FileNameGuid File Name of graphics file in the FV(s).
@param[out] Image Pointer to pointer to return graphics image. If NULL, a
- buffer will be allocated. + buffer will be allocated.
@param[out] ImageSize Size of the graphics Image in bytes. Zero if no image found.
- - @retval EFI_INVALID_PARAMETER invalid parameter +
+ @retval EFI_INVALID_PARAMETER invalid parameter
@retval EFI_UNSUPPORTED Range can not be erased
@retval EFI_SUCCESS Image and ImageSize are valid.
@retval EFI_BUFFER_TOO_SMALL Image not big enough. ImageSize has required size
@retval EFI_NOT_FOUND FileNameGuid not found
- +
**/
EFI_STATUS
GetGraphicsBitMapFromFV (
@@ -42,23 +42,50 @@ GetGraphicsBitMapFromFV ( OUT UINTN *ImageSize
);
+/**
+ Return the graphics image file named FileNameGuid into Image and return it's
+ size in ImageSize. All Firmware Volumes (FV) in the system are searched for the
+ file name.
+
+ @param[in] ImageHandle The driver image handle of the caller. The parameter is used to
+ optimize the loading of the image file so that the FV from which
+ the driver image is loaded will be tried first.
+ @param[in] FileNameGuid File Name of graphics file in the FV(s).
+ @param[out] Image Pointer to pointer to return graphics image. If NULL, a
+ buffer will be allocated.
+ @param[out] ImageSize Size of the graphics Image in bytes. Zero if no image found.
+
+ @retval EFI_INVALID_PARAMETER invalid parameter
+ @retval EFI_UNSUPPORTED Range can not be erased
+ @retval EFI_SUCCESS Image and ImageSize are valid.
+ @retval EFI_BUFFER_TOO_SMALL Image not big enough. ImageSize has required size
+ @retval EFI_NOT_FOUND FileNameGuid not found
+
+**/
+EFI_STATUS
+GetGraphicsBitMapFromFVEx (
+ IN EFI_HANDLE ImageHandle,
+ IN EFI_GUID *FileNameGuid,
+ OUT VOID **Image,
+ OUT UINTN *ImageSize
+ );
/**
Convert a *.BMP graphics image to a UGA blt buffer. If a NULL UgaBlt buffer
is passed in a UgaBlt buffer will be allocated by this routine. If a UgaBlt
buffer is passed in it will be used if it is big enough.
- - @param[in] BmpImage Pointer to BMP file - @param[in] BmpImageSize Number of bytes in BmpImage - @param[in,out] UgaBlt Buffer containing UGA version of BmpImage. - @param[in,out] UgaBltSize Size of UgaBlt in bytes. - @param[out] PixelHeight Height of UgaBlt/BmpImage in pixels - @param[out] PixelWidth Width of UgaBlt/BmpImage in pixels - +
+ @param[in] BmpImage Pointer to BMP file
+ @param[in] BmpImageSize Number of bytes in BmpImage
+ @param[in,out] UgaBlt Buffer containing UGA version of BmpImage.
+ @param[in,out] UgaBltSize Size of UgaBlt in bytes.
+ @param[out] PixelHeight Height of UgaBlt/BmpImage in pixels
+ @param[out] PixelWidth Width of UgaBlt/BmpImage in pixels
+
@retval EFI_SUCCESS UgaBlt and UgaBltSize are returned.
@retval EFI_UNSUPPORTED BmpImage is not a valid *.BMP image
@retval EFI_BUFFER_TOO_SMALL The passed in UgaBlt buffer is not big enough.
- UgaBltSize will contain the required size. + UgaBltSize will contain the required size.
**/
EFI_STATUS
ConvertBmpToUgaBlt (
@@ -74,9 +101,9 @@ ConvertBmpToUgaBlt ( /**
Use Console Control to turn off UGA based Simple Text Out consoles from going
to the UGA device. Put up LogoFile on every UGA device that is a console
- - @param[in] LogoFile File name of logo to display on the center of the screen. - +
+ @param[in] LogoFile File name of logo to display on the center of the screen.
+
@retval EFI_SUCCESS ConsoleControl has been flipped to graphics and logo displayed.
@retval EFI_UNSUPPORTED Logo not found
@@ -86,11 +113,30 @@ EnableQuietBoot ( IN EFI_GUID *LogoFile
);
+/**
+ Use Console Control to turn off GOP/UGA based Simple Text Out consoles from going
+ to the UGA device. Put up LogoFile on every UGA device that is a console
+
+ @param LogoFile File name of logo to display on the center of the screen.
+ @param ImageHandle The driver image handle of the caller. The parameter is used to
+ optimize the loading of the logo file so that the FV from which
+ the driver image is loaded will be tried first.
+
+ @retval EFI_SUCCESS ConsoleControl has been flipped to graphics and logo displayed.
+ @retval EFI_UNSUPPORTED Logo not found
+
+**/
+EFI_STATUS
+EnableQuietBootEx (
+ IN EFI_GUID *LogoFile,
+ IN EFI_HANDLE ImageHandle
+ );
+
/**
Use Console Control to turn on UGA based Simple Text Out consoles. The UGA
Simple Text Out screens will now be synced up with all non UGA output devices
- +
@retval EFI_SUCCESS UGA devices are back in text mode and synced up.
**/
@@ -105,9 +151,9 @@ DisableQuietBoot ( This is the ConInHandle and ConIn handle in the EFI system table. All key
presses will be ignored until the Password is typed in. The only way to
disable the password is to type it in to a ConIn device.
- - @param[in] Password Password used to lock ConIn device. - +
+ @param[in] Password Password used to lock ConIn device.
+
@retval EFI_SUCCESS ConsoleControl has been flipped to graphics and logo
displayed.
@retval EFI_UNSUPPORTED Password not found
@@ -120,16 +166,16 @@ LockKeyboards ( /**
- Print to graphics screen at the given X,Y coordinates of the graphics screen. - see definition of Print to find rules for constructing Fmt. - - @param[in] X Row to start printing at - @param[in] Y Column to start printing at - @param[in] Foreground Foreground color - @param[in] Background background color - @param[in] Fmt Print format sting. See definition of Print - @param[in] ... Argumnet stream defined by Fmt string - + Print to graphics screen at the given X,Y coordinates of the graphics screen.
+ see definition of Print to find rules for constructing Fmt.
+
+ @param[in] X Row to start printing at
+ @param[in] Y Column to start printing at
+ @param[in] Foreground Foreground color
+ @param[in] Background background color
+ @param[in] Fmt Print format sting. See definition of Print
+ @param[in] ... Argumnet stream defined by Fmt string
+
@retval UINTN Number of Characters printed
**/
|