vtkWin32OpenGLRenderWindow.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkWin32OpenGLRenderWindow_h
#define vtkWin32OpenGLRenderWindow_h

#include "vtkOpenGLRenderWindow.h"

#include "vtkRenderingOpenGL2Module.h" // For export macro
#include "vtkWrappingHints.h"          // For VTK_MARSHALAUTO
#include <stack>                       // for ivar

#include "vtkWindows.h" // For windows API

VTK_ABI_NAMESPACE_BEGIN
class vtkIdList;

class VTKRENDERINGOPENGL2_EXPORT VTK_MARSHALAUTO vtkWin32OpenGLRenderWindow
  : public vtkOpenGLRenderWindow
{
public:
  static vtkWin32OpenGLRenderWindow* New();
  vtkTypeMacro(vtkWin32OpenGLRenderWindow, vtkOpenGLRenderWindow);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void Frame() override;

  virtual void WindowInitialize();

  void Initialize() override;

  void Finalize() override;

  void SetFullScreen(vtkTypeBool) override;

  void WindowRemap() override;

  void SetShowWindow(bool val) override;

  virtual void PrefFullScreen();


  void SetSize(int width, int height) override;
  void SetSize(int a[2]) override { this->SetSize(a[0], a[1]); }

  int* GetSize() VTK_SIZEHINT(2) override;


  void SetPosition(int x, int y) override;
  void SetPosition(int a[2]) override { this->SetPosition(a[0], a[1]); }

  int* GetScreenSize() VTK_SIZEHINT(2) override;

  int* GetPosition() VTK_SIZEHINT(2) override;

  void SetWindowName(const char*) override;

  void SetIcon(vtkImageData* img) override;

  void SetWindowInfo(const char*) override;

  void SetNextWindowInfo(const char*) override;

  void SetParentInfo(const char*) override;

  void* GetGenericDisplayId() override { return (void*)this->ContextId; }
  void* GetGenericWindowId() override { return (void*)this->WindowId; }
  void* GetGenericParentId() override { return (void*)this->ParentId; }
  void* GetGenericContext() override { return (void*)this->DeviceContext; }
  void* GetGenericDrawable() override { return (void*)this->WindowId; }
  void SetDisplayId(void*) override;

  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_NOT_SUPPORTED)
  HWND GetWindowId();


  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_NOT_SUPPORTED)
  void SetWindowId(HWND);
  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_NOT_SUPPORTED)
  void SetWindowId(void* foo) override { this->SetWindowId((HWND)foo); }

  bool InitializeFromCurrentContext() override;

  bool GetPlatformSupportsRenderWindowSharing() override { return true; }


  void SetParentId(HWND);
  void SetParentId(void* foo) override { this->SetParentId((HWND)foo); }

  void SetContextId(HGLRC);   // hsr
  void SetDeviceContext(HDC); // hsr

  void SetNextWindowId(HWND);

  void SetNextWindowId(void* arg) override;

  void SetStereoCapableWindow(vtkTypeBool capable) override;

  void MakeCurrent() override;

  void ReleaseCurrent() override;

  bool IsCurrent() override;

  const char* ReportCapabilities() override;

  vtkTypeBool IsDirect() override;

  vtkTypeBool GetEventPending() override;


  virtual void SetupPalette(HDC hDC);
  virtual void SetupPixelFormatPaletteAndContext(
    HDC hDC, DWORD dwFlags, int debug, int bpp = 16, int zbpp = 16);

  void Clean();


  void HideCursor() override;
  void ShowCursor() override;
  void SetCursorPosition(int x, int y) override;

  void SetCurrentCursor(int) override;

  bool DetectDPI() override;


  void PushContext() override;
  void PopContext() override;

  bool SetSwapControl(int i) override;

protected:
  vtkWin32OpenGLRenderWindow();
  ~vtkWin32OpenGLRenderWindow() override;

  HINSTANCE ApplicationInstance;
  HPALETTE Palette;
  HPALETTE OldPalette;
  HGLRC ContextId;
  HDC DeviceContext;
  BOOL MFChandledWindow;
  HWND WindowId;
  HWND ParentId;
  HWND NextWindowId;
  vtkTypeBool OwnWindow;
  vtkTypeBool Resizing;
  vtkTypeBool Repositioning;
  static const std::string DEFAULT_BASE_WINDOW_NAME;

  std::stack<HGLRC> ContextStack;
  std::stack<HDC> DCStack;

  // message handler
  virtual LRESULT MessageProc(HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam);

  static LRESULT APIENTRY WndProc(HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam);
  vtkTypeBool CursorHidden;
  vtkTypeBool ForceMakeCurrent;

  int WindowIdReferenceCount;
  void ResizeWhileOffscreen(int xsize, int ysize);
  void CreateAWindow() override;
  void DestroyWindow() override;
  void InitializeApplication();
  void CleanUpRenderers();
  void VTKRegisterClass();

private:
  vtkWin32OpenGLRenderWindow(const vtkWin32OpenGLRenderWindow&) = delete;
  void operator=(const vtkWin32OpenGLRenderWindow&) = delete;
};

VTK_ABI_NAMESPACE_END
#endif