0023226: Extend OpenGl_Context to store map of shared GPU resources
[occt.git] / src / OpenGl / OpenGl_GraphicDriver.cxx
1 // Created on: 2011-10-20
2 // Created by: Sergey ZERCHANINOV
3 // Copyright (c) 2011-2012 OPEN CASCADE SAS
4 //
5 // The content of this file is subject to the Open CASCADE Technology Public
6 // License Version 6.5 (the "License"). You may not use the content of this file
7 // except in compliance with the License. Please obtain a copy of the License
8 // at http://www.opencascade.org and read it completely before using this file.
9 //
10 // The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
11 // main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
12 //
13 // The Original Code and all software distributed under the License is
14 // distributed on an "AS IS" basis, without warranty of any kind, and the
15 // Initial Developer hereby disclaims all such warranties, including without
16 // limitation, any warranties of merchantability, fitness for a particular
17 // purpose or non-infringement. Please see the License for the specific terms
18 // and conditions governing the rights and limitations under the License.
19
20
21 #include <OpenGl_GraphicDriver.hxx>
22
23 #include <OpenGl_Context.hxx>
24 #include <OpenGl_View.hxx>
25 #include <OpenGl_Workspace.hxx>
26
27 IMPLEMENT_STANDARD_HANDLE(OpenGl_GraphicDriver,Graphic3d_GraphicDriver)
28 IMPLEMENT_STANDARD_RTTIEXT(OpenGl_GraphicDriver,Graphic3d_GraphicDriver)
29
30 namespace
31 {
32   // Global switch - shared by whole TKOpenGl module. To be removed.
33   static Standard_Boolean TheToUseVbo = Standard_True;
34
35   static const Handle(OpenGl_Context) TheNullGlCtx;
36 };
37
38 // Pour eviter de "mangler" MetaGraphicDriverFactory, le nom de la
39 // fonction qui cree un Graphic3d_GraphicDriver.
40 // En effet, ce nom est recherche par la methode DlSymb de la
41 // classe OSD_SharedLibrary dans la methode SetGraphicDriver de la
42 // classe Graphic3d_GraphicDevice
43 extern "C" {
44 #if defined(_MSC_VER) // disable MS VC++ warning on C-style function returning C++ object
45   #pragma warning(push)
46   #pragma warning(disable:4190)
47 #endif
48   Standard_EXPORT Handle(Graphic3d_GraphicDriver) MetaGraphicDriverFactory (const Standard_CString theShrName)
49   {
50     Handle(OpenGl_GraphicDriver) aDriver = new OpenGl_GraphicDriver (theShrName);
51     return aDriver;
52   }
53 #if defined(_MSC_VER)
54   #pragma warning(pop)
55 #endif
56 }
57
58 // =======================================================================
59 // function : OpenGl_GraphicDriver
60 // purpose  :
61 // =======================================================================
62 OpenGl_GraphicDriver::OpenGl_GraphicDriver (const Standard_CString theShrName)
63 : Graphic3d_GraphicDriver (theShrName),
64   myMapOfView      (1, NCollection_BaseAllocator::CommonBaseAllocator()),
65   myMapOfWS        (1, NCollection_BaseAllocator::CommonBaseAllocator()),
66   myMapOfStructure (1, NCollection_BaseAllocator::CommonBaseAllocator()),
67   myUserDrawCallback (NULL)
68 {
69   //
70 }
71
72 // =======================================================================
73 // function : UserDrawCallback
74 // purpose  :
75 // =======================================================================
76 OpenGl_GraphicDriver::OpenGl_UserDrawCallback_t& OpenGl_GraphicDriver::UserDrawCallback()
77 {
78   return myUserDrawCallback;
79 }
80
81 // =======================================================================
82 // function : DefaultTextHeight
83 // purpose  :
84 // =======================================================================
85 Standard_ShortReal OpenGl_GraphicDriver::DefaultTextHeight() const
86 {
87   return 16.;
88 }
89
90 // =======================================================================
91 // function : InvalidateAllWorkspaces
92 // purpose  : ex-TsmInitUpdateState, deprecated, need to decide what to do with EraseAnimation() call
93 // =======================================================================
94 void OpenGl_GraphicDriver::InvalidateAllWorkspaces()
95 {
96   for (NCollection_DataMap<Standard_Integer, Handle(OpenGl_Workspace)>::Iterator anIt (myMapOfWS);
97        anIt.More(); anIt.Next())
98   {
99     anIt.ChangeValue()->EraseAnimation();
100   }
101 }
102
103 // =======================================================================
104 // function : ToUseVBO
105 // purpose  :
106 // =======================================================================
107 Standard_Boolean OpenGl_GraphicDriver::ToUseVBO()
108 {
109   return TheToUseVbo;
110 }
111
112 // =======================================================================
113 // function : EnableVBO
114 // purpose  :
115 // =======================================================================
116 void OpenGl_GraphicDriver::EnableVBO (const Standard_Boolean theToTurnOn)
117 {
118   TheToUseVbo = theToTurnOn;
119 }
120
121 // =======================================================================
122 // function : GetSharedContext
123 // purpose  :
124 // =======================================================================
125 const Handle(OpenGl_Context)& OpenGl_GraphicDriver::GetSharedContext() const
126 {
127   if (myMapOfWS.IsEmpty())
128   {
129     return TheNullGlCtx;
130   }
131
132   NCollection_DataMap<Standard_Integer, Handle(OpenGl_Workspace)>::Iterator anIter (myMapOfWS);
133   return anIter.Value()->GetGlContext();
134 }
135
136 // =======================================================================
137 // function : MemoryInfo
138 // purpose  :
139 // =======================================================================
140 Standard_Boolean OpenGl_GraphicDriver::MemoryInfo (Standard_Size&           theFreeBytes,
141                                                    TCollection_AsciiString& theInfo) const
142 {
143   // this is extra work (for OpenGl_Context initialization)...
144   OpenGl_Context aGlCtx;
145   if (!aGlCtx.Init())
146   {
147     return Standard_False;
148   }
149   theFreeBytes = aGlCtx.AvailableMemory();
150   theInfo      = aGlCtx.MemoryInfo();
151   return !theInfo.IsEmpty();
152 }