]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/GraphicsOutput.h
Update the copyright notice format
[mirror_edk2.git] / MdePkg / Include / Protocol / GraphicsOutput.h
index 7782f5d7c3ec2b751b7293b54ca94ed965b65108..55cafb1b02b285b2f5a8c8c4d89bc72f5a1b4c43 100644 (file)
@@ -3,8 +3,8 @@
 \r
   Abstraction of a very simple graphics device.\r
 \r
-  Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
-  All rights reserved. This program and the accompanying materials                          \r
+  Copyright (c) 2006 - 2008, 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
@@ -93,12 +93,13 @@ typedef struct {
 } EFI_GRAPHICS_OUTPUT_MODE_INFORMATION;\r
 \r
 /**\r
-  Return the current video mode information.\r
+  Returns information for an available graphics mode that the graphics device\r
+  and the set of active video output devices supports.\r
 \r
-  @param  This       Protocol instance pointer.\r
-  @param  ModeNumber The mode number to return information on.\r
-  @param  SizeOfInfo A pointer to the size, in bytes, of the Info buffer.\r
-  @param  Info       A pointer to callee allocated buffer that returns information about ModeNumber.\r
+  @param  This                  The EFI_GRAPHICS_OUTPUT_PROTOCOL instance.\r
+  @param  ModeNumber            The mode number to return information on.\r
+  @param  SizeOfInfo            A pointer to the size, in bytes, of the Info buffer.\r
+  @param  Info                  A pointer to callee allocated buffer that returns information about ModeNumber.\r
 \r
   @retval EFI_SUCCESS           Mode information returned.\r
   @retval EFI_BUFFER_TOO_SMALL  The Info buffer was too small.\r
@@ -117,12 +118,13 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  Return the current video mode information.\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              Protocol instance pointer.\r
-  @param  ModeNumber        The mode number to be set.\r
+  @param  This              The EFI_GRAPHICS_OUTPUT_PROTOCOL instance.\r
+  @param  ModeNumber        Abstraction that defines the current video mode.\r
 \r
-  @retval EFI_SUCCESS       Graphics mode was changed.\r
+  @retval EFI_SUCCESS       The graphics mode specified by ModeNumber was selected.\r
   @retval EFI_DEVICE_ERROR  The device had an error and could not complete the request.\r
   @retval EFI_UNSUPPORTED   ModeNumber is not supported by this device.\r
 \r