1. Fixed one bug in ConPlatform.c, add NULL judgment.
[people/mcb30/edk2.git] / edk2 / MdePkg / Include / Protocol / UgaDraw.h
index b450cdc..3532f8e 100644 (file)
@@ -3,14 +3,14 @@
 \r
   Abstraction of a very simple graphics device.\r
 \r
-  Copyright (c) 2006, Intel Corporation                                                         \r
-  All rights reserved. This program and the accompanying materials                          \r
-  are licensed and made available under the terms and conditions of the BSD License         \r
-  which accompanies this distribution.  The full text of the license may be found at        \r
-  http://opensource.org/licenses/bsd-license.php                                            \r
+  Copyright (c) 2006, Intel Corporation\r
+  All rights reserved. This program and the accompanying materials\r
+  are licensed and made available under the terms and conditions of the BSD License\r
+  which accompanies this distribution.  The full text of the license may be found at\r
+  http://opensource.org/licenses/bsd-license.php\r
 \r
-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
-  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
+  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
 **/\r
 \r
@@ -50,7 +50,7 @@ EFI_STATUS
 ;\r
 \r
 /**\r
-  Return the current video mode information.\r
+  Set the current video mode information.\r
 \r
   @param  This                 Protocol instance pointer.\r
   @param  HorizontalResolution Current video horizontal resolution in pixels\r
@@ -98,33 +98,33 @@ typedef enum {
 \r
     The following table defines actions for BltOperations:\r
 \r
-    <B>EfiUgaVideoFill</B> - Write data from the  BltBuffer pixel (SourceX, SourceY) \r
-      directly to every pixel of the video display rectangle \r
-      (DestinationX, DestinationY) (DestinationX + Width, DestinationY + Height). \r
+    <B>EfiUgaVideoFill</B> - Write data from the  BltBuffer pixel (SourceX, SourceY)\r
+      directly to every pixel of the video display rectangle\r
+      (DestinationX, DestinationY) (DestinationX + Width, DestinationY + Height).\r
       Only one pixel will be used from the BltBuffer. Delta is NOT used.\r
 \r
-    <B>EfiUgaVideoToBltBuffer</B> - Read data from the video display rectangle \r
-      (SourceX, SourceY) (SourceX + Width, SourceY + Height) and place it in \r
-      the BltBuffer rectangle (DestinationX, DestinationY ) \r
-      (DestinationX + Width, DestinationY + Height). If DestinationX or \r
-      DestinationY is not zero then Delta must be set to the length in bytes \r
+    <B>EfiUgaVideoToBltBuffer</B> - Read data from the video display rectangle\r
+      (SourceX, SourceY) (SourceX + Width, SourceY + Height) and place it in\r
+      the BltBuffer rectangle (DestinationX, DestinationY )\r
+      (DestinationX + Width, DestinationY + Height). If DestinationX or\r
+      DestinationY is not zero then Delta must be set to the length in bytes\r
       of a row in the BltBuffer.\r
 \r
-    <B>EfiUgaBltBufferToVideo</B> - Write data from the  BltBuffer rectangle \r
-      (SourceX, SourceY) (SourceX + Width, SourceY + Height) directly to the \r
-      video display rectangle (DestinationX, DestinationY) \r
-      (DestinationX + Width, DestinationY + Height). If SourceX or SourceY is \r
-      not zero then Delta must be set to the length in bytes of a row in the \r
+    <B>EfiUgaBltBufferToVideo</B> - Write data from the  BltBuffer rectangle\r
+      (SourceX, SourceY) (SourceX + Width, SourceY + Height) directly to the\r
+      video display rectangle (DestinationX, DestinationY)\r
+      (DestinationX + Width, DestinationY + Height). If SourceX or SourceY is\r
+      not zero then Delta must be set to the length in bytes of a row in the\r
       BltBuffer.\r
 \r
     <B>EfiUgaVideoToVideo</B> - Copy from the video display rectangle (SourceX, SourceY)\r
-     (SourceX + Width, SourceY + Height) .to the video display rectangle \r
-     (DestinationX, DestinationY) (DestinationX + Width, DestinationY + Height). \r
+     (SourceX + Width, SourceY + Height) .to the video display rectangle\r
+     (DestinationX, DestinationY) (DestinationX + Width, DestinationY + Height).\r
      The BltBuffer and Delta  are not used in this mode.\r
 \r
 \r
     @param[in] This          - Protocol instance pointer.\r
-    @param[in] BltBuffer     - Buffer containing data to blit into video buffer. This \r
+    @param[in] BltBuffer     - Buffer containing data to blit into video buffer. This\r
                                buffer has a size of Width*Height*sizeof(EFI_UGA_PIXEL)\r
     @param[in] BltOperation  - Operation to perform on BlitBuffer and video memory\r
     @param[in] SourceX       - X coordinate of source for the BltBuffer.\r
@@ -134,7 +134,7 @@ typedef enum {
     @param[in] Width         - Width of rectangle in BltBuffer in pixels.\r
     @param[in] Height        - Hight of rectangle in BltBuffer in pixels.\r
     @param[in] Delta         - OPTIONAL\r
-  \r
+\r
     @retval EFI_SUCCESS           - The Blt operation completed.\r
     @retval EFI_INVALID_PARAMETER - BltOperation is not valid.\r
     @retval EFI_DEVICE_ERROR      - A hardware error occured writting to the video buffer.\r