PlatformLogo.h File Reference

Data Structures
struct	_EDKII_PLATFORM_LOGO_PROTOCOL

Macros
#define	EDKII_PLATFORM_LOGO_PROTOCOL_GUID   { 0x53cd299f, 0x2bc1, 0x40c0, { 0x8c, 0x07, 0x23, 0xf6, 0x4f, 0xdb, 0x30, 0xe0 } }

Typedefs
typedef struct _EDKII_PLATFORM_LOGO_PROTOCOL	EDKII_PLATFORM_LOGO_PROTOCOL
typedef EFI_STATUS(EFIAPI *	EDKII_PLATFORM_LOGO_GET_IMAGE )(IN EDKII_PLATFORM_LOGO_PROTOCOL *This, IN OUT UINT32 *Instance, OUT EFI_IMAGE_INPUT *Image, OUT EDKII_PLATFORM_LOGO_DISPLAY_ATTRIBUTE *Attribute, OUT INTN *OffsetX, OUT INTN *OffsetY)

Enumerations
enum	EDKII_PLATFORM_LOGO_DISPLAY_ATTRIBUTE {   EdkiiPlatformLogoDisplayAttributeLeftTop, EdkiiPlatformLogoDisplayAttributeCenterTop, EdkiiPlatformLogoDisplayAttributeRightTop, EdkiiPlatformLogoDisplayAttributeCenterRight,   EdkiiPlatformLogoDisplayAttributeRightBottom, EdkiiPlatformLogoDisplayAttributeCenterBottom, EdkiiPlatformLogoDisplayAttributeLeftBottom, EdkiiPlatformLogoDisplayAttributeCenterLeft,   EdkiiPlatformLogoDisplayAttributeCenter }

Variables
EFI_GUID	gEdkiiPlatformLogoProtocolGuid

Detailed Description

The Platform Logo Protocol defines the interface to get the Platform logo image with the display attribute.

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

Macro Definition Documentation

#define EDKII_PLATFORM_LOGO_PROTOCOL_GUID   { 0x53cd299f, 0x2bc1, 0x40c0, { 0x8c, 0x07, 0x23, 0xf6, 0x4f, 0xdb, 0x30, 0xe0 } }

Typedef Documentation

typedef EFI_STATUS(EFIAPI * EDKII_PLATFORM_LOGO_GET_IMAGE)(IN EDKII_PLATFORM_LOGO_PROTOCOL *This, IN OUT UINT32 *Instance, OUT EFI_IMAGE_INPUT *Image, OUT EDKII_PLATFORM_LOGO_DISPLAY_ATTRIBUTE *Attribute, OUT INTN *OffsetX, OUT INTN *OffsetY)

Load a platform logo image and return its data and attributes.

Parameters

This	The pointer to this protocol instance.
Instance	The visible image instance is found.
Image	Points to the image.
Attribute	The display attributes of the image returned.
OffsetX	The X offset of the image regarding the Attribute.
OffsetY	The Y offset of the image regarding the Attribute.

Return values

EFI_SUCCESS	The image was fetched successfully.
EFI_NOT_FOUND	The specified image could not be found.

typedef struct _EDKII_PLATFORM_LOGO_PROTOCOL EDKII_PLATFORM_LOGO_PROTOCOL

Enumeration Type Documentation

enum EDKII_PLATFORM_LOGO_DISPLAY_ATTRIBUTE

Enumerator
EdkiiPlatformLogoDisplayAttributeLeftTop
EdkiiPlatformLogoDisplayAttributeCenterTop
EdkiiPlatformLogoDisplayAttributeRightTop
EdkiiPlatformLogoDisplayAttributeCenterRight
EdkiiPlatformLogoDisplayAttributeRightBottom
EdkiiPlatformLogoDisplayAttributeCenterBottom
EdkiiPlatformLogoDisplayAttributeLeftBottom
EdkiiPlatformLogoDisplayAttributeCenterLeft
EdkiiPlatformLogoDisplayAttributeCenter

Variable Documentation

EFI_GUID gEdkiiPlatformLogoProtocolGuid