Project load: use kOfxChangePluginEdited, not kOfxChangeUserEdited, for the clip instanceChanged

オープン 初心者向け
#294 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
1/5
見積もり時間
1時間未満
初心者へのやさしさ
80/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
c, cpp
領域
documentation

調査の方向性

include/ofxCore.h の L362-L365 付近にある kOfxActionCreateInstance のドキュメントブロックを開き、clip の instanceChanged 理由を kOfxChangePluginEdited に変更してください。issue がすでに一致していると述べている 2 か所を突き合わせて確認してください。同じファイルの L449-L454 にある kOfxActionInstanceChanged のドキュメントと、release-notes-next.md の L25 です。3 つすべてが kOfxChangePluginEdited を示し、docs 内で kOfxChangeUserEdited を grep しても関連するものが見つからなければ完了です。

索引モデルが issue の本文から書いたものです。

説明

Problem

At project load, a plug-in must be able to tell whether a clip connection comes from a user connecting a clip for the first time (when it may change some values) or simply from loading a saved state. With kOfxChangeUserEdited it can't.

Many plug-ins set parameters from an input when the user connects it, on kOfxChangeUserEdited. Examples: setting a filter's premultiplication, or a writer's output premultiplication and frame rate, from the connected input. At project load these values are already restored, so a kOfxChangeUserEdited clip change overwrites them.

Timeline in #184 (implemented by PR #191):

  • 2025-05-06, @fxtech: Silhouette sends kOfxChangePluginEdited.
  • 2025-05-06, @Guido-assim: asked for kOfxChangeUserEdited, which Scratch uses: "the user/host attached the clips".
  • 2025-05-07, @fxtech: argued for kOfxChangePluginEdited, because kOfxChangeUserEdited "implies that the user directly fiddled with something": a preset menu would otherwise trigger again on project load and override values.
  • 2025-05-07, @fxtech: for clips, "I don't think it would matter" which reason.
  • 2025-05-08, @garyo: "let's go with kOfxChangeUserEdited since it's already out there in at least one host. I'll make that update in the PR." That update is ae64194, the same day.
  • 2025-06-03, @fxtech: "I switched Silhouette to pass kOfxChangeUserEdited for clip hookups."

As shown above, and as in @fxtech's preset example, the reason does matter for clips too. The kOfxActionInstanceChanged doc (ofxCore.h L449-L454) and the release notes (release-notes-next.md L25, written later in #254) still say kOfxChangePluginEdited.

Proposal: change the kOfxActionCreateInstance doc (ofxCore.h L364) back to kOfxChangePluginEdited, so all three agree.

主要言語
C++
スター
590
フォーク
160
平均マージ
2日 22時間
マージ済み PR(30日)
3

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

AcademySoftwareFoundation/openfx のほかの issue

AcademySoftwareFoundation/openfx の issue をすべて見る

似ている issue

C++ の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。