VST 3 Interfaces: Platform UI Types
Author: Steinberg

VST 3 Interfaces VST 3.8 SDK for developing VST plug-in

Loading...
Searching...
No Matches
Variables
Platform UI Types
Graphical User Interface

List of Platform UI types for IPlugView. More...

Collaboration diagram for Platform UI Types:

## Variables
const FIDString | kPlatformTypeHWND
const FIDString | kPlatformTypeHIView
const FIDString | kPlatformTypeNSView
const FIDString | kPlatformTypeUIView
const FIDString | kPlatformTypeX11EmbedWindowID
const FIDString | kPlatformTypeWaylandSurfaceID
const FIDString | kPlatformTypeHWND = "HWND"
| The parent parameter in IPlugView::attached() is a HWND handle.
const FIDString | kPlatformTypeHIView = "HIView"
| The parent parameter in IPlugView::attached() is a WindowRef.
const FIDString | kPlatformTypeNSView = "NSView"
| The parent parameter in IPlugView::attached() is a NSView pointer.
const FIDString | kPlatformTypeUIView = "UIView"
| The parent parameter in IPlugView::attached() is a UIView pointer.
const FIDString | kPlatformTypeX11EmbedWindowID = "X11EmbedWindowID"
| The parent parameter in IPlugView::attached() is a X11 Window supporting XEmbed.
const FIDString | kPlatformTypeWaylandSurfaceID = "WaylandSurfaceID"
| The parent parameter in IPlugView::attached() is a wl_surface pointer.

## Detailed Description

List of Platform UI types for IPlugView.

This list is used to match the GUI-System between the host and a plug-in in case that an OS provides multiple GUI-APIs.

## Variable Documentation

## ◆ kPlatformTypeHWND

const FIDString kPlatformTypeHWND = "HWND"

The parent parameter in IPlugView::attached() is a HWND handle.

You should attach a child window to it. HWND handle. (Microsoft Windows)

## ◆ kPlatformTypeHIView

const FIDString kPlatformTypeHIView = "HIView"

The parent parameter in IPlugView::attached() is a WindowRef.

You should attach a HIViewRef to the content view of the window. HIViewRef. (Mac OS X)

## ◆ kPlatformTypeNSView

const FIDString kPlatformTypeNSView = "NSView"

The parent parameter in IPlugView::attached() is a NSView pointer.

You should attach a NSView to it. NSView pointer. (Mac OS X)

## ◆ kPlatformTypeUIView

const FIDString kPlatformTypeUIView = "UIView"

The parent parameter in IPlugView::attached() is a UIView pointer.

You should attach an UIView to it. UIView pointer. (iOS)

## ◆ kPlatformTypeX11EmbedWindowID

const FIDString kPlatformTypeX11EmbedWindowID = "X11EmbedWindowID"

The parent parameter in IPlugView::attached() is a X11 Window supporting XEmbed.

You should attach a Window to it that supports the XEmbed extension. See https://standards.freedesktop.org/xembed-spec/xembed-spec-latest.html X11 Window ID. (X11)

## ◆ kPlatformTypeWaylandSurfaceID

const FIDString kPlatformTypeWaylandSurfaceID = "WaylandSurfaceID"

The parent parameter in IPlugView::attached() is a wl_surface pointer.

The plug-in should create a wl_surface and attach it to the parent surface as a wl_subsurface. The plug-in should not connect to the system compositor to do so, but use IWaylandHost::openWaylandConnection(). See https://wayland.freedesktop.org/docs/html Wayland Surface ID.

Empty

Copyright © Steinberg Media Technologies GmbH. All Rights Reserved. This documentation is under this license.