IGraphics

Plugin GUI

Members

Functions

closeUI
void closeUI()

Close that UI.

getDesiredGUISize
void getDesiredGUISize(int* widthLogicalPixels, int* heightLogicalPixels)

Get the desired plugin UI size in logical pixels. Basically while a plugin is resized, its desired UI size might not match the "current" plugin size. We makes this super rare, and only to fix resize problems. Typically used when the host want to resize a window itself. FUTURE: deemphasize getGUISize vs getDesiredGUISize.

getGUISize
void getGUISize(int* widthLogicalPixels, int* heightLogicalPixels)

Get the current plugin UI size in logical pixels.

getMaxSmallerValidSize
void getMaxSmallerValidSize(int* inoutWidth, int* inoutHeight)

Used by CLAP and VST3.

getNearestValidSize
void getNearestValidSize(int* inoutWidth, int* inoutHeight)

Used by VST3.

getPreservedAspectRatio
int[2] getPreservedAspectRatio()

Used by CLAP. Only makes sense if isAspectRatioPreserved returned true, else it's UB.

isAspectRatioPreserved
bool isAspectRatioPreserved()

Used by CLAP.

isResizeable
bool isResizeable()

Used by CLAP and VST3.

isResizeableHorizontally
bool isResizeableHorizontally()

Used by CLAP.

isResizeableVertically
bool isResizeableVertically()
Undocumented in source.
nativeWindowResize
bool nativeWindowResize(int newWidthLogicalPixels, int newHeightLogicalPixels)

Used by CLAP and VST3. Tells the native window to resize itself. Called by the host when it's one resizing the parent window, and wants our window to follow suit. This is to be forwarded to IWindow.

openUI
void* openUI(void* parentInfo, void* controlInfo, IClient client, GraphicsBackend backend)

Create an UI, return a system-specific handle for the window/view

Meta