ags_vst_iplug_view.h File Reference

#include <glib.h>
#include <ags/vst3-capi/pluginterfaces/base/ags_vst_funknown.h>

Include dependency graph for ags_vst_iplug_view.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	AGS_VST_IPLUG_VIEW_IID   (ags_vst_iplug_view_get_iid())

Typedefs
typedef struct ViewRect	AgsVstViewRect
typedef struct IPlugView	AgsVstIPlugView
typedef struct IPlugFrame	AgsVstIPlugFrame
typedef struct IEventHandler	AgsVstIEventHandler
typedef struct ITimerHandler	AgsVstITimerHandler
typedef struct IRunLoop	AgsVstIRunLoop

Functions
AgsVstViewRect *	ags_vst_view_rect_alloc ()
gint32	ags_vst_view_rect_get_width (AgsVstViewRect *view_rect)
gint32	ags_vst_view_rect_get_height (AgsVstViewRect *view_rect)
AgsVstTUID *	ags_vst_iplug_view_get_iid ()
AgsVstTResult	ags_vst_iplug_view_attached (AgsVstIPlugView *iplug_view, void *parent, AgsVstFIDString type)
AgsVstTResult	ags_vst_iplug_view_removed (AgsVstIPlugView *iplug_view)
AgsVstTResult	ags_vst_iplug_view_on_wheel (AgsVstIPlugView *iplug_view, gfloat distance)
AgsVstTResult	ags_vst_iplug_view_on_key_down (AgsVstIPlugView *iplug_view, gunichar2 key, gint16 key_code, gint16 modifiers)
AgsVstTResult	ags_vst_iplug_view_on_key_up (AgsVstIPlugView *iplug_view, gunichar2 key, gint16 key_code, gint16 modifiers)
AgsVstTResult	ags_vst_iplug_view_get_size (AgsVstIPlugView *iplug_view, AgsVstViewRect *current_size)
AgsVstTResult	ags_vst_iplug_view_on_size (AgsVstIPlugView *iplug_view, AgsVstViewRect *new_size)
AgsVstTResult	ags_vst_iplug_view_on_focus (AgsVstIPlugView *iplug_view, gboolean state)
AgsVstTResult	ags_vst_iplug_view_set_frame (AgsVstIPlugView *iplug_view, AgsVstIPlugFrame *frame)
AgsVstTResult	ags_vst_iplug_view_can_resize (AgsVstIPlugView *iplug_view)
AgsVstTResult	ags_vst_iplug_view_check_size_constraint (AgsVstIPlugView *iplug_view, AgsVstViewRect *rect)

Variables
const AgsVstFIDString	ags_vst_kplatform_type_hwnd
const AgsVstFIDString	ags_vst_kplatform_type_hi_view
const AgsVstFIDString	ags_vst_kplatform_type_ns_view
const AgsVstFIDString	ags_vst_kplatform_type_ui_view
const AgsVstFIDString	ags_vst_kplatform_type_x11_embed_window_id

Macro Definition Documentation

AGS_VST_IPLUG_VIEW_IID

#define AGS_VST_IPLUG_VIEW_IID   (ags_vst_iplug_view_get_iid())

Typedef Documentation

AgsVstIEventHandler

typedef struct IEventHandler AgsVstIEventHandler

AgsVstIPlugFrame

typedef struct IPlugFrame AgsVstIPlugFrame

AgsVstIPlugView

typedef struct IPlugView AgsVstIPlugView

AgsVstIRunLoop

typedef struct IRunLoop AgsVstIRunLoop

AgsVstITimerHandler

typedef struct ITimerHandler AgsVstITimerHandler

AgsVstViewRect

typedef struct ViewRect AgsVstViewRect

Function Documentation

ags_vst_iplug_view_attached()

AgsVstTResult ags_vst_iplug_view_attached	(	AgsVstIPlugView *	iplug_view,
		void *	parent,
		AgsVstFIDString	type
	)

Attached.

Parameters

iplug_view	the plug view
parent	the parent @type the type

Returns

the return value

Since

5.0.0

ags_vst_iplug_view_can_resize()

AgsVstTResult ags_vst_iplug_view_can_resize

(

AgsVstIPlugView *

iplug_view

)

Can resize.

Parameters

iplug_view

the plug view

Returns

the return value

Since

5.0.0

ags_vst_iplug_view_check_size_constraint()

AgsVstTResult ags_vst_iplug_view_check_size_constraint	(	AgsVstIPlugView *	iplug_view,
		AgsVstViewRect *	rect
	)

Check size constraint.

Parameters

iplug_view	the plug view
rect	the rect

Returns

the return value

Since

5.0.0

ags_vst_iplug_view_get_iid()

AgsVstTUID * ags_vst_iplug_view_get_iid

(

)

Get IID.

Returns

the Steinberg::TUID as AgsVstTUID

Since

5.0.0

ags_vst_iplug_view_get_size()

AgsVstTResult ags_vst_iplug_view_get_size	(	AgsVstIPlugView *	iplug_view,
		AgsVstViewRect *	current_size
	)

Get size.

Parameters

iplug_view	the plug view
current_size	the current size

Returns

the return value

Since

5.0.0

ags_vst_iplug_view_on_focus()

AgsVstTResult ags_vst_iplug_view_on_focus	(	AgsVstIPlugView *	iplug_view,
		gboolean	state
	)

On-focus.

Parameters

iplug_view	the plug view
state	the state

Returns

the return value

Since

5.0.0

ags_vst_iplug_view_on_key_down()

AgsVstTResult ags_vst_iplug_view_on_key_down	(	AgsVstIPlugView *	iplug_view,
		gunichar2	key,
		gint16	key_code,
		gint16	modifiers
	)

On-key-down.

Parameters

iplug_view	the plug view
key	the key
key_code	the key code
modifiers	the modifiers

Returns

the return value

Since

5.0.0

ags_vst_iplug_view_on_key_up()

AgsVstTResult ags_vst_iplug_view_on_key_up	(	AgsVstIPlugView *	iplug_view,
		gunichar2	key,
		gint16	key_code,
		gint16	modifiers
	)

On-key-up.

Parameters

iplug_view	the plug view
key	the key
key_code	the key code
modifiers	the modifiers

Returns

the return value

Since

5.0.0

ags_vst_iplug_view_on_size()

AgsVstTResult ags_vst_iplug_view_on_size	(	AgsVstIPlugView *	iplug_view,
		AgsVstViewRect *	new_size
	)

On-size.

Parameters

iplug_view	the plug view
new_size	the new size

Returns

the return value

Since

5.0.0

ags_vst_iplug_view_on_wheel()

AgsVstTResult ags_vst_iplug_view_on_wheel	(	AgsVstIPlugView *	iplug_view,
		gfloat	distance
	)

On-wheel.

Parameters

iplug_view	the plug view
distance	the distance

Returns

the return value

Since

5.0.0

ags_vst_iplug_view_removed()

AgsVstTResult ags_vst_iplug_view_removed

(

AgsVstIPlugView *

iplug_view

)

Removed.

Parameters

iplug_view

the plug view

Returns

the return value

Since

5.0.0

ags_vst_iplug_view_set_frame()

AgsVstTResult ags_vst_iplug_view_set_frame	(	AgsVstIPlugView *	iplug_view,
		AgsVstIPlugFrame *	frame
	)

Set frame.

Parameters

iplug_view	the plug view
frame	the frame

Returns

the return value

Since

5.0.0

ags_vst_view_rect_alloc()

AgsVstViewRect * ags_vst_view_rect_alloc

(

)

Allocate rect.

Returns

the new instance of Steinberg::ViewRect as AgsVstViewRect pointer

Since

5.0.0

ags_vst_view_rect_get_height()

gint32 ags_vst_view_rect_get_height

(

AgsVstViewRect *

view_rect

)

Get height.

Parameters

view_rect

the rect

Returns

the height

Since

5.0.0

ags_vst_view_rect_get_width()

gint32 ags_vst_view_rect_get_width

(

AgsVstViewRect *

view_rect

)

Get width.

Parameters

view_rect

the rect

Returns

the width

Since

5.0.0

Variable Documentation

ags_vst_kplatform_type_hi_view

const AgsVstFIDString ags_vst_kplatform_type_hi_view

extern

ags_vst_kplatform_type_hwnd

const AgsVstFIDString ags_vst_kplatform_type_hwnd

extern

ags_vst_kplatform_type_ns_view

const AgsVstFIDString ags_vst_kplatform_type_ns_view

extern

ags_vst_kplatform_type_ui_view

const AgsVstFIDString ags_vst_kplatform_type_ui_view

extern

ags_vst_kplatform_type_x11_embed_window_id

const AgsVstFIDString ags_vst_kplatform_type_x11_embed_window_id

extern