0026392: Visualization, TKD3DHost - provide straight-forward base for integration...
[occt.git] / src / D3DHost / D3DHost_FrameBuffer.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_FrameBuffer_HeaderFile
17 #define _D3DHost_FrameBuffer_HeaderFile
18
19 #include <OpenGl_FrameBuffer.hxx>
20
21 struct IDirect3DDevice9;
22
23 //! Implements bridge FBO for direct rendering to Direct3D surfaces.
24 class D3DHost_FrameBuffer : public OpenGl_FrameBuffer
25 {
26 public:
27
28   //! Empty constructor.
29   Standard_EXPORT D3DHost_FrameBuffer();
30
31   //! Destructor, should be called after Release().
32   Standard_EXPORT ~D3DHost_FrameBuffer();
33
34   //! Releases D3D and OpenGL resources.
35   Standard_EXPORT virtual void Release (OpenGl_Context* theCtx) Standard_OVERRIDE;
36
37   //! Initializes OpenGL FBO for Direct3D interoperability.
38   Standard_EXPORT Standard_Boolean Init (const Handle(OpenGl_Context)& theCtx,
39                                          IDirect3DDevice9*             theD3DDevice,
40                                          const Standard_Boolean        theIsD3dEx,
41                                          const Standard_Integer        theSizeX,
42                                          const Standard_Integer        theSizeY);
43
44   //! Binds Direct3D color buffer to OpenGL texture.
45   Standard_EXPORT Standard_Boolean registerD3dBuffer (const Handle(OpenGl_Context)& theCtx);
46
47   //! Binds Direct3D objects for OpenGL drawing.
48   //! Should be called before LockSurface() and followed by UnlockSurface();
49   Standard_EXPORT virtual void BindBuffer (const Handle(OpenGl_Context)& theCtx) Standard_OVERRIDE;
50
51   //! Acquires D3D resource for OpenGL usage.
52   Standard_EXPORT virtual void LockSurface   (const Handle(OpenGl_Context)& theCtx);
53
54   //! Releases D3D resource.
55   Standard_EXPORT virtual void UnlockSurface (const Handle(OpenGl_Context)& theCtx);
56
57   //! Returns D3D surface used as color buffer.
58   IDirect3DSurface9* D3dColorSurface()      { return myD3dSurf; }
59
60   //! Returns WDDM hande for D3D color surface.
61   HANDLE             D3dColorSurfaceShare() { return myD3dSurfShare; }
62
63 protected:
64
65   using OpenGl_FrameBuffer::Init;
66
67 protected:
68
69   IDirect3DSurface9* myD3dSurf;      //!< D3D surface
70   HANDLE             myD3dSurfShare; //!< D3D surface share handle in WDDM
71   HANDLE             myGlD3dDevice;  //!< WGL/D3D device  handle
72   HANDLE             myGlD3dSurf;    //!< WGL/D3D surface handle
73   Standard_Integer   myLockCount;    //!< locking counter
74
75 public:
76
77   DEFINE_STANDARD_RTTI(D3DHost_FrameBuffer, OpenGl_FrameBuffer)
78
79 };
80
81 DEFINE_STANDARD_HANDLE(D3DHost_FrameBuffer, OpenGl_FrameBuffer)
82
83 #endif // _D3DHost_FrameBuffer_HeaderFile