JUCE-7.0.12-0-g4f43011b96 JUCE-7.0.12-0-g4f43011b96
JUCE — C++ application framework with suport for VST, VST3, LV2 audio plug-ins

« « « Anklang Documentation
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Attributes | List of all members
Steinberg::IPlugViewContentScaleSupport Class Referenceabstract

Plug-in view content scale support. More...

#include "iplugviewcontentscalesupport.h"

Inheritance diagram for Steinberg::IPlugViewContentScaleSupport:
Steinberg::FUnknown

Public Types

typedef float ScaleFactor
 

Public Member Functions

virtual tresult PLUGIN_API setContentScaleFactor (ScaleFactor factor)=0
 
- Public Member Functions inherited from Steinberg::FUnknown
virtual tresult PLUGIN_API queryInterface (const TUID _iid, void **obj)=0
 Query for a pointer to the specified interface.
 
virtual uint32 PLUGIN_API addRef ()=0
 Adds a reference and returns the new reference count.
 
virtual uint32 PLUGIN_API release ()=0
 Releases a reference and returns the new reference count.
 

Static Public Attributes

static const FUID iid
 
- Static Public Attributes inherited from Steinberg::FUnknown
static const FUID iid
 

Detailed Description

Plug-in view content scale support.

This interface communicates the content scale factor from the host to the plug-in view on systems where plug-ins cannot get this information directly like Microsoft Windows.

The host calls setContentScaleFactor directly before or after the plug-in view is attached and when the scale factor changes while the view is attached (system change or window moved to another screen with different scaling settings).

The host may call setContentScaleFactor in a different context, for example: scaling the plug-in editor for better readability.

When a plug-in handles this (by returning kResultTrue), it needs to scale the width and height of its view by the scale factor and inform the host via a IPlugFrame::resizeView(). The host will then call IPlugView::onSize().

Note that the host is allowed to call setContentScaleFactor() at any time the IPlugView is valid. If this happens before the IPlugFrame object is set on your view, make sure that when the host calls IPlugView::getSize() afterwards you return the size of your view for that new scale factor.

It is recommended to implement this interface on Microsoft Windows to let the host know that the plug-in is able to render in different scalings.

Definition at line 57 of file iplugviewcontentscalesupport.h.

Member Typedef Documentation

◆ ScaleFactor

typedef float Steinberg::IPlugViewContentScaleSupport::ScaleFactor

Definition at line 61 of file iplugviewcontentscalesupport.h.

Member Data Documentation

◆ iid

const FUID Steinberg::IPlugViewContentScaleSupport::iid
static

Definition at line 65 of file iplugviewcontentscalesupport.h.


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