projects / mirror_edk2.git / blame
| Commit | Line | Data |
|---|---|---|
| 62d8cb3b RN |
1 | /** @file\r |
| 2 | Library for performing UEFI GOP Blt operations on a framebuffer\r | |
| 3 | \r | |
| 4 | Copyright (c) 2009 - 2016, Intel Corporation. All rights reserved.<BR>\r | |
| 5 | \r | |
| 6 | This program and the accompanying materials are licensed and made available\r | |
| 7 | under the terms and conditions of the BSD License which accompanies this\r | |
| 8 | distribution. The full text of the license may be found at\r | |
| 9 | http://opensource.org/licenses/bsd-license.php\r | |
| 10 | \r | |
| 11 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
| 12 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR\r | |
| 13 | IMPLIED.\r | |
| 14 | \r | |
| 15 | **/\r | |
| 16 | \r | |
| 17 | #ifndef __FRAMEBUFFER_BLT_LIB__\r | |
| 18 | #define __FRAMEBUFFER_BLT_LIB__\r | |
| 19 | \r | |
| 20 | #include <Protocol/GraphicsOutput.h>\r | |
| 21 | \r | |
| 22 | //\r | |
| 23 | // Opaque structure for the frame buffer configure.\r | |
| 24 | //\r | |
| 25 | typedef struct FRAME_BUFFER_CONFIGURE FRAME_BUFFER_CONFIGURE;\r | |
| 26 | \r | |
| 27 | /**\r | |
| 28 | Create the configuration for a video frame buffer.\r | |
| 29 | \r | |
| 30 | The configuration is returned in the caller provided buffer.\r | |
| 31 | \r | |
| 32 | @param[in] FrameBuffer Pointer to the start of the frame buffer.\r | |
| 33 | @param[in] FrameBufferInfo Describes the frame buffer characteristics.\r | |
| 34 | @param[in,out] Configure The created configuration information.\r | |
| 35 | @param[in,out] ConfigureSize Size of the configuration information.\r | |
| 36 | \r | |
| 37 | @retval RETURN_SUCCESS The configuration was successful created.\r | |
| 38 | @retval RETURN_BUFFER_TOO_SMALL The Configure is to too small. The required\r | |
| 39 | size is returned in ConfigureSize.\r | |
| 40 | @retval RETURN_UNSUPPORTED The requested mode is not supported by\r | |
| 41 | this implementaion.\r | |
| 42 | **/\r | |
| 43 | RETURN_STATUS\r | |
| 44 | EFIAPI\r | |
| 45 | FrameBufferBltConfigure (\r | |
| 46 | IN VOID *FrameBuffer,\r | |
| 47 | IN EFI_GRAPHICS_OUTPUT_MODE_INFORMATION *FrameBufferInfo,\r | |
| 48 | IN OUT FRAME_BUFFER_CONFIGURE *Configure,\r | |
| 49 | IN OUT UINTN *ConfigureSize\r | |
| 50 | );\r | |
| 51 | \r | |
| 52 | /**\r | |
| 53 | Performs a UEFI Graphics Output Protocol Blt operation.\r | |
| 54 | \r | |
| 55 | @param[in] Configure Pointer to a configuration which was successfully\r | |
| 56 | created by FrameBufferBltConfigure ().\r | |
| 57 | @param[in,out] BltBuffer The data to transfer to screen.\r | |
| 58 | @param[in] BltOperation The operation to perform.\r | |
| 59 | @param[in] SourceX The X coordinate of the source for BltOperation.\r | |
| 60 | @param[in] SourceY The Y coordinate of the source for BltOperation.\r | |
| 61 | @param[in] DestinationX The X coordinate of the destination for\r | |
| 62 | BltOperation.\r | |
| 63 | @param[in] DestinationY The Y coordinate of the destination for\r | |
| 64 | BltOperation.\r | |
| 65 | @param[in] Width The width of a rectangle in the blt rectangle\r | |
| 66 | in pixels.\r | |
| 67 | @param[in] Height The height of a rectangle in the blt rectangle\r | |
| 68 | in pixels.\r | |
| 69 | @param[in] Delta Not used for EfiBltVideoFill and\r | |
| 70 | EfiBltVideoToVideo operation. If a Delta of 0\r | |
| 71 | is used, the entire BltBuffer will be operated\r | |
| 72 | on. If a subrectangle of the BltBuffer is\r | |
| 73 | used, then Delta represents the number of\r | |
| 74 | bytes in a row of the BltBuffer.\r | |
| 75 | \r | |
| 76 | @retval RETURN_INVALID_PARAMETER Invalid parameter were passed in.\r | |
| 77 | @retval RETURN_SUCCESS The Blt operation was performed successfully.\r | |
| 78 | **/\r | |
| 79 | RETURN_STATUS\r | |
| 80 | EFIAPI\r | |
| 81 | FrameBufferBlt (\r | |
| 82 | IN FRAME_BUFFER_CONFIGURE *Configure,\r | |
| 83 | IN OUT EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer, OPTIONAL\r | |
| 84 | IN EFI_GRAPHICS_OUTPUT_BLT_OPERATION BltOperation,\r | |
| 85 | IN UINTN SourceX,\r | |
| 86 | IN UINTN SourceY,\r | |
| 87 | IN UINTN DestinationX,\r | |
| 88 | IN UINTN DestinationY,\r | |
| 89 | IN UINTN Width,\r | |
| 90 | IN UINTN Height,\r | |
| 91 | IN UINTN Delta\r | |
| 92 | );\r | |
| 93 | \r | |
| 94 | #endif\r |