vtkXOpenGLRenderWindow.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 vtkXOpenGLRenderWindow_h
#define vtkXOpenGLRenderWindow_h

#include "vtkOpenGLRenderWindow.h"
#include "vtkRenderingOpenGL2Module.h" // For export macro
#include "vtkWrappingHints.h"          // For VTK_MARSHALAUTO
#include "vtkX11Functions.h"           // Needed for X types used in the public interface
#include <stack>                       // for ivar

VTK_ABI_NAMESPACE_BEGIN
class vtkIdList;
class vtkXOpenGLRenderWindowInternal;

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

  void Start() override;

  void Frame() override;

  virtual void WindowInitialize();

  void Initialize() override;

  void Finalize() override;

  void SetFullScreen(vtkTypeBool) override;

  void WindowRemap() override;

  // Call X funcs to map unmap
  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]); }


  virtual Colormap GetDesiredColormap();
  virtual Visual* GetDesiredVisual();
  virtual vtkXVisualInfo* GetDesiredVisualInfo();
  virtual int GetDesiredDepth();

  void SetStereoCapableWindow(vtkTypeBool capable) override;

  void SetCoverable(vtkTypeBool coverable) override;

  void MakeCurrent() override;

  bool IsCurrent() override;

  void ReleaseCurrent() override;

  void SetForceMakeCurrent() override;

  const char* ReportCapabilities() override;

  vtkTypeBool IsDirect() override;

  void* GetGenericDisplayId() override { return this->GetDisplayId(); }

  void* GetGenericWindowId() override;
  void* GetGenericParentId() override { return reinterpret_cast<void*>(this->ParentId); }

  void* GetGenericContext() override;
  void* GetGenericDrawable() override { return reinterpret_cast<void*>(this->WindowId); }

  void* GetGenericFBConfig();

  int* GetScreenSize() VTK_SIZEHINT(2) override;

  int* GetPosition() VTK_SIZEHINT(2) override;

  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_NOT_SUPPORTED)
  Display* GetDisplayId();

  bool EnsureDisplay() override;


  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_NOT_SUPPORTED)
  void SetDisplayId(Display*);
  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_NOT_SUPPORTED)
  void SetDisplayId(void*) override;

  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_NOT_SUPPORTED)
  Window GetParentId();


  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_NOT_SUPPORTED)
  void SetParentId(Window);
  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_NOT_SUPPORTED)
  void SetParentId(void*) override;

  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_NOT_SUPPORTED)
  Window GetWindowId();


  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_NOT_SUPPORTED)
  void SetWindowId(Window);
  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_NOT_SUPPORTED)
  void SetWindowId(void*) override;

  void SetNextWindowId(Window);

  void SetNextWindowId(void*) override;

  void SetWindowName(const char*) override;

  void SetIcon(vtkImageData* img) override;

  bool InitializeFromCurrentContext() override;

  bool GetPlatformSupportsRenderWindowSharing() override { return true; }


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


  void HideCursor() override;
  void ShowCursor() override;

  void SetCurrentCursor(int) override;

  vtkTypeBool GetEventPending() override;

  void SetWindowInfo(const char* info) override;

  void SetNextWindowInfo(const char* info) override;

  void SetParentInfo(const char* info) override;

  void Render() override;


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

  bool SetSwapControl(int i) override;

protected:
  vtkXOpenGLRenderWindow();
  ~vtkXOpenGLRenderWindow() override;

  vtkXOpenGLRenderWindowInternal* Internal;

  Window ParentId;
  Window WindowId;
  Window NextWindowId;
  Display* DisplayId;
  Colormap ColorMap;
  vtkTypeBool OwnWindow;
  vtkTypeBool OwnDisplay;
  vtkTypeBool CursorHidden;
  vtkTypeBool ForceMakeCurrent;
  vtkTypeBool UsingHardware;

  std::stack<Display*> DisplayStack;
  std::stack<Drawable> DrawableStack;
  std::stack<void*> ContextStack;

  // we must keep track of the cursors we are using
  Cursor XCCrosshair;
  Cursor XCArrow;
  Cursor XCSizeAll;
  Cursor XCSizeNS;
  Cursor XCSizeWE;
  Cursor XCSizeNE;
  Cursor XCSizeNW;
  Cursor XCSizeSE;
  Cursor XCSizeSW;
  Cursor XCHand;
  Cursor XCCustom;

  void CreateAWindow() override;
  void DestroyWindow() override;
  void CloseDisplay();

private:
  vtkXOpenGLRenderWindow(const vtkXOpenGLRenderWindow&) = delete;
  void operator=(const vtkXOpenGLRenderWindow&) = delete;

  bool EnsureGLX();
};

VTK_ABI_NAMESPACE_END
#endif