0025973: Visualization, TKOpenGl - support EAGLContext as alternative to NSOpenGLContext
[occt.git] / src / OpenGl / OpenGl_Window.hxx
1 // Created on: 2011-09-20
2 // Created by: Sergey ZERCHANINOV
3 // Copyright (c) 2011-2014 OPEN CASCADE SAS
4 //
5 // This file is part of Open CASCADE Technology software library.
6 //
7 // This library is free software; you can redistribute it and/or modify it under
8 // the terms of the GNU Lesser General Public License version 2.1 as published
9 // by the Free Software Foundation, with special exception defined in the file
10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11 // distribution for complete text of the license and disclaimer of any warranty.
12 //
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
15
16 #ifndef _OpenGl_Window_Header
17 #define _OpenGl_Window_Header
18
19 #include <OpenGl_GlCore11.hxx>
20 #include <InterfaceGraphic_Aspect.hxx>
21 #include <OpenGl_Caps.hxx>
22
23 #include <Handle_OpenGl_Context.hxx>
24 #include <Handle_OpenGl_Window.hxx>
25 #include <Handle_OpenGl_GraphicDriver.hxx>
26
27 #include <MMgt_TShared.hxx>
28
29 #if defined(__APPLE__)
30   #import <TargetConditionals.h>
31 #endif
32
33 #if defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE
34   #ifdef __OBJC__
35     @class UIView;
36   #else
37     struct UIView;
38   #endif
39 #endif
40
41 //! This class represents low-level wrapper over window with GL context.
42 //! The window itself should be provided to constructor.
43 class OpenGl_Window : public MMgt_TShared
44 {
45 public:
46
47   //! Main constructor - prepare GL context for specified window.
48   OpenGl_Window (const Handle(OpenGl_GraphicDriver)& theDriver,
49                  const CALL_DEF_WINDOW&        theCWindow,
50                  Aspect_RenderingContext       theGContext,
51                  const Handle(OpenGl_Caps)&    theCaps,
52                  const Handle(OpenGl_Context)& theShareCtx);
53
54   //! Destructor
55   virtual ~OpenGl_Window();
56
57   //! Resizes the window.
58   void Resize (const CALL_DEF_WINDOW& theCWindow);
59
60   //! Reads depth component for current scene into specified buffer.
61   void ReadDepths (const Standard_Integer theX,     const Standard_Integer theY,
62                    const Standard_Integer theWidth, const Standard_Integer theHeight,
63                    float* theDepths);
64
65   void SetBackgroundColor (const Standard_ShortReal theR,
66                            const Standard_ShortReal theG,
67                            const Standard_ShortReal theB);
68
69   Standard_Integer Width()  const { return myWidth; }
70   Standard_Integer Height() const { return myHeight; }
71   const TEL_COLOUR& BackgroundColor() const { return myBgColor; }
72
73   const Handle(OpenGl_Context)& GetGlContext() const { return myGlContext; }
74
75 protected:
76
77   //! Activates GL context and setup viewport.
78   void Init();
79
80   //! Makes GL context for this window active in current thread
81   virtual Standard_Boolean Activate();
82
83   void EnableFeatures() const;
84   void DisableFeatures() const;
85
86   //! Draw directly to the FRONT buffer. Can cause artifacts on the screen.
87   void MakeFrontBufCurrent() const;
88
89   //! Draw to BACK buffer. Normal and default state.
90   void MakeBackBufCurrent() const;
91
92 protected:
93
94   Handle(OpenGl_Context) myGlContext;
95   Standard_Boolean       myOwnGContext; //!< set to TRUE if GL context was not created by this class
96 #if defined(__APPLE__)
97 #if defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE
98   UIView*                myUIView;
99 #endif
100   Standard_Integer       myWidthPt;     //!< window width  in logical units
101   Standard_Integer       myHeightPt;    //!< window height in logical units
102 #endif
103   Standard_Integer       myWidth;       //!< window width  in pixels
104   Standard_Integer       myHeight;      //!< window height in pixels
105   TEL_COLOUR             myBgColor;     //!< background color
106
107 public:
108
109   DEFINE_STANDARD_RTTI(OpenGl_Window) // Type definition
110   DEFINE_STANDARD_ALLOC
111
112 };
113
114 #endif //_OpenGl_Window_Header