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

D3DPRESENT_PARAMETERS

構造体
サイズx64: 64 バイト / x86: 56 バイト

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

フィールド

フィールドサイズx64x86説明
BackBufferWidthDWORD4+0+0バックバッファの幅(ピクセル単位)。0は自動取得。
BackBufferHeightDWORD4+4+4バックバッファの高さ(ピクセル単位)。0は自動取得。
BackBufferFormatD3DFORMAT4+8+8バックバッファのピクセル形式を示すD3DFORMAT。
BackBufferCountDWORD4+12+12バックバッファの枚数。0は1とみなされる。
MultiSampleTypeD3DMULTISAMPLE_TYPE4+16+16マルチサンプリングの種別を示すD3DMULTISAMPLE_TYPE。
MultiSampleQualityDWORD4+20+20マルチサンプリングの品質レベル。
SwapEffectD3DSWAPEFFECT4+24+24スワップ方式を示すD3DSWAPEFFECT(Discard等)。
hDeviceWindowHWND8/4+32+28描画先となるデバイスウィンドウのハンドル。
WindowedBOOL4+40+32ウィンドウモードならTRUE、フルスクリーンならFALSE。
EnableAutoDepthStencilBOOL4+44+36深度ステンシルの自動管理を有効にするBOOL。
AutoDepthStencilFormatD3DFORMAT4+48+40自動深度ステンシルの形式を示すD3DFORMAT。
FlagsDWORD4+52+44プレゼンテーション動作を制御するフラグ群。
FullScreen_RefreshRateInHzDWORD4+56+48フルスクリーン時のリフレッシュレート(Hz)。ウィンドウ時は0。
PresentationIntervalDWORD4+60+52Presentの同期間隔(VSync制御)を示す値。

公式ドキュメント

プレゼンテーション パラメーターを記述します。

解説(Remarks)

BackBufferWidth

Type: UINT

新しいスワップ チェーンのバック バッファーの幅 (ピクセル単位)。WindowedFALSE の場合 (プレゼンテーションが全画面表示の場合)、この値は EnumAdapterModes によって列挙されるディスプレイ モードのいずれかの幅と等しくなければなりません。WindowedTRUE で、BackBufferWidth または BackBufferHeight のいずれかが 0 の場合、hDeviceWindow (hDeviceWindowNULL の場合はフォーカス ウィンドウ) のクライアント領域の対応する寸法が使用されます。

BackBufferHeight

Type: UINT

新しいスワップ チェーンのバック バッファーの高さ (ピクセル単位)。WindowedFALSE の場合 (プレゼンテーションが全画面表示の場合)、この値は EnumAdapterModes によって列挙されるディスプレイ モードのいずれかの高さと等しくなければなりません。WindowedTRUE で、BackBufferWidth または BackBufferHeight のいずれかが 0 の場合、hDeviceWindow (hDeviceWindowNULL の場合はフォーカス ウィンドウ) のクライアント領域の対応する寸法が使用されます。

BackBufferFormat

Type: D3DFORMAT

バック バッファーの形式です。形式の詳細については、D3DFORMAT を参照してください。この値は、CheckDeviceType によって検証されるレンダー ターゲット形式のいずれかでなければなりません。現在の形式は GetDisplayMode を使用して取得できます。

実際には、ウィンドウ モードの間は BackBufferFormatD3DFMT_UNKNOWN を指定できます。これは、現在のディスプレイ モードの形式を使用するようランタイムに指示するもので、GetDisplayMode を呼び出す必要がなくなります。

ウィンドウ表示のアプリケーションでは、(ハードウェアが色変換をサポートしていれば) 色変換をハードウェアで実行できるようになったため、バック バッファー形式をディスプレイ モードの形式と一致させる必要はなくなりました。使用できるバック バッファー形式の集合には制約がありますが、ランタイムは、有効な任意のバック バッファー形式を任意のデスクトップ形式へ表示することを許可します。(加えて、デバイスがそのデスクトップ環境で動作可能であるという要件があります。通常、デバイスは 8 ビット/ピクセルのモードでは動作しません。)

全画面表示のアプリケーションでは色変換を行えません。

BackBufferCount

Type: UINT

この値には 0 から D3DPRESENT_BACK_BUFFERS_MAX (Direct3D 9Ex 使用時は D3DPRESENT_BACK_BUFFERS_MAX_EX) までの値を指定できます。0 は 1 として扱われます。指定した数のバック バッファーを作成できない場合、ランタイムはメソッド呼び出しを失敗させ、この値に作成できたバック バッファーの数を設定します。その結果、アプリケーションは同じ D3DPRESENT_PARAMETERS 構造体を使ってメソッドを 2 回呼び出し、2 回目には成功することを期待できます。

バック バッファーを 1 つも作成できない場合、このメソッドは失敗します。BackBufferCount の値は、許可されるスワップ効果の集合に影響します。具体的には、D3DSWAPEFFECT_COPY スワップ効果では、バック バッファーがちょうど 1 つ存在しなければなりません。

MultiSampleType

Type: D3DMULTISAMPLE_TYPE

D3DMULTISAMPLE_TYPE 列挙型のメンバーです。SwapEffectD3DSWAPEFFECT_DISCARD が設定されている場合を除き、この値は D3DMULTISAMPLE_NONE でなければなりません。マルチサンプリングは、スワップ効果が D3DSWAPEFFECT_DISCARD の場合にのみサポートされます。

MultiSampleQuality

Type: DWORD

品質レベルです。有効範囲は、0 から、CheckDeviceMultiSampleType で使用される pQualityLevels が返すレベルより 1 小さい値までです。これより大きい値を渡すと、エラー D3DERR_INVALIDCALL が返されます。対になるレンダー ターゲットどうし、または深度ステンシル サーフェイスどうしでは、この値と D3DMULTISAMPLE_TYPE が一致していなければなりません。

SwapEffect

Type: D3DSWAPEFFECT

D3DSWAPEFFECT 列挙型のメンバーです。ランタイムは、バッファー スワップ動作に関して暗黙に意味されるセマンティクスを保証します。したがって、WindowedTRUESwapEffectD3DSWAPEFFECT_FLIP が設定されている場合、ランタイムは追加のバック バッファーを 1 つ作成し、プレゼンテーション時にフロント バッファーになるバッファーをコピーします。

D3DSWAPEFFECT_COPY では、BackBufferCount を 1 に設定する必要があります。

D3DSWAPEFFECT_DISCARD は、デバッグ ランタイムでは、表示後のバッファーをノイズで埋めることによって強制されます。

Direct3D9 と Direct3D9Ex の違い:

  • Direct3D9Ex では、アプリケーションがフリップ モードを採用していることを示すために D3DSWAPEFFECT_FLIPEX が追加されました。フリップ モードでは、ウィンドウ モードにおいて、アプリケーションのフレームが (コピーされるのではなく) 合成のためにデスクトップ ウィンドウ マネージャー (DWM) へ渡されます。フリップ モードはメモリ帯域幅の使用効率を高め、アプリケーションが全画面プレゼンテーションの統計情報を利用できるようにします。全画面表示の動作は変更されません。フリップ モードの動作は Windows 7 以降で利用できます。

hDeviceWindow

Type: HWND

デバイス ウィンドウは、画面上でのバック バッファーの位置とサイズを決定します。これは、Present の際にバック バッファーの内容をフロント バッファーへコピーするときに Direct3D によって使用されます。

  • 全画面表示のアプリケーションの場合、これは最上位ウィンドウ (フォーカス ウィンドウ) のハンドルです。

    複数の全画面デバイスを使用するアプリケーション (マルチモニター システムなど) では、フォーカス ウィンドウをデバイス ウィンドウとして使用できるデバイスはちょうど 1 つだけです。他のすべてのデバイスは、それぞれ固有のデバイス ウィンドウを持たなければなりません。

  • ウィンドウ モードのアプリケーションの場合、このハンドルは Present の既定のターゲット ウィンドウになります。このハンドルが NULL の場合は、フォーカス ウィンドウが使用されます。

ランタイムは、ユーザーによるウィンドウ サイズの変更を反映しようとはしない点に注意してください。このウィンドウがリセットされても、バック バッファーが暗黙的にリセットされることはありません。ただし、Present メソッドはウィンドウ位置の変化を自動的に追跡します。

Windowed

Type: BOOL

アプリケーションをウィンドウ モードで実行する場合は TRUE、全画面表示で実行する場合は FALSE です。

EnableAutoDepthStencil

Type: BOOL

この値が TRUE の場合、Direct3D はアプリケーションに代わって深度バッファーを管理します。デバイスの作成時に深度ステンシル バッファーが作成されます。この深度ステンシル バッファーは、自動的にデバイスのレンダー ターゲットとして設定されます。デバイスがリセットされると、深度ステンシル バッファーは自動的に破棄され、新しいサイズで再作成されます。

EnableAutoDepthStencil が TRUE の場合、AutoDepthStencilFormat は有効な深度ステンシル形式でなければなりません。

AutoDepthStencilFormat

Type: D3DFORMAT

D3DFORMAT 列挙型のメンバーです。デバイスが作成する自動深度ステンシル サーフェイスの形式です。このメンバーは、EnableAutoDepthStencilTRUE の場合を除き無視されます。

Flags

Type: DWORD

D3DPRESENTFLAG 定数のいずれかです。

FullScreen_RefreshRateInHz

Type: UINT

ディスプレイ アダプターが画面を更新するレートです。この値は、アプリケーションが実行されているモードによって異なります:

  • ウィンドウ モードの場合、リフレッシュ レートは 0 でなければなりません。
  • 全画面モードの場合、リフレッシュ レートは EnumAdapterModes が返すリフレッシュ レートのいずれかです。

PresentationInterval

Type: UINT

スワップ チェーンのバック バッファーをフロント バッファーへ表示できる最大レートです。サポートされるモードと間隔の詳細については、D3DPRESENT を参照してください。

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

各言語での定義

#include <windows.h>

// D3DPRESENT_PARAMETERS  (x64 64 / x86 56 バイト)
typedef struct D3DPRESENT_PARAMETERS {
    DWORD BackBufferWidth;
    DWORD BackBufferHeight;
    D3DFORMAT BackBufferFormat;
    DWORD BackBufferCount;
    D3DMULTISAMPLE_TYPE MultiSampleType;
    DWORD MultiSampleQuality;
    D3DSWAPEFFECT SwapEffect;
    HWND hDeviceWindow;
    BOOL Windowed;
    BOOL EnableAutoDepthStencil;
    D3DFORMAT AutoDepthStencilFormat;
    DWORD Flags;
    DWORD FullScreen_RefreshRateInHz;
    DWORD PresentationInterval;
} D3DPRESENT_PARAMETERS;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct D3DPRESENT_PARAMETERS
{
    public uint BackBufferWidth;
    public uint BackBufferHeight;
    public uint BackBufferFormat;
    public uint BackBufferCount;
    public int MultiSampleType;
    public uint MultiSampleQuality;
    public int SwapEffect;
    public IntPtr hDeviceWindow;
    [MarshalAs(UnmanagedType.Bool)] public bool Windowed;
    [MarshalAs(UnmanagedType.Bool)] public bool EnableAutoDepthStencil;
    public uint AutoDepthStencilFormat;
    public uint Flags;
    public uint FullScreen_RefreshRateInHz;
    public uint PresentationInterval;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure D3DPRESENT_PARAMETERS
    Public BackBufferWidth As UInteger
    Public BackBufferHeight As UInteger
    Public BackBufferFormat As UInteger
    Public BackBufferCount As UInteger
    Public MultiSampleType As Integer
    Public MultiSampleQuality As UInteger
    Public SwapEffect As Integer
    Public hDeviceWindow As IntPtr
    <MarshalAs(UnmanagedType.Bool)> Public Windowed As Boolean
    <MarshalAs(UnmanagedType.Bool)> Public EnableAutoDepthStencil As Boolean
    Public AutoDepthStencilFormat As UInteger
    Public Flags As UInteger
    Public FullScreen_RefreshRateInHz As UInteger
    Public PresentationInterval As UInteger
End Structure
import ctypes
from ctypes import wintypes

class D3DPRESENT_PARAMETERS(ctypes.Structure):
    _fields_ = [
        ("BackBufferWidth", wintypes.DWORD),
        ("BackBufferHeight", wintypes.DWORD),
        ("BackBufferFormat", wintypes.DWORD),
        ("BackBufferCount", wintypes.DWORD),
        ("MultiSampleType", ctypes.c_int),
        ("MultiSampleQuality", wintypes.DWORD),
        ("SwapEffect", ctypes.c_int),
        ("hDeviceWindow", ctypes.c_void_p),
        ("Windowed", wintypes.BOOL),
        ("EnableAutoDepthStencil", wintypes.BOOL),
        ("AutoDepthStencilFormat", wintypes.DWORD),
        ("Flags", wintypes.DWORD),
        ("FullScreen_RefreshRateInHz", wintypes.DWORD),
        ("PresentationInterval", wintypes.DWORD),
    ]
#[repr(C)]
pub struct D3DPRESENT_PARAMETERS {
    pub BackBufferWidth: u32,
    pub BackBufferHeight: u32,
    pub BackBufferFormat: u32,
    pub BackBufferCount: u32,
    pub MultiSampleType: i32,
    pub MultiSampleQuality: u32,
    pub SwapEffect: i32,
    pub hDeviceWindow: *mut core::ffi::c_void,
    pub Windowed: i32,
    pub EnableAutoDepthStencil: i32,
    pub AutoDepthStencilFormat: u32,
    pub Flags: u32,
    pub FullScreen_RefreshRateInHz: u32,
    pub PresentationInterval: u32,
}
import "golang.org/x/sys/windows"

type D3DPRESENT_PARAMETERS struct {
	BackBufferWidth uint32
	BackBufferHeight uint32
	BackBufferFormat uint32
	BackBufferCount uint32
	MultiSampleType int32
	MultiSampleQuality uint32
	SwapEffect int32
	hDeviceWindow uintptr
	Windowed int32
	EnableAutoDepthStencil int32
	AutoDepthStencilFormat uint32
	Flags uint32
	FullScreen_RefreshRateInHz uint32
	PresentationInterval uint32
}
type
  D3DPRESENT_PARAMETERS = record
    BackBufferWidth: DWORD;
    BackBufferHeight: DWORD;
    BackBufferFormat: DWORD;
    BackBufferCount: DWORD;
    MultiSampleType: Integer;
    MultiSampleQuality: DWORD;
    SwapEffect: Integer;
    hDeviceWindow: Pointer;
    Windowed: BOOL;
    EnableAutoDepthStencil: BOOL;
    AutoDepthStencilFormat: DWORD;
    Flags: DWORD;
    FullScreen_RefreshRateInHz: DWORD;
    PresentationInterval: DWORD;
  end;
const D3DPRESENT_PARAMETERS = extern struct {
    BackBufferWidth: u32,
    BackBufferHeight: u32,
    BackBufferFormat: u32,
    BackBufferCount: u32,
    MultiSampleType: i32,
    MultiSampleQuality: u32,
    SwapEffect: i32,
    hDeviceWindow: ?*anyopaque,
    Windowed: i32,
    EnableAutoDepthStencil: i32,
    AutoDepthStencilFormat: u32,
    Flags: u32,
    FullScreen_RefreshRateInHz: u32,
    PresentationInterval: u32,
};
type
  D3DPRESENT_PARAMETERS {.bycopy.} = object
    BackBufferWidth: uint32
    BackBufferHeight: uint32
    BackBufferFormat: uint32
    BackBufferCount: uint32
    MultiSampleType: int32
    MultiSampleQuality: uint32
    SwapEffect: int32
    hDeviceWindow: pointer
    Windowed: int32
    EnableAutoDepthStencil: int32
    AutoDepthStencilFormat: uint32
    Flags: uint32
    FullScreen_RefreshRateInHz: uint32
    PresentationInterval: uint32
struct D3DPRESENT_PARAMETERS
{
    uint BackBufferWidth;
    uint BackBufferHeight;
    uint BackBufferFormat;
    uint BackBufferCount;
    int MultiSampleType;
    uint MultiSampleQuality;
    int SwapEffect;
    void* hDeviceWindow;
    int Windowed;
    int EnableAutoDepthStencil;
    uint AutoDepthStencilFormat;
    uint Flags;
    uint FullScreen_RefreshRateInHz;
    uint PresentationInterval;
}

HSP用 定義

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

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; D3DPRESENT_PARAMETERS サイズ: 56 バイト(x86)
dim st, 14    ; 4byte整数×14(構造体サイズ 56 / 4 切り上げ)
; BackBufferWidth : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; BackBufferHeight : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; BackBufferFormat : D3DFORMAT (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; BackBufferCount : DWORD (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; MultiSampleType : D3DMULTISAMPLE_TYPE (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; MultiSampleQuality : DWORD (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; SwapEffect : D3DSWAPEFFECT (+24, 4byte)  st.6 = 値  /  値 = st.6   (lpoke/lpeek も可)
; hDeviceWindow : HWND (+28, 4byte)  st.7 = 値  /  値 = st.7   (lpoke/lpeek も可)
; Windowed : BOOL (+32, 4byte)  st.8 = 値  /  値 = st.8   (lpoke/lpeek も可)
; EnableAutoDepthStencil : BOOL (+36, 4byte)  st.9 = 値  /  値 = st.9   (lpoke/lpeek も可)
; AutoDepthStencilFormat : D3DFORMAT (+40, 4byte)  st.10 = 値  /  値 = st.10   (lpoke/lpeek も可)
; Flags : DWORD (+44, 4byte)  st.11 = 値  /  値 = st.11   (lpoke/lpeek も可)
; FullScreen_RefreshRateInHz : DWORD (+48, 4byte)  st.12 = 値  /  値 = st.12   (lpoke/lpeek も可)
; PresentationInterval : DWORD (+52, 4byte)  st.13 = 値  /  値 = st.13   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; D3DPRESENT_PARAMETERS サイズ: 64 バイト(x64)
dim st, 16    ; 4byte整数×16(構造体サイズ 64 / 4 切り上げ)
; BackBufferWidth : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; BackBufferHeight : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; BackBufferFormat : D3DFORMAT (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; BackBufferCount : DWORD (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; MultiSampleType : D3DMULTISAMPLE_TYPE (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; MultiSampleQuality : DWORD (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; SwapEffect : D3DSWAPEFFECT (+24, 4byte)  st.6 = 値  /  値 = st.6   (lpoke/lpeek も可)
; hDeviceWindow : HWND (+32, 8byte)  qpoke st,32,値 / qpeek(st,32)  ※IronHSPのみ。3.7/3.8は lpoke st,32,下位 : lpoke st,36,上位
; Windowed : BOOL (+40, 4byte)  st.10 = 値  /  値 = st.10   (lpoke/lpeek も可)
; EnableAutoDepthStencil : BOOL (+44, 4byte)  st.11 = 値  /  値 = st.11   (lpoke/lpeek も可)
; AutoDepthStencilFormat : D3DFORMAT (+48, 4byte)  st.12 = 値  /  値 = st.12   (lpoke/lpeek も可)
; Flags : DWORD (+52, 4byte)  st.13 = 値  /  値 = st.13   (lpoke/lpeek も可)
; FullScreen_RefreshRateInHz : DWORD (+56, 4byte)  st.14 = 値  /  値 = st.14   (lpoke/lpeek も可)
; PresentationInterval : DWORD (+60, 4byte)  st.15 = 値  /  値 = st.15   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global D3DPRESENT_PARAMETERS
    #field int BackBufferWidth
    #field int BackBufferHeight
    #field int BackBufferFormat
    #field int BackBufferCount
    #field int MultiSampleType
    #field int MultiSampleQuality
    #field int SwapEffect
    #field intptr hDeviceWindow
    #field bool Windowed
    #field bool EnableAutoDepthStencil
    #field int AutoDepthStencilFormat
    #field int Flags
    #field int FullScreen_RefreshRateInHz
    #field int PresentationInterval
#endstruct

stdim st, D3DPRESENT_PARAMETERS        ; NSTRUCT 変数を確保
st->BackBufferWidth = 100
mes "BackBufferWidth=" + st->BackBufferWidth