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

ImGui.BeginChild

  • 独立したスクロールとクリッピング領域を持つ子ウィンドウを開始します。

    引数

    str_id
    string | Uint8Array

    現在の ID スタックと組み合わせて項目やスコープを識別する文字列です。

    size

    子ウィンドウのピクセル幅・高さです。0 は残り全体、正は固定、負は残りから絶対値分を引きます。

    child_flags
    number = 0

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

    window_flags
    number = 0

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

    戻り値

    boolean

    子の内容を描く場合は true、完全クリップや折りたたみ時は false です。false でも EndChild()、旧 frame 版なら EndChildFrame() を呼びます。

    子ウィンドウは親ウィンドウ内に独立したスクロールとクリッピング領域を設け、さらに子ウィンドウを入れ子にできます。

    • サイズは軸ごとに指定できます。0 は親の残り領域、正の値は指定サイズ、負の値は利用可能領域の右端または下端からの余白を表します。

    • ImGuiChildFlags.AutoResizeX と ImGuiChildFlags.AutoResizeY は内容から対応する軸のサイズを決めます。スクロール領域では両方の同時使用は推奨されません。

    • BeginChild() が false を返しても、必ず EndChild() を呼んでください。false は折りたたみ状態または完全なクリッピングを示し、内容を省略できます。これは Begin()/End() と同じですが、開始時に true が返った場合だけ終了する一般的な組とは異なります。

    • 1.90(2023 年 11 月)以降、従来のブール型の枠線引数は子ウィンドウフラグになりました。枠線なしは 0 または ImGuiChildFlags.None、枠線ありは ImGuiChildFlags.Borders を使います。互換性のため枠線フラグの数値は 1 のままです。

    ソースと継承

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