hosted_editor_container.hpp

Go to the documentation of this file.

#pragma once
 
// Host-owned container view for an embedded plugin editor.
//
// CLAP `set_parent` and VST3 `IPlugView::attached` both CONSUME a parent view:
// the plugin inserts its own native view into what the host hands it, and never
// hands a view back. PluginSlot::HostedEditor is the other way round — the slot
// returns a `native_handle` that the host embeds. A host-owned container
// reconciles the two: the slot creates a container, gives it to the plugin as
// the parent, and returns the container as its HostedEditor::native_handle.
//
// AU v2's CocoaUI factory does return an NSView, so it does not need the
// container to bridge anything — it wraps its view in one anyway so that
// resize and teardown are uniform across formats.
//
// The container is created already inserted into `parent_window`'s content
// view. That ordering is deliberate: EditorAttachment::create() calls
// create_hosted_editor() BEFORE attach_native_child_view(), so a container that
// deferred insertion would have the plugin run set_parent()/attached() against
// a view with no window. Editors that bring up Metal/OpenGL layers on attach
// misbehave in that state. The later attach_native_child_view() re-parents the
// container within the same window, which is a cheap addSubview: move.
//
// Platforms without a native-window seam compile a stub whose create returns
// nullptr; create_hosted_editor() then returns nullptr and EditorAttachment
// already treats that as "no editor".
 
#include <cstdint>
 
namespace pulp::host {

void* create_editor_container(void* parent_window, uint32_t width, uint32_t height);

bool editor_container_adopt_view(void* container, void* native_view,
                                 uint32_t width, uint32_t height);

void resize_editor_container(void* container, uint32_t width, uint32_t height);

void destroy_editor_container(void* container);

double editor_container_scale(void* parent_window);
 
} // namespace pulp::host