BootLogo.h File Reference

#include <Protocol/GraphicsOutput.h>

Go to the source code of this file.

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 OPTIONAL, 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

Definition in file BootLogo.h.

Macro Definition Documentation

EFI_BOOT_LOGO_PROTOCOL_GUID

#define EFI_BOOT_LOGO_PROTOCOL_GUID

Value:

  { \
    0xcdea2bd3, 0xfc25, 0x4c1c, { 0xb9, 0x7c, 0xb3, 0x11, 0x86, 0x6, 0x49, 0x90 } \
  }

Definition at line 14 of file BootLogo.h.

Typedef Documentation

EFI_BOOT_LOGO_PROTOCOL

typedef struct _EFI_BOOT_LOGO_PROTOCOL EFI_BOOT_LOGO_PROTOCOL

Definition at line 22 of file BootLogo.h.

EFI_SET_BOOT_LOGO

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

Update information of logo image drawn on screen.

Parameters

This	The pointer to the Boot Logo protocol instance.
BltBuffer	The BLT buffer for logo drawn on screen. If BltBuffer is set to NULL, it indicates that logo image is no longer on the screen.
DestinationX	X coordinate of destination for the BltBuffer.
DestinationY	Y coordinate of destination for the BltBuffer.
Width	Width of rectangle in BltBuffer in pixels.
Height	Hight of rectangle in BltBuffer in pixels.

Return values

EFI_SUCCESS	The boot logo information was updated.
EFI_INVALID_PARAMETER	One of the parameters has an invalid value.
EFI_OUT_OF_RESOURCES	The logo information was not updated due to insufficient memory resources.

Definition at line 43 of file BootLogo.h.