]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/GraphicsOutput.h
MdePkg: Clean up source files
[mirror_edk2.git] / MdePkg / Include / Protocol / GraphicsOutput.h
index 741007c15b2436d77f4bdad165d00d3210d1e1d2..7375d79638f35bc53669427c9141344a170f8c67 100644 (file)
@@ -3,14 +3,14 @@
 \r
   Abstraction of a very simple graphics device.\r
 \r
-  Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.<BR>\r
-  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 - 2018, Intel Corporation. All rights reserved.<BR>\r
+  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
@@ -33,18 +33,18 @@ typedef struct {
 \r
 typedef enum {\r
   ///\r
-  /// A pixel is 32-bits and byte zero represents red, byte one represents green, \r
-  /// byte two represents blue, and byte three is reserved. This is the definition \r
-  /// for the physical frame buffer. The byte values for the red, green, and blue \r
-  /// components represent the color intensity. This color intensity value range \r
+  /// A pixel is 32-bits and byte zero represents red, byte one represents green,\r
+  /// byte two represents blue, and byte three is reserved. This is the definition\r
+  /// for the physical frame buffer. The byte values for the red, green, and blue\r
+  /// components represent the color intensity. This color intensity value range\r
   /// from a minimum intensity of 0 to maximum intensity of 255.\r
   ///\r
   PixelRedGreenBlueReserved8BitPerColor,\r
   ///\r
-  /// A pixel is 32-bits and byte zero represents blue, byte one represents green, \r
-  /// byte two represents red, and byte three is reserved. This is the definition \r
-  /// for the physical frame buffer. The byte values for the red, green, and blue \r
-  /// components represent the color intensity. This color intensity value range \r
+  /// A pixel is 32-bits and byte zero represents blue, byte one represents green,\r
+  /// byte two represents red, and byte three is reserved. This is the definition\r
+  /// for the physical frame buffer. The byte values for the red, green, and blue\r
+  /// components represent the color intensity. This color intensity value range\r
   /// from a minimum intensity of 0 to maximum intensity of 255.\r
   ///\r
   PixelBlueGreenRedReserved8BitPerColor,\r
@@ -64,7 +64,7 @@ typedef enum {
 \r
 typedef struct {\r
   ///\r
-  /// The version of this data structure. A value of zero represents the \r
+  /// The version of this data structure. A value of zero represents the\r
   /// EFI_GRAPHICS_OUTPUT_MODE_INFORMATION structure as defined in this specification.\r
   ///\r
   UINT32                     Version;\r
@@ -77,18 +77,18 @@ typedef struct {
   ///\r
   UINT32                     VerticalResolution;\r
   ///\r
-  /// Enumeration that defines the physical format of the pixel. A value of PixelBltOnly \r
+  /// Enumeration that defines the physical format of the pixel. A value of PixelBltOnly\r
   /// implies that a linear frame buffer is not available for this mode.\r
   ///\r
   EFI_GRAPHICS_PIXEL_FORMAT  PixelFormat;\r
   ///\r
-  /// This bit-mask is only valid if PixelFormat is set to PixelPixelBitMask. \r
+  /// This bit-mask is only valid if PixelFormat is set to PixelPixelBitMask.\r
   /// A bit being set defines what bits are used for what purpose such as Red, Green, Blue, or Reserved.\r
   ///\r
   EFI_PIXEL_BITMASK          PixelInformation;\r
   ///\r
   /// Defines the number of pixel elements per video memory line.\r
-  /// \r
+  ///\r
   UINT32                     PixelsPerScanLine;\r
 } EFI_GRAPHICS_OUTPUT_MODE_INFORMATION;\r
 \r
@@ -116,7 +116,7 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  Set the video device into the specified mode and clears the visible portions of \r
+  Set the video device into the specified mode and clears the visible portions of\r
   the output display to black.\r
 \r
   @param  This              The EFI_GRAPHICS_OUTPUT_PROTOCOL instance.\r
@@ -151,47 +151,47 @@ typedef union {
 ///\r
 typedef enum {\r
   ///\r
-  /// Write data from the BltBuffer pixel (0, 0) \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
+  /// Write data from the BltBuffer pixel (0, 0)\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
   EfiBltVideoFill,\r
-  \r
+\r
   ///\r
-  /// 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
+  /// 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
   EfiBltVideoToBltBuffer,\r
-  \r
+\r
   ///\r
-  /// 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
+  /// 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
-  EfiBltBufferToVideo, \r
-  \r
+  EfiBltBufferToVideo,\r
+\r
   ///\r
   /// 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
   EfiBltVideoToVideo,\r
-  \r
+\r
   EfiGraphicsOutputBltOperationMax\r
 } EFI_GRAPHICS_OUTPUT_BLT_OPERATION;\r
 \r
 /**\r
   Blt a rectangle of pixels on the graphics screen. Blt stands for BLock Transfer.\r
-  \r
+\r
   @param  This         Protocol instance pointer.\r
   @param  BltBuffer    The data to transfer to the graphics screen.\r
                        Size is at least Width*Height*sizeof(EFI_GRAPHICS_OUTPUT_BLT_PIXEL).\r
@@ -250,15 +250,15 @@ typedef struct {
   ///\r
   EFI_PHYSICAL_ADDRESS                   FrameBufferBase;\r
   ///\r
-  /// Amount of frame buffer needed to support the active mode as defined by \r
+  /// Amount of frame buffer needed to support the active mode as defined by\r
   /// PixelsPerScanLine xVerticalResolution x PixelElementSize.\r
   ///\r
   UINTN                                  FrameBufferSize;\r
 } EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE;\r
 \r
 ///\r
-/// Provides a basic abstraction to set video modes and copy pixels to and from \r
-/// the graphics controller's frame buffer. The linear address of the hardware \r
+/// Provides a basic abstraction to set video modes and copy pixels to and from\r
+/// the graphics controller's frame buffer. The linear address of the hardware\r
 /// frame buffer is also exposed so software can write directly to the video hardware.\r
 ///\r
 struct _EFI_GRAPHICS_OUTPUT_PROTOCOL {\r