Struct EditHandle 

pub struct EditHandle { /* private fields */ }

Available on crate feature generic only.

編集ハンドル。

Panics

crate::generic::GenericPlugin::registerが終了するまでは、以下のメソッド以外は呼び出せません。

• Self::get_host_app_window
• Self::get_host_app_window_raw
• Self::is_ready

Implementations

impl EditHandle

pub fn is_ready(&self) -> bool

編集ハンドルの初期化が完了しているかどうかを確認します。

pub fn call_edit_section<'a, T, F>( &self, callback: F, ) -> Result<T, EditHandleError>

where T: Send + 'static, F: FnOnce(&mut EditSection) -> T + Send + 'a,

プロジェクトデータの編集を開始する。

Note

内部では call_edit_section_param を使用しています。

pub fn call_read_section<'a, T, F>( &self, callback: F, ) -> Result<T, EditHandleError>

where T: Send + 'static, F: FnOnce(&ReadSection) -> T + Send + 'a,

プロジェクトデータの参照を開始する。

Note

内部では call_read_section_param を使用しています。

pub fn get_edit_info(&self) -> EditInfo

編集情報を取得する。

pub fn restart_host_app(&self)

ホストアプリケーションを再起動する。

pub fn enumerate_effects<F>(&self, callback: F)

where F: FnMut(Effect),

エフェクトの一覧をコールバック関数で取得する。

Note

不明なエフェクト種別があった場合はスキップされます。

pub fn get_effects(&self) -> Vec<Effect>

エフェクトの一覧を取得する。

pub fn enumerate_effect_items<F>( &self, effect: &str, callback: F, ) -> Result<(), EditHandleError>

where F: FnMut(EffectItemInfo),

エフェクトの設定項目一覧をコールバック関数で取得する。

Arguments

• effect: 対象のエフェクト名。エイリアスファイルの effect.name を指定します。

Note

不明な設定項目種別があった場合はスキップされます。

pub fn get_effect_items( &self, effect: &str, ) -> Result<Vec<EffectItemInfo>, EditHandleError>

エフェクトの設定項目一覧を取得する。

Arguments

• effect: 対象のエフェクト名。エイリアスファイルの effect.name を指定します。

pub fn get_effect_item_group_index( &self, effect: &str, item_name: &str, ) -> Result<Option<usize>, EditHandleError>

指定の設定項目が所属するグループ内での所属インデックスを取得する。

pub fn get_effect_item_group_names( &self, effect: &str, item_name: &str, ) -> Result<Option<Vec<String>>, EditHandleError>

指定の設定項目が所属するグループ、または指定したグループの所属アイテム名を取得する。

pub fn enumerate_modules<F>(&self, callback: F)

where F: FnMut(ModuleInfo),

モジュールの一覧をコールバック関数で取得する。

pub fn get_modules(&self) -> Vec<ModuleInfo>

モジュールの一覧を取得する。

pub fn get_host_app_window_raw(&self) -> Option<Win32WindowHandle>

ホストアプリケーションのメインウィンドウのハンドルをraw_window_handle::Win32WindowHandleとして取得する。

pub unsafe fn get_host_app_window(&self) -> Option<WindowHandle<'_>>

ホストアプリケーションのメインウィンドウのハンドルを[raw_window_handle::WindowHandle]として取得する。

Safety

[raw_window_handle::WindowHandle::borrow_raw] を参照してください。

pub fn get_edit_state(&self) -> Result<EditState, EditHandleError>

編集状態を取得する。

pub fn rendering_scene_video<F>( &self, frame: u32, callback: F, ) -> Result<(), EditHandleError>

where F: FnMut(RenderingSceneVideo<'_>) + Send + 'static,

現在のシーンの映像レンダリングを要求する。

この関数はレンダリングタスクの追加のみを行います。レンダリング完了時に コールバックがイベント通知スレッドから呼ばれます。

pub fn rendering_scene_audio<F>( &self, frame: u32, callback: F, ) -> Result<(), EditHandleError>

where F: FnMut(RenderingSceneAudio<'_>) + Send + 'static,

現在のシーンの音声レンダリングを要求する。

この関数はレンダリングタスクの追加のみを行います。レンダリング完了時に コールバックがイベント通知スレッドから呼ばれます。

pub fn rendering_object_video<F>( &self, object: ObjectHandle, frame: u32, apply_effect: bool, callback: F, ) -> Result<(), EditHandleError>

where F: FnMut(RenderingSceneVideo<'_>) + Send + 'static,

指定のオブジェクトの映像のレンダリングを要求する。

レンダリング完了時はイベント通知スレッドからコールバックが呼ばれます。

Arguments

• object：レンダリング対象のオブジェクト。
• frame：レンダリング対象のフレーム番号。
• apply_effect：レンダリング時にエフェクトを適用するかどうか。
• callback：レンダリング完了時に呼ばれるコールバック関数。

pub fn rendering_object_audio<F>( &self, object: ObjectHandle, frame: u32, apply_effect: bool, callback: F, ) -> Result<(), EditHandleError>

where F: FnMut(RenderingSceneAudio<'_>) + Send + 'static,

指定のオブジェクトの音声のレンダリングを要求する。

レンダリング完了時はイベント通知スレッドからコールバックが呼ばれます。

Arguments

• object：レンダリング対象のオブジェクト。
• frame：レンダリング対象のフレーム番号。
• apply_effect：レンダリング時にエフェクトを適用するかどうか。
• callback：レンダリング完了時に呼ばれるコールバック関数。

pub fn wait_rendering_task(&self)

レンダリング中のタスクが全て完了するまで待機する。

Note

この関数をSelf::call_read_sectionやSelf::call_edit_sectionのコールバック内で呼び出すとデッドロックする可能性があります。

pub fn enumerate_font_names<F>(&self, callback: F)

where F: FnMut(String),

フォント名の一覧をコールバック関数で取得する。

pub fn get_font_names(&self) -> Vec<String>

フォント名の一覧を取得する。

pub fn enumerate_palette_names<F>(&self, callback: F)

where F: FnMut(String),

パレット名の一覧をコールバック関数で取得する。

pub fn get_palette_names(&self) -> Vec<String>

パレット名の一覧を取得する。

Trait Implementations

impl Debug for EditHandle

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Send for EditHandle

impl Sync for EditHandle