#include <plugin_view_host.hpp>

Classes
struct	Size
struct	Options
struct	GpuCacheUsage
	Bytes held by this host's GPU resource caches: budgeted against Skia's budget, purgeable what a trim can return. More...
struct	GpuSurfaceStatus
class	GpuSurfaceSubscription

Public Types
enum class	PresentPolicy { vsync , nonblocking }
	How a host presents finished frames (WAH-13). More...
enum class	GpuSurfaceState : uint8_t { pending , ready , unavailable }
using	Factory
using	GpuSurfaceObserver = std::function<void(const GpuSurfaceStatus&)>

Public Member Functions
virtual	~PluginViewHost ()
	Out-of-line, and NOT trivial: it clears the back-pointer of every NativeViewHost still attached to this host.
virtual NativeViewHandle	native_handle ()=0
virtual bool	start_file_drag (const FileDragRequest &request)
virtual void	attach_to_parent (NativeViewHandle parent)=0
virtual bool	try_attach_to_parent (NativeViewHandle parent)
virtual bool	is_attached () const noexcept
virtual void	detach ()=0
virtual void	repaint ()=0
virtual bool	present_first_frame ()
void	mark_dirty_region (const Rect &root_rect)
void	mark_dirty_full ()
virtual void	request_frame ()
	A frame without damage (see WindowHost::request_frame()).
bool	pending_repaint_is_full () const
bool	has_pending_dirty_bounds () const
Rect	pending_dirty_bounds () const
void	clear_pending_dirty ()
	Host calls this once the frame is painted and submitted.
virtual void	set_size (uint32_t width, uint32_t height)=0
virtual Size	get_size () const =0
virtual bool	is_gpu_backed () const
virtual render::GpuSurface *	gpu_surface () const
virtual GpuCacheUsage	gpu_cache_usage () const
virtual void	release_gpu_caches ()
	Return every GPU cache resource nothing references to the device.
GpuSurfaceStatus	gpu_surface_status () const noexcept
GpuSurfaceState	gpu_surface_state () const noexcept
GpuSurfaceSubscription	observe_gpu_surface (GpuSurfaceObserver observer)
virtual void	set_resize_callback (std::function< void(uint32_t, uint32_t)> cb)
virtual void	set_idle_callback (std::function< void()> callback)
virtual void	advance_frame (double timestamp_seconds)
virtual std::vector< uint8_t >	capture_back_buffer_png ()
virtual bool	attach_native_child_view (NativeViewHandle child_view, float x, float y, float width, float height)
virtual bool	set_native_child_view_bounds (NativeViewHandle child_view, float x, float y, float width, float height)
virtual void	detach_native_child_view (NativeViewHandle child_view)
virtual bool	set_native_child_view_clip (NativeViewHandle child_view, bool has_clip, float x, float y, float width, float height)
virtual void	pump_x_events ()
virtual void	set_fixed_aspect_ratio (float ratio)
virtual void	set_design_viewport (float design_w, float design_h)
virtual void	set_design_viewport_top_align (bool top_align)
virtual Point	window_to_root_point (Point pt) const
virtual bool	design_viewport_transform (float &sx, float &sy, float &tx, float &ty) const
virtual void	set_scale_factor (float scale)
virtual float	scale_factor () const

Static Public Member Functions
static std::unique_ptr< PluginViewHost >	create (View &root, Size size)
static std::unique_ptr< PluginViewHost >	create (View &root, const Options &options)
static void	set_factory (Factory factory)
static void	clear_factory ()
static bool	has_factory ()

Protected Member Functions
void	publish_gpu_surface (render::GpuSurface *surface, GpuSurfaceState state)
void	mark_gpu_surface_pending ()

Protected Attributes
PendingDamage	damage_

Friends
class	NativeViewHost

Member Typedef Documentation

◆ Factory

using pulp::view::PluginViewHost::Factory

Initial value:

std::function<std::unique_ptr<PluginViewHost>(

View& root, const Options& options)>

pulp::view::View

Definition view.hpp:73

pulp::view::PluginViewHost::Options

Definition plugin_view_host.hpp:100

◆ GpuSurfaceObserver

using pulp::view::PluginViewHost::GpuSurfaceObserver = std::function<void(const GpuSurfaceStatus&)>

Member Enumeration Documentation

◆ GpuSurfaceState

enum class pulp::view::PluginViewHost::GpuSurfaceState : uint8_t

strong

Enumerator
pending
ready
unavailable

◆ PresentPolicy

enum class pulp::view::PluginViewHost::PresentPolicy

strong

How a host presents finished frames (WAH-13).

This was an unexplained cfg.vsync = false buried in the Windows host and an unexplained true elsewhere. Two different hosts had two different answers with no shared statement of WHY, which is how a measured fix in one place fails to reach the other.

Enumerator

vsync

Block until the display's next refresh (Fifo).

Correct for a host that OWNS its frame loop — a standalone window driven by a display link, where pacing to the refresh is the point.

nonblocking

Do not block on acquire (Mailbox, then Immediate, then Fifo).

Correct for an EMBEDDED editor: it renders synchronously from the DAW's paint message, on the DAW's UI thread, and the DAW already composites at its own cadence. Blocking there stalls the message pump that delivers further input.

Measured on the REAPER VM during a knob drag (Perfetto): the frame's own work was ~2 ms (paint ~1 ms, submit ~1 ms, present ~0.1 ms) while whole frames took 19-45 ms — the difference was all acquire. Seven frames were produced across eight drag sweeps.

On macOS this does not currently avoid vsync pacing: Dawn's Metal swapchain can only toggle CAMetalLayer.displaySyncEnabled, and Mailbox leaves it on exactly as Fifo does, so the preferred Mailbox still waits for a free drawable in acquire.

Constructor & Destructor Documentation

◆ ~PluginViewHost()

virtual pulp::view::PluginViewHost::~PluginViewHost ( )

virtual

Out-of-line, and NOT trivial: it clears the back-pointer of every NativeViewHost still attached to this host.

See the registry at the bottom of this class.

Member Function Documentation

◆ advance_frame()

virtual void pulp::view::PluginViewHost::advance_frame ( double timestamp_seconds )

inlinevirtual

◆ attach_native_child_view()

virtual bool pulp::view::PluginViewHost::attach_native_child_view	(	NativeViewHandle	child_view,
		float	x,
		float	y,
		float	width,
		float	height )

inlinevirtual

◆ attach_to_parent()

virtual void pulp::view::PluginViewHost::attach_to_parent ( NativeViewHandle parent )

pure virtual

◆ capture_back_buffer_png()

virtual std::vector< uint8_t > pulp::view::PluginViewHost::capture_back_buffer_png ( )

inlinevirtual

◆ clear_factory()

void pulp::view::PluginViewHost::clear_factory ( )

static

◆ clear_pending_dirty()

void pulp::view::PluginViewHost::clear_pending_dirty ( )

inline

Host calls this once the frame is painted and submitted.

◆ create() [1/2]

std::unique_ptr< PluginViewHost > pulp::view::PluginViewHost::create	(	View &	root,
		const Options &	options )

static

◆ create() [2/2]

std::unique_ptr< PluginViewHost > pulp::view::PluginViewHost::create	(	View &	root,
		Size	size )

static

◆ design_viewport_transform()

virtual bool pulp::view::PluginViewHost::design_viewport_transform	(	float &	sx,
		float &	sy,
		float &	tx,
		float &	ty ) const

inlinevirtual

◆ detach()

virtual void pulp::view::PluginViewHost::detach ( )

pure virtual

◆ detach_native_child_view()

virtual void pulp::view::PluginViewHost::detach_native_child_view ( NativeViewHandle child_view )

inlinevirtual

◆ get_size()

virtual Size pulp::view::PluginViewHost::get_size ( ) const

pure virtual

◆ gpu_cache_usage()

virtual GpuCacheUsage pulp::view::PluginViewHost::gpu_cache_usage ( ) const

inlinevirtual

◆ gpu_surface()

virtual render::GpuSurface * pulp::view::PluginViewHost::gpu_surface ( ) const

inlinevirtual

◆ gpu_surface_state()

GpuSurfaceState pulp::view::PluginViewHost::gpu_surface_state ( ) const

inlinenoexcept

◆ gpu_surface_status()

GpuSurfaceStatus pulp::view::PluginViewHost::gpu_surface_status ( ) const

inlinenoexcept

◆ has_factory()

bool pulp::view::PluginViewHost::has_factory ( )

static

◆ has_pending_dirty_bounds()

bool pulp::view::PluginViewHost::has_pending_dirty_bounds ( ) const

inline

◆ is_attached()

virtual bool pulp::view::PluginViewHost::is_attached ( ) const

inlinevirtualnoexcept

◆ is_gpu_backed()

virtual bool pulp::view::PluginViewHost::is_gpu_backed ( ) const

inlinevirtual

◆ mark_dirty_full()

void pulp::view::PluginViewHost::mark_dirty_full ( )

inline

◆ mark_dirty_region()

void pulp::view::PluginViewHost::mark_dirty_region ( const Rect & root_rect )

inline

◆ mark_gpu_surface_pending()

void pulp::view::PluginViewHost::mark_gpu_surface_pending ( )

inlineprotected

◆ native_handle()

virtual NativeViewHandle pulp::view::PluginViewHost::native_handle ( )

pure virtual

◆ observe_gpu_surface()

GpuSurfaceSubscription pulp::view::PluginViewHost::observe_gpu_surface ( GpuSurfaceObserver observer )

nodiscard

◆ pending_dirty_bounds()

Rect pulp::view::PluginViewHost::pending_dirty_bounds ( ) const

inline

◆ pending_repaint_is_full()

bool pulp::view::PluginViewHost::pending_repaint_is_full ( ) const

inline

◆ present_first_frame()

virtual bool pulp::view::PluginViewHost::present_first_frame ( )

inlinevirtual

◆ publish_gpu_surface()

void pulp::view::PluginViewHost::publish_gpu_surface	(	render::GpuSurface *	surface,
		GpuSurfaceState	state )

protected

◆ pump_x_events()

virtual void pulp::view::PluginViewHost::pump_x_events ( )

inlinevirtual

◆ release_gpu_caches()

virtual void pulp::view::PluginViewHost::release_gpu_caches ( )

inlinevirtual

Return every GPU cache resource nothing references to the device.

A format adapter calls this when the host hides the editor without closing it (CLAP gui_hide, an AU view leaving its window), so a hidden editor stops holding GPU memory it is not drawing with. The surfaces stay, so showing the editor again repaints without recreating them. Call it on the thread that renders, between frames. A no-op on a host with no GPU surface yet, and on CPU hosts.

◆ repaint()

virtual void pulp::view::PluginViewHost::repaint ( )

pure virtual

◆ request_frame()

virtual void pulp::view::PluginViewHost::request_frame ( )

inlinevirtual

A frame without damage (see WindowHost::request_frame()).

A host that paints from repaint() needs nothing more; a recorder can tell it apart from a whole-surface request by overriding it.

◆ scale_factor()

virtual float pulp::view::PluginViewHost::scale_factor ( ) const

inlinevirtual

◆ set_design_viewport()

virtual void pulp::view::PluginViewHost::set_design_viewport	(	float	design_w,
		float	design_h )

inlinevirtual

◆ set_design_viewport_top_align()

virtual void pulp::view::PluginViewHost::set_design_viewport_top_align ( bool top_align )

inlinevirtual

◆ set_factory()

void pulp::view::PluginViewHost::set_factory ( Factory factory )

static

◆ set_fixed_aspect_ratio()

virtual void pulp::view::PluginViewHost::set_fixed_aspect_ratio ( float ratio )

inlinevirtual

◆ set_idle_callback()

virtual void pulp::view::PluginViewHost::set_idle_callback ( std::function< void()> callback )

inlinevirtual

◆ set_native_child_view_bounds()

virtual bool pulp::view::PluginViewHost::set_native_child_view_bounds	(	NativeViewHandle	child_view,
		float	x,
		float	y,
		float	width,
		float	height )

inlinevirtual

◆ set_native_child_view_clip()

virtual bool pulp::view::PluginViewHost::set_native_child_view_clip	(	NativeViewHandle	child_view,
		bool	has_clip,
		float	x,
		float	y,
		float	width,
		float	height )

inlinevirtual

◆ set_resize_callback()

virtual void pulp::view::PluginViewHost::set_resize_callback ( std::function< void(uint32_t, uint32_t)> cb )

inlinevirtual

◆ set_scale_factor()

virtual void pulp::view::PluginViewHost::set_scale_factor ( float scale )

inlinevirtual

◆ set_size()

virtual void pulp::view::PluginViewHost::set_size	(	uint32_t	width,
		uint32_t	height )

pure virtual

◆ start_file_drag()

virtual bool pulp::view::PluginViewHost::start_file_drag ( const FileDragRequest & request )

inlinevirtual

◆ try_attach_to_parent()

virtual bool pulp::view::PluginViewHost::try_attach_to_parent ( NativeViewHandle parent )

inlinenodiscardvirtual

◆ window_to_root_point()

virtual Point pulp::view::PluginViewHost::window_to_root_point ( Point pt ) const

inlinevirtual

◆ NativeViewHost

friend class NativeViewHost

friend

Member Data Documentation

◆ damage_

PendingDamage pulp::view::PluginViewHost::damage_

protected

The documentation for this class was generated from the following file:

/home/runner/work/pulp/pulp/core/view/include/pulp/view/plugin_view_host.hpp

Pulp 1.88.0 Cross-platform audio plugin framework

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Member Typedef Documentation

◆ Factory

◆ GpuSurfaceObserver

Member Enumeration Documentation

◆ GpuSurfaceState

◆ PresentPolicy

Constructor & Destructor Documentation

◆ ~PluginViewHost()

Member Function Documentation

◆ advance_frame()

◆ attach_native_child_view()

◆ attach_to_parent()

◆ capture_back_buffer_png()

◆ clear_factory()

◆ clear_pending_dirty()

◆ create() [1/2]

◆ create() [2/2]

◆ design_viewport_transform()

◆ detach()

◆ detach_native_child_view()

◆ get_size()

◆ gpu_cache_usage()

◆ gpu_surface()

◆ gpu_surface_state()

◆ gpu_surface_status()

◆ has_factory()

◆ has_pending_dirty_bounds()

◆ is_attached()

◆ is_gpu_backed()

◆ mark_dirty_full()

◆ mark_dirty_region()

◆ mark_gpu_surface_pending()

◆ native_handle()

◆ observe_gpu_surface()

◆ pending_dirty_bounds()

◆ pending_repaint_is_full()

◆ present_first_frame()

◆ publish_gpu_surface()

◆ pump_x_events()

◆ release_gpu_caches()

◆ repaint()

◆ request_frame()

◆ scale_factor()

◆ set_design_viewport()

◆ set_design_viewport_top_align()

◆ set_factory()

◆ set_fixed_aspect_ratio()

◆ set_idle_callback()

◆ set_native_child_view_bounds()

◆ set_native_child_view_clip()

◆ set_resize_callback()

◆ set_scale_factor()

◆ set_size()

◆ start_file_drag()

◆ try_attach_to_parent()

◆ window_to_root_point()

Friends And Related Symbol Documentation

◆ NativeViewHost

Member Data Documentation

◆ damage_