chromecast/public/cast_egl_platform.h

   1 // Copyright 2015 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CHROMECAST_PUBLIC_CAST_EGL_PLATFORM_H_
   6 #define CHROMECAST_PUBLIC_CAST_EGL_PLATFORM_H_
   7
   8 namespace chromecast {
   9
  10 struct Size;
  11
  12 // Interface representing all the hardware-specific elements of an Ozone
  13 // implementation for Cast.  Supply an implementation of this interface
  14 // to OzonePlatformCast to create a complete Ozone implementation.
  15 class CastEglPlatform {
  16  public:
  17   typedef void* (*GLGetProcAddressProc)(const char* name);
  18   typedef void* NativeDisplayType;
  19   typedef void* NativeWindowType;
  20
  21   virtual ~CastEglPlatform() {}
  22
  23   // Returns an array of EGL properties, which can be used in any EGL function
  24   // used to select a display configuration. Note that all properties should be
  25   // immediately followed by the corresponding desired value and array should be
  26   // terminated with EGL_NONE. Ownership of the array is not transferred to
  27   // caller. desired_list contains list of desired EGL properties and values.
  28   virtual const int* GetEGLSurfaceProperties(const int* desired_list) = 0;
  29
  30   // Initialize/ShutdownHardware are called at most once each over the object's
  31   // lifetime.  Initialize will be called before creating display type or
  32   // window.  If Initialize fails, return false (Shutdown will still be called).
  33   virtual bool InitializeHardware() = 0;
  34   virtual void ShutdownHardware() = 0;
  35
  36   // These three are called once after hardware is successfully initialized.
  37   // The implementation must load the libraries containing EGL and GLES2
  38   // bindings (return the pointer obtained from dlopen).  It must also supply
  39   // a function pointer to eglGetProcAddress or equivalent.
  40   virtual void* GetEglLibrary() = 0;
  41   virtual void* GetGles2Library() = 0;
  42   virtual GLGetProcAddressProc GetGLProcAddressProc() = 0;
  43
  44   // Creates/destroys an EGLNativeDisplayType.  These may be called multiple
  45   // times over the object's lifetime, for example to release the display when
  46   // switching to an external application.  There will be at most one display
  47   // type at a time.
  48   virtual NativeDisplayType CreateDisplayType(const Size& size) = 0;
  49   virtual void DestroyDisplayType(NativeDisplayType display_type) = 0;
  50
  51   // Creates/destroys an EGLNativeWindow.  There will be at most one window at a
  52   // time, created within a valid display type.
  53   virtual NativeWindowType CreateWindow(NativeDisplayType display_type,
  54                                         const Size& size) = 0;
  55   virtual void DestroyWindow(NativeWindowType window) = 0;
  56
  57   // Specifies if creating multiple surfaces on a window is broken on this
  58   // platform and a new window is required. This should return false on most
  59   // implementations.
  60   virtual bool MultipleSurfaceUnsupported() = 0;
  61 };
  62
  63 }  // namespace chromecast
  64
  65 #endif  // CHROMECAST_PUBLIC_CAST_EGL_PLATFORM_H_