]>
git.proxmox.com Git - mirror_edk2.git/blob - EdkModulePkg/Include/Library/EdkGraphicsLib.h
3 Copyright (c) 2006, Intel Corporation
4 All rights reserved. This program and the accompanying materials
5 are licensed and made available under the terms and conditions of the BSD License
6 which accompanies this distribution. The full text of the license may be found at
7 http://opensource.org/licenses/bsd-license.php
9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
21 #ifndef _EFI_GRAPHICS_LIB_H_
22 #define _EFI_GRAPHICS_LIB_H_
25 GetGraphicsBitMapFromFV (
26 IN EFI_GUID
*FileNameGuid
,
34 Return the graphics image file named FileNameGuid into Image and return it's
35 size in ImageSize. All Firmware Volumes (FV) in the system are searched for the
40 FileNameGuid - File Name of graphics file in the FV(s).
42 Image - Pointer to pointer to return graphics image. If NULL, a
43 buffer will be allocated.
45 ImageSize - Size of the graphics Image in bytes. Zero if no image found.
50 EFI_SUCCESS - Image and ImageSize are valid.
51 EFI_BUFFER_TOO_SMALL - Image not big enough. ImageSize has required size
52 EFI_NOT_FOUND - FileNameGuid not found
60 IN UINTN BmpImageSize
,
62 IN OUT UINTN
*UgaBltSize
,
63 OUT UINTN
*PixelHeight
,
70 Convert a *.BMP graphics image to a UGA blt buffer. If a NULL UgaBlt buffer
71 is passed in a UgaBlt buffer will be allocated by this routine. If a UgaBlt
72 buffer is passed in it will be used if it is big enough.
76 BmpImage - Pointer to BMP file
78 BmpImageSize - Number of bytes in BmpImage
80 UgaBlt - Buffer containing UGA version of BmpImage.
82 UgaBltSize - Size of UgaBlt in bytes.
84 PixelHeight - Height of UgaBlt/BmpImage in pixels
86 PixelWidth - Width of UgaBlt/BmpImage in pixels
91 EFI_SUCCESS - UgaBlt and UgaBltSize are returned.
92 EFI_UNSUPPORTED - BmpImage is not a valid *.BMP image
93 EFI_BUFFER_TOO_SMALL - The passed in UgaBlt buffer is not big enough.
94 UgaBltSize will contain the required size.
101 IN EFI_GUID
*LogoFile
107 Use Console Control to turn off UGA based Simple Text Out consoles from going
108 to the UGA device. Put up LogoFile on every UGA device that is a console
112 LogoFile - File name of logo to display on the center of the screen.
117 EFI_SUCCESS - ConsoleControl has been flipped to graphics and logo
119 EFI_UNSUPPORTED - Logo not found
132 Use Console Control to turn on UGA based Simple Text Out consoles. The UGA
133 Simple Text Out screens will now be synced up with all non UGA output devices
141 EFI_SUCCESS - UGA devices are back in text mode and synced up.
142 EFI_UNSUPPORTED - Logo not found
154 Use Console Control Protocol to lock the Console In Spliter virtual handle.
155 This is the ConInHandle and ConIn handle in the EFI system table. All key
156 presses will be ignored until the Password is typed in. The only way to
157 disable the password is to type it in to a ConIn device.
160 Password - Password used to lock ConIn device
165 EFI_SUCCESS - ConsoleControl has been flipped to graphics and logo
167 EFI_UNSUPPORTED - Logo not found
177 IN EFI_UGA_PIXEL
*Foreground
, OPTIONAL
178 IN EFI_UGA_PIXEL
*Background
, OPTIONAL