EmulatorPkg/Include/Protocol/EmuGraphicsWindow.h

   1 /*++ @file
   2
   3 Copyright (c) 2006, Tristan Gingold. All rights reserved.<BR>
   4 Portitions copyright (c) 2010 - 2011, Apple Inc. All rights reserved.
   5 SPDX-License-Identifier: BSD-2-Clause-Patent
   6
   7 **/
   8
   9 #ifndef _EMU_UGA_IO_H_
  10 #define _EMU_UGA_IO_H_
  11
  12 #include <Protocol/SimplePointer.h>
  13 #include <Protocol/SimpleTextIn.h>
  14 #include <Protocol/SimpleTextInEx.h>
  15 #include <Protocol/UgaDraw.h>
  16
  17 #define EMU_GRAPHICS_WINDOW_PROTOCOL_GUID \
  18  { 0x30FD316A, 0x6728, 0x2E41, { 0xA6, 0x90, 0x0D, 0x13, 0x33, 0xD8, 0xCA, 0xC1 } }
  19
  20 typedef struct _EMU_GRAPHICS_WINDOW_PROTOCOL EMU_GRAPHICS_WINDOW_PROTOCOL;
  21
  22 typedef
  23 EFI_STATUS
  24 (EFIAPI *EMU_GRAPHICS_WINDOWS_CLOSE)(
  25   EMU_GRAPHICS_WINDOW_PROTOCOL *Uga
  26   );
  27
  28 typedef
  29 EFI_STATUS
  30 (EFIAPI *EMU_GRAPHICS_WINDOWS_SIZE)(
  31   EMU_GRAPHICS_WINDOW_PROTOCOL  *Uga,
  32   UINT32                        Width,
  33   UINT32                        Height
  34   );
  35
  36 typedef
  37 EFI_STATUS
  38 (EFIAPI *EMU_GRAPHICS_WINDOWS_CHECK_KEY)(
  39   EMU_GRAPHICS_WINDOW_PROTOCOL *Uga
  40   );
  41
  42 typedef
  43 EFI_STATUS
  44 (EFIAPI *EMU_GRAPHICS_WINDOWS_GET_KEY)(
  45   EMU_GRAPHICS_WINDOW_PROTOCOL  *Uga,
  46   EFI_KEY_DATA                  *key
  47   );
  48
  49 typedef
  50 EFI_STATUS
  51 (EFIAPI *EMU_GRAPHICS_WINDOWS_KEY_SET_STATE)(
  52   IN EMU_GRAPHICS_WINDOW_PROTOCOL   *GraphicsWindows,
  53   IN EFI_KEY_TOGGLE_STATE           *KeyToggleState
  54   );
  55
  56 typedef
  57 VOID
  58 (EFIAPI *EMU_GRAPHICS_WINDOW_REGISTER_KEY_NOTIFY_CALLBACK)(
  59   IN VOID           *Context,
  60   IN EFI_KEY_DATA   *KeyData
  61   );
  62
  63 typedef
  64 EFI_STATUS
  65 (EFIAPI *EMU_GRAPHICS_WINDOWS_REGISTER_KEY_NOTIFY)(
  66   IN EMU_GRAPHICS_WINDOW_PROTOCOL                       *GraphicsWindows,
  67   IN EMU_GRAPHICS_WINDOW_REGISTER_KEY_NOTIFY_CALLBACK   MakeCallBack,
  68   IN EMU_GRAPHICS_WINDOW_REGISTER_KEY_NOTIFY_CALLBACK   BreakCallBack,
  69   IN VOID                                               *Context
  70   );
  71
  72 typedef struct {
  73   UINTN    SourceX;
  74   UINTN    SourceY;
  75   UINTN    DestinationX;
  76   UINTN    DestinationY;
  77   UINTN    Width;
  78   UINTN    Height;
  79   UINTN    Delta;
  80 } EMU_GRAPHICS_WINDOWS__BLT_ARGS;
  81
  82 typedef
  83 EFI_STATUS
  84 (EFIAPI *EMU_GRAPHICS_WINDOWS_BLT)(
  85   IN  EMU_GRAPHICS_WINDOW_PROTOCOL            *GraphicsWindows,
  86   IN  EFI_UGA_PIXEL                           *BltBuffer OPTIONAL,
  87   IN  EFI_UGA_BLT_OPERATION                   BltOperation,
  88   IN  EMU_GRAPHICS_WINDOWS__BLT_ARGS          *Args
  89   );
  90
  91 typedef
  92 BOOLEAN
  93 (EFIAPI *EMU_GRAPHICS_WINDOWS_IS_KEY_PRESSED)(
  94   IN  EMU_GRAPHICS_WINDOW_PROTOCOL  *GraphicsWindows,
  95   IN  EFI_KEY_DATA                  *KeyData
  96   );
  97
  98 typedef
  99 EFI_STATUS
 100 (EFIAPI *EMU_GRAPHICS_WINDOWS_CHECK_POINTER)(
 101   EMU_GRAPHICS_WINDOW_PROTOCOL *GraphicsWindows
 102   );
 103
 104 typedef
 105 EFI_STATUS
 106 (EFIAPI *EMU_GRAPHICS_WINDOWS_GET_POINTER_STATE)(
 107   EMU_GRAPHICS_WINDOW_PROTOCOL  *GraphicsWindows,
 108   EFI_SIMPLE_POINTER_STATE      *state
 109   );
 110
 111 struct _EMU_GRAPHICS_WINDOW_PROTOCOL {
 112   EMU_GRAPHICS_WINDOWS_SIZE                   Size;
 113   EMU_GRAPHICS_WINDOWS_CHECK_KEY              CheckKey;
 114   EMU_GRAPHICS_WINDOWS_KEY_SET_STATE          KeySetState;
 115   EMU_GRAPHICS_WINDOWS_GET_KEY                GetKey;
 116   EMU_GRAPHICS_WINDOWS_REGISTER_KEY_NOTIFY    RegisterKeyNotify;
 117   EMU_GRAPHICS_WINDOWS_BLT                    Blt;
 118   EMU_GRAPHICS_WINDOWS_IS_KEY_PRESSED         IsKeyPressed;
 119   EMU_GRAPHICS_WINDOWS_CHECK_POINTER          CheckPointer;
 120   EMU_GRAPHICS_WINDOWS_GET_POINTER_STATE      GetPointerState;
 121 };
 122
 123 extern EFI_GUID  gEmuGraphicsWindowProtocolGuid;
 124
 125 #endif