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

VIDEOMEMORY

構造体
サイズx64: 40 バイト / x86: 24 バイト

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

フィールド

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

ディスプレイメモリのこの特定のセクションを記述するフラグのセットを指定します。このメンバーには、次の値のビット単位の OR を指定できます。

フラグ 意味
VIDMEM_ISLINEAR ディスプレイメモリは連続したメモリブロックです。
VIDMEM_ISRECTANGULAR ディスプレイメモリは矩形です。
VIDMEM_ISHEAP このフラグはシステム用に予約済みであり、ドライバーは無視してください。
VIDMEM_ISNONLOCAL ヒープは非ローカル (AGP) メモリ上に存在します。
VIDMEM_ISWC ドライバーは、このヒープ内のディスプレイメモリに対してライトコンバイン (write-combining) を有効にしています。ライトコンバインは Pentium Pro クラスのプロセッサーにおける特殊なキャッシュモードで、同一のキャッシュラインへの書き込みをまとめ、1 回のバスクロックで転送できるようにします。ライトコンバインは書き込みの順序を保持しませんが、これはフレームバッファーでは通常許容できるトレードオフです。ライトコンバインの詳細については、Intel のドキュメントを参照してください。このフラグは、VIDMEM_ISNONLOCAL フラグも設定されている場合にのみ使用できます。
VIDMEM_HEAPDISABLED Microsoft DirectDraw ランタイムは、ヒープの初期化に失敗したときにそのヒープを無効にするためにこのフラグを使用します。これは AGP ヒープで発生する可能性が最も高いものです。ドライバーはこのビットを設定しないでください。
fpStartUINT_PTR8/4+8+4ヒープ内のメモリ範囲の開始アドレスを指します。
Anonymous1_Anonymous1_e__Union8/4+16+8終端アドレスまたはブロックサイズを保持する無名共用体。
ddsCapsDDSCAPS4+24+12このメモリセクションを使用できない機能をドライバーが返す DDSCAPS 構造体を指定します。
ddsCapsAltDDSCAPS4+28+16最初のパスで他のメモリが見つからなかった場合に、このメモリチャンクを使用できない機能をドライバーが返す DDSCAPS 構造体を指定します。
Anonymous2_Anonymous2_e__Union8/4+32+20ヒープ管理用の追加情報を保持する無名共用体。

共用体: _Anonymous1_e__Union x64 8B / x86 4B

フィールドサイズx64x86説明
fpEndUINT_PTR8/4+0+0ヒープが線形である場合に、メモリ範囲の終了アドレスを指します。このアドレスは範囲に含まれます。つまり、範囲内の最後の有効なアドレスを指定します。したがって、fpStartfpEnd によって指定されるバイト数は (fpEnd - fpStart + 1) となります。
dwWidthDWORD4+0+0fpStart が指すメモリセクションの幅をバイト単位で指定します。このメンバーは、矩形のメモリ領域を記述する場合にのみ使用してください。

共用体: _Anonymous2_e__Union x64 8B / x86 4B

フィールドサイズx64x86説明
lpHeapVMEMHEAP*8/4+0+0システム用に予約済みであり、ドライバーは無視してください。
dwHeightDWORD4+0+0fpStart が指すメモリチャンクの高さを指定します。このメンバーは、矩形のメモリ領域を記述する場合にのみ使用してください。

公式ドキュメント

VIDEOMEMORY 構造体を使用すると、ドライバーは自身のディスプレイメモリをヒープに分けて管理できます。

解説(Remarks)

Microsoft Windows 2000 以降ではこのデータ構造は VIDEOMEMORY と呼ばれ、Windows 98/Me では VIDMEM と呼ばれます。

GDI は、VIDEOMEMORY 構造体の配列を割り当て、ドライバーの DrvGetDirectDrawInfo 関数への 2 回目の呼び出しに渡します。ドライバーは、メモリの各セクションを記述するために、各構造体の該当するメンバーを設定する必要があります。このリストによって、ドライバーのオフスクリーンメモリが完全に記述されます。

DirectDraw は、ディスプレイメモリのヒープが列挙されている順にスキャンしてサーフェスを割り当てます。ヒープは VIDEOMEMORY 構造体の配列で管理されます。最初に割り当てられたメモリが、最初にアクセスされるメモリになります。VIDEOMEMORY 構造体は特定の開始位置を設定し、サーフェス上のメモリ量と、そのサーフェスで実行できない処理を決定します。DirectDraw は、メモリのサブアロケーションと解放、すなわち各ヒープの管理下でのサーフェスの作成と破棄によってこれを管理します。これらの属性をどのように設定するかは、物理的な制限によって決まります。

DirectDraw のヒープマネージャーは、VIDEOMEMORY 構造体に対して 2 回のパスを行います。ddsCaps メンバーは、最初のパスにおいてそのヒープ内のメモリを何に使用できないかを DirectDraw に示します。たとえば、ヒープがバックバッファーにちょうど収まる大きさしかない場合、DDSCAPS 構造体に DSCAPS_OFFSCREENPLAIN フラグを設定することで、最初のパスでスプライトが割り当てられないように除外できます。こうすると、ページフリッピング用にバックバッファーを確保したまま、他のサーフェスがスプライトで埋められます。ddsCapsAlt メンバーを設定して (DSCAPS_OFFSCREENPLAIN フラグを外して)、2 回目のパスではスプライトを許可することもできます。これにより、代替用途を排除することなく、ヒープを最も適した用途に優先的に使用できます。割り当ての順序を慎重に選択することで (たとえばバックバッファーを最後に列挙するなど)、ddsCapsddsCapsAlt による振り分けが不要になる場合もあります。

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

各言語での定義

#include <windows.h>

// DDSCAPS  (x64 4 / x86 4 バイト)
typedef struct DDSCAPS {
    DWORD dwCaps;
} DDSCAPS;

// VIDEOMEMORY  (x64 40 / x86 24 バイト)
typedef struct VIDEOMEMORY {
    DWORD dwFlags;
    UINT_PTR fpStart;
    _Anonymous1_e__Union Anonymous1;
    DDSCAPS ddsCaps;
    DDSCAPS ddsCapsAlt;
    _Anonymous2_e__Union Anonymous2;
} VIDEOMEMORY;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct DDSCAPS
{
    public uint dwCaps;
}

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct VIDEOMEMORY
{
    public uint dwFlags;
    public UIntPtr fpStart;
    public _Anonymous1_e__Union Anonymous1;
    public DDSCAPS ddsCaps;
    public DDSCAPS ddsCapsAlt;
    public _Anonymous2_e__Union Anonymous2;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure DDSCAPS
    Public dwCaps As UInteger
End Structure

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure VIDEOMEMORY
    Public dwFlags As UInteger
    Public fpStart As UIntPtr
    Public Anonymous1 As _Anonymous1_e__Union
    Public ddsCaps As DDSCAPS
    Public ddsCapsAlt As DDSCAPS
    Public Anonymous2 As _Anonymous2_e__Union
End Structure
import ctypes
from ctypes import wintypes

class DDSCAPS(ctypes.Structure):
    _fields_ = [
        ("dwCaps", wintypes.DWORD),
    ]

class VIDEOMEMORY(ctypes.Structure):
    _fields_ = [
        ("dwFlags", wintypes.DWORD),
        ("fpStart", ctypes.c_size_t),
        ("Anonymous1", _Anonymous1_e__Union),
        ("ddsCaps", DDSCAPS),
        ("ddsCapsAlt", DDSCAPS),
        ("Anonymous2", _Anonymous2_e__Union),
    ]
#[repr(C)]
pub struct DDSCAPS {
    pub dwCaps: u32,
}

#[repr(C)]
pub struct VIDEOMEMORY {
    pub dwFlags: u32,
    pub fpStart: usize,
    pub Anonymous1: _Anonymous1_e__Union,
    pub ddsCaps: DDSCAPS,
    pub ddsCapsAlt: DDSCAPS,
    pub Anonymous2: _Anonymous2_e__Union,
}
import "golang.org/x/sys/windows"

type DDSCAPS struct {
	dwCaps uint32
}

type VIDEOMEMORY struct {
	dwFlags uint32
	fpStart uintptr
	Anonymous1 _Anonymous1_e__Union
	ddsCaps DDSCAPS
	ddsCapsAlt DDSCAPS
	Anonymous2 _Anonymous2_e__Union
}
type
  DDSCAPS = record
    dwCaps: DWORD;
  end;

  VIDEOMEMORY = record
    dwFlags: DWORD;
    fpStart: NativeUInt;
    Anonymous1: _Anonymous1_e__Union;
    ddsCaps: DDSCAPS;
    ddsCapsAlt: DDSCAPS;
    Anonymous2: _Anonymous2_e__Union;
  end;
const DDSCAPS = extern struct {
    dwCaps: u32,
};

const VIDEOMEMORY = extern struct {
    dwFlags: u32,
    fpStart: usize,
    Anonymous1: _Anonymous1_e__Union,
    ddsCaps: DDSCAPS,
    ddsCapsAlt: DDSCAPS,
    Anonymous2: _Anonymous2_e__Union,
};
type
  DDSCAPS {.bycopy.} = object
    dwCaps: uint32

  VIDEOMEMORY {.bycopy.} = object
    dwFlags: uint32
    fpStart: uint
    Anonymous1: _Anonymous1_e__Union
    ddsCaps: DDSCAPS
    ddsCapsAlt: DDSCAPS
    Anonymous2: _Anonymous2_e__Union
struct DDSCAPS
{
    uint dwCaps;
}

struct VIDEOMEMORY
{
    uint dwFlags;
    size_t fpStart;
    _Anonymous1_e__Union Anonymous1;
    DDSCAPS ddsCaps;
    DDSCAPS ddsCapsAlt;
    _Anonymous2_e__Union Anonymous2;
}

HSP用 定義

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

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; VIDEOMEMORY サイズ: 24 バイト(x86)
dim st, 6    ; 4byte整数×6(構造体サイズ 24 / 4 切り上げ)
; dwFlags : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; fpStart : UINT_PTR (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; Anonymous1 : _Anonymous1_e__Union (+8, 4byte)  varptr(st)+8 を基点に操作(4byte:入れ子/配列)
; ddsCaps : DDSCAPS (+12, 4byte)  varptr(st)+12 を基点に操作(4byte:入れ子/配列)
; ddsCapsAlt : DDSCAPS (+16, 4byte)  varptr(st)+16 を基点に操作(4byte:入れ子/配列)
; Anonymous2 : _Anonymous2_e__Union (+20, 4byte)  varptr(st)+20 を基点に操作(4byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; VIDEOMEMORY サイズ: 40 バイト(x64)
dim st, 10    ; 4byte整数×10(構造体サイズ 40 / 4 切り上げ)
; dwFlags : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; fpStart : UINT_PTR (+8, 8byte)  qpoke st,8,値 / qpeek(st,8)  ※IronHSPのみ。3.7/3.8は lpoke st,8,下位 : lpoke st,12,上位
; Anonymous1 : _Anonymous1_e__Union (+16, 8byte)  varptr(st)+16 を基点に操作(8byte:入れ子/配列)
; ddsCaps : DDSCAPS (+24, 4byte)  varptr(st)+24 を基点に操作(4byte:入れ子/配列)
; ddsCapsAlt : DDSCAPS (+28, 4byte)  varptr(st)+28 を基点に操作(4byte:入れ子/配列)
; Anonymous2 : _Anonymous2_e__Union (+32, 8byte)  varptr(st)+32 を基点に操作(8byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
; ※GUID・入れ子構造体はデフォルト型でないため、依存する #defstruct を先に定義(下記に同梱)。
#defstruct global DDSCAPS
    #field int dwCaps
#endstruct

#defstruct global VIDEOMEMORY
    #field int dwFlags
    #field intptr fpStart
    #field byte Anonymous1 8
    #field DDSCAPS ddsCaps
    #field DDSCAPS ddsCapsAlt
    #field byte Anonymous2 8
#endstruct

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