Win32 API 日本語リファレンス
ホーム › Graphics.Direct3D12 › D3D12_CLEAR_VALUE

D3D12_CLEAR_VALUE

構造体
📘 Microsoft Learn (日本語) · English
サイズx64: 20 バイト / x86: 20 バイト

サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。

フィールド

フィールド型サイズx64x86説明
FormatDXGI_FORMAT4+0+0

DXGI_FORMAT 列挙型のメンバーを 1 つ指定します。

一般的にクリアされる色のフォーマットは、ビュー / 記述子の作成と同じ検証規則に従います。一般に、クリア色のフォーマットには、リソースのフォーマットが属するのと同じ typeless グループ内の任意のフォーマットを使用できます。

この Format は、クリア操作中に使用されるビューのフォーマットと一致していなければなりません。これは Color と DepthStencil のどちらのメンバーが有効であるか、およびリソースで使用するために値をどのように変換するかを示します。

Anonymous_Anonymous_e__Union16+4+4クリア値の共用体。Colorの4要素配列かDepthStencil値のいずれか。

共用体: _Anonymous_e__Union x64 16B / x86 16B

フィールド型サイズx64x86説明
ColorFLOAT16+0+0RGBA 値を決定する float 値 4 要素の配列を指定します。RGBA の順序は ClearRenderTargetView で使用される順序と一致します。
DepthStencilD3D12_DEPTH_STENCIL_VALUE8+0+0D3D12_DEPTH_STENCIL_VALUE のメンバーを 1 つ指定します。これらの値は、ClearDepthStencilView における Depth および Stencil のセマンティクスと一致します。

公式ドキュメント

特定のリソースに対するクリア操作を最適化するために使用される値を記述します。

解説(Remarks)

この構造体は、次のメソッドに省略可能な引数として渡されます。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での定義

#include <windows.h>

// D3D12_CLEAR_VALUE  (x64 20 / x86 20 バイト)
typedef struct D3D12_CLEAR_VALUE {
    DXGI_FORMAT Format;
    _Anonymous_e__Union Anonymous;
} D3D12_CLEAR_VALUE;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct D3D12_CLEAR_VALUE
{
    public int Format;
    public _Anonymous_e__Union Anonymous;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure D3D12_CLEAR_VALUE
    Public Format As Integer
    Public Anonymous As _Anonymous_e__Union
End Structure
import ctypes
from ctypes import wintypes

class D3D12_CLEAR_VALUE(ctypes.Structure):
    _fields_ = [
        ("Format", ctypes.c_int),
        ("Anonymous", _Anonymous_e__Union),
    ]
#[repr(C)]
pub struct D3D12_CLEAR_VALUE {
    pub Format: i32,
    pub Anonymous: _Anonymous_e__Union,
}
import "golang.org/x/sys/windows"

type D3D12_CLEAR_VALUE struct {
	Format int32
	Anonymous _Anonymous_e__Union
}
type
  D3D12_CLEAR_VALUE = record
    Format: Integer;
    Anonymous: _Anonymous_e__Union;
  end;
const D3D12_CLEAR_VALUE = extern struct {
    Format: i32,
    Anonymous: _Anonymous_e__Union,
};
type
  D3D12_CLEAR_VALUE {.bycopy.} = object
    Format: int32
    Anonymous: _Anonymous_e__Union
struct D3D12_CLEAR_VALUE
{
    int Format;
    _Anonymous_e__Union Anonymous;
}

HSP用 定義

HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; D3D12_CLEAR_VALUE サイズ: 20 バイト(x64)
dim st, 5    ; 4byte整数×5(構造体サイズ 20 / 4 切り上げ)
; Format : DXGI_FORMAT (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; Anonymous : _Anonymous_e__Union (+4, 16byte)  varptr(st)+4 を基点に操作(16byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global D3D12_CLEAR_VALUE
    #field int Format
    #field byte Anonymous 16
#endstruct

stdim st, D3D12_CLEAR_VALUE        ; NSTRUCT 変数を確保
st->Format = 100
mes "Format=" + st->Format
; ※union フィールドは byte 列で確保(NSTRUCT は union 非対応)。必要に応じ手動でアクセス。