0024637: Visualization - clean up implementation of rendering in immediate mode
[occt.git] / src / OpenGl / OpenGl_Window.hxx
CommitLineData
b311480e 1// Created on: 2011-09-20
2// Created by: Sergey ZERCHANINOV
973c2be1 3// Copyright (c) 2011-2014 OPEN CASCADE SAS
b311480e 4//
973c2be1 5// This file is part of Open CASCADE Technology software library.
b311480e 6//
d5f74e42 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
973c2be1 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.
b311480e 12//
973c2be1 13// Alternatively, this file may be used under the terms of Open CASCADE
14// commercial license or contractual agreement.
b311480e 15
2166f0fa
SK
16#ifndef _OpenGl_Window_Header
17#define _OpenGl_Window_Header
18
3695b8c2 19#include <OpenGl_GlCore11.hxx>
2166f0fa 20#include <InterfaceGraphic_Aspect.hxx>
58655684 21#include <OpenGl_Caps.hxx>
2166f0fa 22
2166f0fa 23#include <Handle_OpenGl_Context.hxx>
3695b8c2 24#include <Handle_OpenGl_Display.hxx>
25#include <Handle_OpenGl_Window.hxx>
26
27#include <MMgt_TShared.hxx>
2166f0fa
SK
28
29//! This class represents low-level wrapper over window with GL context.
30//! The window itself should be provided to constructor.
31class OpenGl_Window : public MMgt_TShared
32{
33public:
34
35 //! Main constructor - prepare GL context for specified window.
36 OpenGl_Window (const Handle(OpenGl_Display)& theDisplay,
37 const CALL_DEF_WINDOW& theCWindow,
5e27df78 38 Aspect_RenderingContext theGContext,
58655684 39 const Handle(OpenGl_Caps)& theCaps,
5e27df78 40 const Handle(OpenGl_Context)& theShareCtx);
2166f0fa
SK
41
42 //! Destructor
43 virtual ~OpenGl_Window();
44
45 //! Resizes the window.
46 void Resize (const CALL_DEF_WINDOW& theCWindow);
47
48 //! Reads depth component for current scene into specified buffer.
49 void ReadDepths (const Standard_Integer theX, const Standard_Integer theY,
50 const Standard_Integer theWidth, const Standard_Integer theHeight,
51 float* theDepths);
52
53 void SetBackgroundColor (const Standard_ShortReal theR,
54 const Standard_ShortReal theG,
55 const Standard_ShortReal theB);
56
57 void EnablePolygonOffset() const;
58 void DisablePolygonOffset() const;
59
60 Standard_Integer Width() const { return myWidth; }
61 Standard_Integer Height() const { return myHeight; }
62 const TEL_COLOUR& BackgroundColor() const { return myBgColor; }
63 Standard_Boolean Dither() const { return myDither; }
64 Standard_Boolean BackDither() const { return myBackDither; }
65
66 const Handle(OpenGl_Display)& GetDisplay() const { return myDisplay; }
67
68 const Handle(OpenGl_Context)& GetGlContext() const { return myGlContext; }
69
5e27df78 70 //! This method will be removed in future version!
71 GLCONTEXT GetGContext() const;
2166f0fa
SK
72
73protected:
74
75 //! Activates GL context and setup viewport.
76 void Init();
77
78 //! Makes GL context for this window active in current thread
79 virtual Standard_Boolean Activate();
80
81 void EnableFeatures() const;
82 void DisableFeatures() const;
83
84 //! Draw directly to the FRONT buffer. Can cause artifacts on the screen.
85 void MakeFrontBufCurrent() const;
86
87 //! Draw to BACK buffer. Normal and default state.
88 void MakeBackBufCurrent() const;
89
2166f0fa
SK
90protected:
91
92 Handle(OpenGl_Display) myDisplay;
2166f0fa 93 Handle(OpenGl_Context) myGlContext;
2166f0fa
SK
94 Standard_Boolean myOwnGContext; //!< set to TRUE if GL context was not created by this class
95#if (defined(_WIN32) || defined(__WIN32__))
2166f0fa
SK
96 BOOL mySysPalInUse;
97#endif
98
99 Standard_Integer myWidth; // WSWidth
100 Standard_Integer myHeight; // WSHeight
101 TEL_COLOUR myBgColor; // WSBackground
102 Standard_Boolean myDither;
103 Standard_Boolean myBackDither;
104
105public:
106
107 DEFINE_STANDARD_RTTI(OpenGl_Window) // Type definition
1c35b92f 108 DEFINE_STANDARD_ALLOC
2166f0fa
SK
109
110};
111
112#endif //_OpenGl_Window_Header