API リファレンス
検索インデックスを準備中…

ImGui.Begin

  • ウィンドウを開始するか、内容を追加します。

    引数

    name
    string | Uint8Array

    永続 ID と表示タイトルに使うウィンドウ名です。### でタイトルと ID を分離できます。

    p_open
    null | Uint8Array = null

    Uint8Array[0] の開閉状態です。0(閉)か 1(開)のみを書き込みます。 閉じるボタンは 0 を書き込み、null ではボタンを省略します。ネイティブ処理はこのメモリを直接使います。

    flags
    number = 0

    この操作を制御する ImGuiWindowFlags オプションです。互換性のあるフラグは | で組み合わせます。

    戻り値

    boolean

    内容を描く場合は true、折りたたみや完全クリップ時は false です。false でも End() を呼びます。

    • Begin() はウィンドウをスタックに積み、内容の追加を開始します。戻り値が false でも、すべての Begin() に対して End() を呼んでください。

    • false は折りたたみ状態または完全なクリッピングを示します。内容の送信は省略できますが、End() は必要です。一般的な BeginXXX()/EndXXX() の組と異なり、Begin() と BeginChild() は常に対応する終了呼び出しが必要です。

    • p_open に Uint8Array を渡すと閉じるボタンを表示します。先頭要素が開閉状態を保持し、閉じるボタンを押すと p_open[0] に 0 が書き込まれます。null を渡すと閉じるボタンを省略します。アプリケーションはこの状態から次回の Begin() を呼ぶか判断します。

    • 同じフレーム内で複数の Begin()/End() を使い、同じウィンドウに追加できます。flags と p_open は最初の Begin() だけが参照します。

    • ウィンドウスタックの底には常に "Debug" というウィンドウがあります。

    ソースと継承

Icons made by Lorc, Delapouite & Skoll · game-icons.net · CC BY 3.0