IntelFrameworkModulePkg/Include/Protocol/OEMBadging.h File Reference


Data Structures

struct  _EFI_OEM_BADGING_PROTOCOL

Defines

#define EFI_OEM_BADGING_PROTOCOL_GUID   { 0x170e13c0, 0xbf1b, 0x4218, {0x87, 0x1d, 0x2a, 0xbd, 0xc6, 0xf8, 0x87, 0xbc } }

Typedefs

typedef struct
_EFI_OEM_BADGING_PROTOCOL 
EFI_OEM_BADGING_PROTOCOL
typedef EFI_STATUS(EFIAPI * EFI_BADGING_GET_IMAGE )(IN EFI_OEM_BADGING_PROTOCOL *This, IN OUT UINT32 *Instance, OUT EFI_BADGING_FORMAT *Format, OUT UINT8 **ImageData, OUT UINTN *ImageSize, OUT EFI_BADGING_DISPLAY_ATTRIBUTE *Attribute, OUT UINTN *CoordinateX, OUT UINTN *CoordinateY)

Enumerations

enum  EFI_BADGING_FORMAT {
  EfiBadgingFormatBMP, EfiBadgingFormatJPEG, EfiBadgingFormatTIFF, EfiBadgingFormatGIF,
  EfiBadgingFormatUnknown
}
enum  EFI_BADGING_DISPLAY_ATTRIBUTE {
  EfiBadgingDisplayAttributeLeftTop, EfiBadgingDisplayAttributeCenterTop, EfiBadgingDisplayAttributeRightTop, EfiBadgingDisplayAttributeCenterRight,
  EfiBadgingDisplayAttributeRightBottom, EfiBadgingDisplayAttributeCenterBottom, EfiBadgingDisplayAttributeLeftBottom, EfiBadgingDisplayAttributeCenterLeft,
  EfiBadgingDisplayAttributeCenter, EfiBadgingDisplayAttributeCustomized
}

Variables

EFI_GUID gEfiOEMBadgingProtocolGuid

Detailed Description

The OEM Badging Protocol defines the interface to get the OEM badging image with the display attribute. This protocol can be produced based on OEM badging images.

Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php.

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.


Define Documentation

#define EFI_OEM_BADGING_PROTOCOL_GUID   { 0x170e13c0, 0xbf1b, 0x4218, {0x87, 0x1d, 0x2a, 0xbd, 0xc6, 0xf8, 0x87, 0xbc } }


Typedef Documentation

typedef EFI_STATUS(EFIAPI * EFI_BADGING_GET_IMAGE)(IN EFI_OEM_BADGING_PROTOCOL *This, IN OUT UINT32 *Instance, OUT EFI_BADGING_FORMAT *Format, OUT UINT8 **ImageData, OUT UINTN *ImageSize, OUT EFI_BADGING_DISPLAY_ATTRIBUTE *Attribute, OUT UINTN *CoordinateX, OUT UINTN *CoordinateY)

Load an OEM badge image and return its data and attributes.

Parameters:
This The pointer to this protocol instance.
Instance The visible image instance is found.
Format The format of the image. Examples: BMP, JPEG.
ImageData The image data for the badge file. Currently only supports the .bmp file format.
ImageSize The size of the image returned.
Attribute The display attributes of the image returned.
CoordinateX The X coordinate of the image.
CoordinateY The Y coordinate of the image.
Return values:
EFI_SUCCESS The image was fetched successfully.
EFI_NOT_FOUND The specified image could not be found.


Enumeration Type Documentation

Enumerator:
EfiBadgingDisplayAttributeLeftTop 
EfiBadgingDisplayAttributeCenterTop 
EfiBadgingDisplayAttributeRightTop 
EfiBadgingDisplayAttributeCenterRight 
EfiBadgingDisplayAttributeRightBottom 
EfiBadgingDisplayAttributeCenterBottom 
EfiBadgingDisplayAttributeLeftBottom 
EfiBadgingDisplayAttributeCenterLeft 
EfiBadgingDisplayAttributeCenter 
EfiBadgingDisplayAttributeCustomized 

Enumerator:
EfiBadgingFormatBMP 
EfiBadgingFormatJPEG 
EfiBadgingFormatTIFF 
EfiBadgingFormatGIF 
EfiBadgingFormatUnknown 


Variable Documentation


Generated on Wed Sep 2 14:26:58 2015 for IntelFrameworkModulePkg[ALL] by  doxygen 1.5.7.1