1c2d4cf78b3189484b5836253d8ee29b3ce64eef
[occt.git] / src / D3DHost / D3DHost_View.hxx
1 // Created on: 2015-06-10
2 // Created by: Kirill Gavrilov
3 // Copyright (c) 2015 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 _D3DHost_View_HeaderFile
17 #define _D3DHost_View_HeaderFile
18
19 #include <d3d9.h>
20
21 #include <D3DHost_FrameBuffer.hxx>
22 #include <OpenGl_View.hxx>
23 #include <OpenGl_Workspace.hxx>
24
25 class D3DHost_GraphicDriver;
26
27 //! The D3D host view implementation that overrides rendering methods.
28 class D3DHost_View : public OpenGl_View
29 {
30
31 public:
32
33   //! Constructor.
34   Standard_EXPORT D3DHost_View (const Handle(Graphic3d_StructureManager)& theMgr,
35                                 const Handle(D3DHost_GraphicDriver)& theDriver,
36                                 const Handle(OpenGl_Caps)& theCaps,
37                                 Standard_Boolean& theDeviceLostFlag,
38                                 OpenGl_StateCounter* theCounter);
39
40   //! Default destructor.
41   Standard_EXPORT virtual ~D3DHost_View();
42
43   //! Creates and maps rendering window to the view.
44   //! @param theWindow [in] the window.
45   //! @param theContext [in] the rendering context. If NULL the context will be created internally.
46   //! @param theDisplayCB [in] the display callback function. If is not a NULL value, then the callback will be
47   //! invoked at the end of the OCC graphic traversal and just before the swap of buffers.
48   //! @param theClientData [in] the client data for the callback.
49   Standard_EXPORT virtual void SetWindow (const Handle(Aspect_Window)& theWindow,
50                                           const Aspect_RenderingContext theContext,
51                                           const Aspect_GraphicCallbackProc& theDisplayCB,
52                                           const Standard_Address theClientData) Standard_OVERRIDE;
53
54   //! Resizes the window.
55   Standard_EXPORT virtual void Resized() Standard_OVERRIDE;
56
57   //! Redraw the all content.
58   Standard_EXPORT virtual void Redraw() Standard_OVERRIDE;
59
60   //! Redraw only immediate layer.
61   Standard_EXPORT virtual void RedrawImmediate() Standard_OVERRIDE;
62
63 public:
64
65   //! @return true if IDirect3DDevice9Ex device has been created
66   bool isD3dEx() const { return myIsD3dEx; }
67
68   //! Access Direct3D device instance.
69   IDirect3DDevice9* D3dDevice() const { return myD3dDevice; }
70
71   //! Return D3D/WGL FBO.
72   const Handle(D3DHost_FrameBuffer)& D3dWglBuffer() const { return myD3dWglFbo; }
73
74   //! Return D3D surface.
75   IDirect3DSurface9* D3dColorSurface() const { return myD3dWglFbo->D3dColorSurface(); }
76
77 protected:
78
79   //! Auxiliary method.
80   Standard_EXPORT static TCollection_AsciiString d3dFormatError (HRESULT theErrCode);
81
82   //! Initialize the D3D library.
83   Standard_EXPORT bool d3dInitLib();
84
85   //! Initialize Direct3D output device.
86   Standard_EXPORT bool d3dInit();
87
88   //! Reset Direct3D output settings. Could be used to switch windowed/fullscreen modes.
89   //! Use very carefully! Most objects should be released before and recreated after!
90   Standard_EXPORT bool d3dReset();
91
92   //! (Re-)create D3D surface.
93   Standard_EXPORT bool d3dCreateRenderTarget();
94
95   //! Starts the scene render.
96   //! Clears the backbuffer and sets the device to start rendering to it.
97   Standard_EXPORT void d3dBeginRender();
98
99   //! Ends the scene render.
100   Standard_EXPORT void d3dEndRender();
101
102   //! Presents to the screen.
103   Standard_EXPORT bool d3dSwap();
104
105 protected:
106
107   IDirect3D9*                 myD3dLib;      //!< Direct3D library instance
108   IDirect3DDevice9*           myD3dDevice;   //!< Direct3D device object
109   D3DPRESENT_PARAMETERS       myD3dParams;   //!< parameters for created Direct3D device
110   D3DDISPLAYMODE              myCurrMode;    //!< temporary variable
111   UINT                        myRefreshRate; //!< refresh rate in fullscreen mode
112   bool                        myIsD3dEx;     //!< D3dEx flag for WDDM
113   Handle(D3DHost_FrameBuffer) myD3dWglFbo;   //!< D3D/WGL interop FBO
114
115 public:
116
117   DEFINE_STANDARD_RTTI(D3DHost_View, OpenGl_View)
118
119 };
120
121 DEFINE_STANDARD_HANDLE(D3DHost_View, OpenGl_View)
122
123 #endif // #ifndef _D3DHost_View_HeaderFile