1 // Created on: 2011-10-20
2 // Created by: Sergey ZERCHANINOV
3 // Copyright (c) 2011-2014 OPEN CASCADE SAS
5 // This file is part of Open CASCADE Technology software library.
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.
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
16 #include <OpenGl_GraphicDriver.hxx>
18 #include <OpenGl_FrameBuffer.hxx>
20 #include <OpenGl_Structure.hxx>
21 #include <OpenGl_CView.hxx>
22 #include <OpenGl_Text.hxx>
24 /*----------------------------------------------------------------------*/
26 void OpenGl_GraphicDriver::ActivateView (const Graphic3d_CView& ACView)
28 const OpenGl_CView *aCView = (const OpenGl_CView *)ACView.ptrView;
30 aCView->WS->SetActiveView(aCView->View);
33 void OpenGl_GraphicDriver::AntiAliasing (const Graphic3d_CView& ACView, const Standard_Boolean AFlag)
35 const OpenGl_CView *aCView = (const OpenGl_CView *)ACView.ptrView;
37 aCView->View->SetAntiAliasing(AFlag);
40 void OpenGl_GraphicDriver::Background (const Graphic3d_CView& ACView)
42 const OpenGl_CView *aCView = (const OpenGl_CView *)ACView.ptrView;
45 aCView->WS->SetBackgroundColor(ACView.DefWindow.Background.r,ACView.DefWindow.Background.g,ACView.DefWindow.Background.b);
49 void OpenGl_GraphicDriver::GradientBackground (const Graphic3d_CView& ACView,
50 const Quantity_Color& AColor1,
51 const Quantity_Color& AColor2,
52 const Aspect_GradientFillMethod AType)
54 const OpenGl_CView *aCView = (const OpenGl_CView *)ACView.ptrView;
57 aCView->View->SetBackgroundGradient(AColor1,AColor2,AType);
61 void OpenGl_GraphicDriver::ClipLimit (const Graphic3d_CView& ACView, const Standard_Boolean AWait)
63 const OpenGl_CView *aCView = (const OpenGl_CView *)ACView.ptrView;
66 aCView->View->SetClipLimit(ACView);
69 aCView->WS->Resize(ACView.DefWindow);
74 void OpenGl_GraphicDriver::DeactivateView (const Graphic3d_CView& ACView)
76 const OpenGl_CView *aCView = (const OpenGl_CView *)ACView.ptrView;
79 const Handle(OpenGl_View) aDummyView;
80 aCView->WS->SetActiveView(aDummyView);
84 void OpenGl_GraphicDriver::DepthCueing (const Graphic3d_CView& ACView, const Standard_Boolean AFlag)
86 const OpenGl_CView *aCView = (const OpenGl_CView *)ACView.ptrView;
88 aCView->View->SetFog(ACView, AFlag);
91 void OpenGl_GraphicDriver::RatioWindow (const Graphic3d_CView& theCView)
93 const OpenGl_CView* aCView = (const OpenGl_CView* )theCView.ptrView;
95 aCView->WS->Resize (theCView.DefWindow);
98 void OpenGl_GraphicDriver::Redraw (const Graphic3d_CView& ACView,
99 const Aspect_CLayer2d& ACUnderLayer,
100 const Aspect_CLayer2d& ACOverLayer,
101 const Standard_Integer /*x*/,
102 const Standard_Integer /*y*/,
103 const Standard_Integer /*width*/,
104 const Standard_Integer /*height*/)
106 if (ACView.RenderParams.Method == Graphic3d_RM_RAYTRACING
107 && !myCaps->vboDisable
108 && !myCaps->keepArrayData)
110 if (ACView.WasRedrawnGL)
112 myDeviceLostFlag = Standard_True;
115 myCaps->keepArrayData = Standard_True;
118 const OpenGl_CView *aCView = (const OpenGl_CView *)ACView.ptrView;
121 /*if( width <= 0 || height <= 0 )
122 aCView->WS->Redraw(ACView, ACUnderLayer, ACOverLayer);
124 aCView->WS->RedrawArea(ACView, ACUnderLayer, ACOverLayer, x, y, width, height);*/
125 // Always do full redraw
126 aCView->WS->Redraw(ACView, ACUnderLayer, ACOverLayer);
130 void OpenGl_GraphicDriver::RedrawImmediate (const Graphic3d_CView& theCView,
131 const Aspect_CLayer2d& theCUnderLayer,
132 const Aspect_CLayer2d& theCOverLayer)
134 const OpenGl_CView* aCView = (const OpenGl_CView* )theCView.ptrView;
137 aCView->WS->RedrawImmediate (theCView, theCUnderLayer, theCOverLayer);
141 void OpenGl_GraphicDriver::Invalidate (const Graphic3d_CView& theCView)
143 const OpenGl_CView* aCView = (const OpenGl_CView* )theCView.ptrView;
146 aCView->WS->Invalidate (theCView);
150 Graphic3d_PtrFrameBuffer OpenGl_GraphicDriver::FBOCreate (const Graphic3d_CView& ACView, const Standard_Integer theWidth, const Standard_Integer theHeight)
152 const OpenGl_CView *aCView = (const OpenGl_CView *)ACView.ptrView;
154 return aCView->WS->FBOCreate(theWidth, theHeight);
155 return (Graphic3d_PtrFrameBuffer)NULL;
158 Graphic3d_PtrFrameBuffer OpenGl_Workspace::FBOCreate (const Standard_Integer theWidth,
159 const Standard_Integer theHeight)
161 // activate OpenGL context
166 const Handle(OpenGl_Context)& aCtx = GetGlContext();
167 OpenGl_FrameBuffer* aFrameBuffer = new OpenGl_FrameBuffer();
168 if (!aFrameBuffer->Init (aCtx, theWidth, theHeight))
170 aFrameBuffer->Release (aCtx.operator->());
174 return (Graphic3d_PtrFrameBuffer )aFrameBuffer;
177 void OpenGl_GraphicDriver::FBORelease (const Graphic3d_CView& ACView, Graphic3d_PtrFrameBuffer& theFBOPtr)
179 if (theFBOPtr == NULL)
181 const OpenGl_CView *aCView = (const OpenGl_CView *)ACView.ptrView;
184 aCView->WS->FBORelease(theFBOPtr);
189 void OpenGl_Workspace::FBORelease (Graphic3d_PtrFrameBuffer theFBOPtr)
191 // activate OpenGL context
193 || theFBOPtr == NULL)
198 // release the object
199 OpenGl_FrameBuffer* aFrameBuffer = (OpenGl_FrameBuffer*)theFBOPtr;
200 if (aFrameBuffer != NULL)
202 aFrameBuffer->Release (GetGlContext().operator->());
207 void OpenGl_GraphicDriver::FBOGetDimensions (const Graphic3d_CView& ,
208 const Graphic3d_PtrFrameBuffer theFBOPtr,
209 Standard_Integer& theWidth, Standard_Integer& theHeight,
210 Standard_Integer& theWidthMax, Standard_Integer& theHeightMax)
212 if (theFBOPtr == NULL)
216 const OpenGl_FrameBuffer* aFrameBuffer = (const OpenGl_FrameBuffer* )theFBOPtr;
217 theWidth = aFrameBuffer->GetVPSizeX(); // current viewport size
218 theHeight = aFrameBuffer->GetVPSizeY();
219 theWidthMax = aFrameBuffer->GetSizeX(); // texture size
220 theHeightMax = aFrameBuffer->GetSizeY();
223 void OpenGl_GraphicDriver::FBOChangeViewport (const Graphic3d_CView& ,
224 Graphic3d_PtrFrameBuffer& theFBOPtr,
225 const Standard_Integer theWidth, const Standard_Integer theHeight)
227 if (theFBOPtr == NULL)
231 OpenGl_FrameBuffer* aFrameBuffer = (OpenGl_FrameBuffer* )theFBOPtr;
232 aFrameBuffer->ChangeViewport (theWidth, theHeight);
235 inline bool getDataFormat (const Image_PixMap& theData,
236 GLenum& thePixelFormat,
239 thePixelFormat = GL_RGB;
240 theDataType = GL_UNSIGNED_BYTE;
241 switch (theData.Format())
243 case Image_PixMap::ImgGray:
244 thePixelFormat = GL_DEPTH_COMPONENT;
245 theDataType = GL_UNSIGNED_BYTE;
247 case Image_PixMap::ImgRGB:
248 thePixelFormat = GL_RGB;
249 theDataType = GL_UNSIGNED_BYTE;
251 case Image_PixMap::ImgBGR:
252 thePixelFormat = GL_BGR;
253 theDataType = GL_UNSIGNED_BYTE;
255 case Image_PixMap::ImgRGBA:
256 case Image_PixMap::ImgRGB32:
257 thePixelFormat = GL_RGBA;
258 theDataType = GL_UNSIGNED_BYTE;
260 case Image_PixMap::ImgBGRA:
261 case Image_PixMap::ImgBGR32:
262 thePixelFormat = GL_BGRA;
263 theDataType = GL_UNSIGNED_BYTE;
265 case Image_PixMap::ImgGrayF:
266 thePixelFormat = GL_DEPTH_COMPONENT;
267 theDataType = GL_FLOAT;
269 case Image_PixMap::ImgRGBF:
270 thePixelFormat = GL_RGB;
271 theDataType = GL_FLOAT;
273 case Image_PixMap::ImgBGRF:
274 thePixelFormat = GL_BGR;
275 theDataType = GL_FLOAT;
277 case Image_PixMap::ImgRGBAF:
278 thePixelFormat = GL_RGBA;
279 theDataType = GL_FLOAT;
281 case Image_PixMap::ImgBGRAF:
282 thePixelFormat = GL_BGRA;
283 theDataType = GL_FLOAT;
290 Standard_Boolean OpenGl_GraphicDriver::BufferDump (const Graphic3d_CView& theCView,
291 Image_PixMap& theImage,
292 const Graphic3d_BufferType& theBufferType)
294 const OpenGl_CView* aCView = (const OpenGl_CView* )theCView.ptrView;
295 return (aCView != NULL) && aCView->WS->BufferDump ((OpenGl_FrameBuffer* )theCView.ptrFBO, theImage, theBufferType);
298 Standard_Boolean OpenGl_Workspace::BufferDump (OpenGl_FrameBuffer* theFBOPtr,
299 Image_PixMap& theImage,
300 const Graphic3d_BufferType& theBufferType)
302 GLenum aFormat, aType;
303 if (theImage.IsEmpty()
304 || !getDataFormat (theImage, aFormat, aType)
305 || ((theBufferType == Graphic3d_BT_Depth) && (aFormat != GL_DEPTH_COMPONENT))
308 return Standard_False;
312 GLint aReadBufferPrev = GL_BACK;
313 if (theFBOPtr != NULL && theFBOPtr->IsValid())
315 theFBOPtr->BindBuffer (GetGlContext());
319 glGetIntegerv (GL_READ_BUFFER, &aReadBufferPrev);
320 GLint aDrawBufferPrev = GL_BACK;
321 glGetIntegerv (GL_DRAW_BUFFER, &aDrawBufferPrev);
322 glReadBuffer (aDrawBufferPrev);
326 const GLint anExtraBytes = (GLint )theImage.RowExtraBytes();
327 const GLint anAligment = Min (GLint(theImage.MaxRowAligmentBytes()), 8); // limit to 8 bytes for OpenGL
328 glPixelStorei (GL_PACK_ALIGNMENT, anAligment);
330 const GLint aPixelsWidth = GLint(theImage.SizeRowBytes() / theImage.SizePixelBytes());
331 glPixelStorei (GL_PACK_ROW_LENGTH, (anExtraBytes >= anAligment) ? aPixelsWidth : 0);
333 if (theImage.IsTopDown())
336 for (Standard_Size aRow = 0; aRow < theImage.SizeY(); ++aRow)
338 // Image_PixMap rows indexation always starts from the upper corner
339 // while order in memory depends on the flag and processed by ChangeRow() method
340 glReadPixels (0, GLint(theImage.SizeY() - aRow - 1), GLsizei (theImage.SizeX()), 1, aFormat, aType, theImage.ChangeRow (aRow));
345 glReadPixels (0, 0, GLsizei (theImage.SizeX()), GLsizei (theImage.SizeY()), aFormat, aType, theImage.ChangeData());
348 glPixelStorei (GL_PACK_ALIGNMENT, 1);
349 glPixelStorei (GL_PACK_ROW_LENGTH, 0);
351 if (theFBOPtr != NULL && theFBOPtr->IsValid())
353 theFBOPtr->UnbindBuffer (GetGlContext());
357 glReadBuffer (aReadBufferPrev);
359 return Standard_True;
362 void OpenGl_GraphicDriver::RemoveView (const Graphic3d_CView& theCView)
364 Handle(OpenGl_Context) aCtx = GetSharedContext();
365 Handle(OpenGl_View) aView;
366 Handle(OpenGl_Workspace) aWindow;
367 if (myMapOfWS.Find (theCView.WsId, aWindow))
369 myMapOfWS.UnBind (theCView.WsId);
371 if (!aWindow.IsNull())
373 if (aWindow->GetGlContext()->MakeCurrent())
375 aCtx = aWindow->GetGlContext();
379 // try to hijack another context if any
380 const Handle(OpenGl_Context)& anOtherCtx = GetSharedContext();
381 if (!anOtherCtx.IsNull()
382 && anOtherCtx != aWindow->GetGlContext())
389 if (myMapOfView.Find (theCView.ViewId, aView))
391 aView->ReleaseGlResources (aCtx);
392 myMapOfView.UnBind (theCView.ViewId);
395 if (myMapOfWS.IsEmpty())
397 // The last view removed but some objects still present.
398 // Release GL resources now without object destruction.
399 for (NCollection_DataMap<Standard_Integer, OpenGl_Structure*>::Iterator aStructIt (myMapOfStructure);
400 aStructIt.More (); aStructIt.Next())
402 OpenGl_Structure* aStruct = aStructIt.ChangeValue();
403 aStruct->ReleaseGlResources (aCtx);
405 myTempText->Release (aCtx);
406 myDeviceLostFlag = !myMapOfStructure.IsEmpty();
409 OpenGl_CView* aCView = (OpenGl_CView* )theCView.ptrView;
411 ((Graphic3d_CView *)&theCView)->ptrView = NULL;
418 void OpenGl_GraphicDriver::SetLight (const Graphic3d_CView& ACView)
420 const OpenGl_CView *aCView = (const OpenGl_CView *)ACView.ptrView;
422 aCView->View->SetLights(ACView.Context);
425 void OpenGl_GraphicDriver::SetClipPlanes (const Graphic3d_CView& theCView)
427 const OpenGl_CView *aCView = (const OpenGl_CView *)theCView.ptrView;
430 aCView->View->SetClipPlanes (theCView.Context.ClipPlanes);
434 //=======================================================================
435 //function : SetCamera
437 //=======================================================================
438 void OpenGl_GraphicDriver::SetCamera (const Graphic3d_CView& theCView)
440 const OpenGl_CView *aCView = (const OpenGl_CView *)theCView.ptrView;
443 aCView->View->SetCamera (theCView.Context.Camera);
447 void OpenGl_GraphicDriver::SetVisualisation (const Graphic3d_CView& ACView)
449 const OpenGl_CView *aCView = (const OpenGl_CView *)ACView.ptrView;
452 aCView->View->SetVisualisation(ACView.Context);
453 aCView->WS->UseZBuffer() = ( ACView.Context.Visualization == 0? (ACView.Context.ZBufferActivity == 1) : (ACView.Context.ZBufferActivity != 0) );
457 void OpenGl_GraphicDriver::Transparency (const Graphic3d_CView& ACView, const Standard_Boolean AFlag)
459 const OpenGl_CView *aCView = (const OpenGl_CView *)ACView.ptrView;
461 aCView->WS->UseTransparency(AFlag);
464 // =======================================================================
465 // function : InvalidateBVHData
467 // =======================================================================
468 void OpenGl_GraphicDriver::InvalidateBVHData (Graphic3d_CView& theCView, const Standard_Integer theLayerId)
470 OpenGl_CView *aCView = (OpenGl_CView *)theCView.ptrView;
473 aCView->View->InvalidateBVHData (theLayerId);
477 Standard_Boolean OpenGl_GraphicDriver::View (Graphic3d_CView& theCView)
479 if (myMapOfView.IsBound (theCView.ViewId)
480 || myMapOfWS .IsBound (theCView.WsId))
482 return Standard_False;
485 Handle(OpenGl_Context) aShareCtx = GetSharedContext();
486 Handle(OpenGl_Workspace) aWS = new OpenGl_Workspace (myDisplayConnection, theCView.DefWindow, theCView.GContext, myCaps, aShareCtx);
487 Handle(OpenGl_View) aView = new OpenGl_View (theCView.Context, &myStateCounter);
488 myMapOfWS .Bind (theCView.WsId, aWS);
489 myMapOfView.Bind (theCView.ViewId, aView);
491 OpenGl_CView* aCView = new OpenGl_CView();
492 aCView->View = aView;
494 theCView.ptrView = aCView;
496 return Standard_True;
499 void OpenGl_GraphicDriver::SetBackFacingModel (const Graphic3d_CView& ACView)
501 const OpenGl_CView *aCView = (const OpenGl_CView *)ACView.ptrView;
503 aCView->View->SetBackfacing(ACView.Backfacing);
506 //=======================================================================
507 //function : AddZLayer
509 //=======================================================================
511 void OpenGl_GraphicDriver::AddZLayer (const Graphic3d_CView& theCView,
512 const Standard_Integer theLayerId)
514 const OpenGl_CView *aCView = (const OpenGl_CView *)theCView.ptrView;
516 aCView->View->AddZLayer (theLayerId);
519 //=======================================================================
520 //function : RemoveZLayer
522 //=======================================================================
523 void OpenGl_GraphicDriver::RemoveZLayer (const Graphic3d_CView& theCView,
524 const Standard_Integer theLayerId)
526 const OpenGl_CView* aCView = (const OpenGl_CView *)theCView.ptrView;
528 aCView->View->RemoveZLayer (theLayerId);
531 //=======================================================================
532 //function : SetZLayerSettings
534 //=======================================================================
535 Standard_EXPORT void OpenGl_GraphicDriver::SetZLayerSettings (const Graphic3d_CView& theCView,
536 const Standard_Integer theLayerId,
537 const Graphic3d_ZLayerSettings& theSettings)
539 const OpenGl_CView* aCView = (const OpenGl_CView* )theCView.ptrView;
541 aCView->View->SetZLayerSettings (theLayerId, theSettings);