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