MdeModulePkg[all]  0.98
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
BootLogo.h File Reference

Data Structures

struct  _EFI_BOOT_LOGO_PROTOCOL
 

Macros

#define EFI_BOOT_LOGO_PROTOCOL_GUID
 

Typedefs

typedef struct
_EFI_BOOT_LOGO_PROTOCOL 
EFI_BOOT_LOGO_PROTOCOL
 
typedef EFI_STATUS(EFIAPI * EFI_SET_BOOT_LOGO )(IN EFI_BOOT_LOGO_PROTOCOL *This, IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer, IN UINTN DestinationX, IN UINTN DestinationY, IN UINTN Width, IN UINTN Height)
 

Variables

EFI_GUID gEfiBootLogoProtocolGuid
 

Detailed Description

Boot Logo protocol is used to convey information of Logo dispayed during boot.

Copyright (c) 2011, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Macro Definition Documentation

#define EFI_BOOT_LOGO_PROTOCOL_GUID
Value:
{ \
0xcdea2bd3, 0xfc25, 0x4c1c, { 0xb9, 0x7c, 0xb3, 0x11, 0x86, 0x6, 0x49, 0x90 } \
}

Typedef Documentation

typedef EFI_STATUS(EFIAPI * EFI_SET_BOOT_LOGO)(IN EFI_BOOT_LOGO_PROTOCOL *This, IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer, IN UINTN DestinationX, IN UINTN DestinationY, IN UINTN Width, IN UINTN Height)

Update information of logo image drawn on screen.

Parameters
ThisThe pointer to the Boot Logo protocol instance.
BltBufferThe BLT buffer for logo drawn on screen. If BltBuffer is set to NULL, it indicates that logo image is no longer on the screen.
DestinationXX coordinate of destination for the BltBuffer.
DestinationYY coordinate of destination for the BltBuffer.
WidthWidth of rectangle in BltBuffer in pixels.
HeightHight of rectangle in BltBuffer in pixels.
Return values
EFI_SUCCESSThe boot logo information was updated.
EFI_INVALID_PARAMETEROne of the parameters has an invalid value.
EFI_OUT_OF_RESOURCESThe logo information was not updated due to insufficient memory resources.

Variable Documentation

EFI_GUID gEfiBootLogoProtocolGuid