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

DDPIXELFORMAT

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

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

フィールド

フィールドサイズx64x86説明
dwSizeDWORD4+0+0構造体のサイズ (バイト単位)。このメンバーは、構造体を使用する前に初期化しておく必要があります。
dwFlagsDWORD4+4+4

この構造体に対する省略可能な制御を表す、次のフラグです。

DDPF_ALPHA

ピクセル形式がアルファのみのサーフェスを表します。

DDPF_ALPHAPIXELS

サーフェスのピクセル形式にアルファチャネル情報が含まれます。

DDPF_ALPHAPREMULT

サーフェスは事前乗算済みアルファ形式を使用します。つまり、各ピクセルの色成分はアルファ成分によってあらかじめ乗算されています。

DDPF_BUMPLUMINANCE

ピクセル形式の輝度データが有効であり、dwLuminanceBitMask メンバーが輝度のみまたは輝度アルファのサーフェスの有効な輝度ビットを表します。

DDPF_BUMPDUDV

ピクセル形式のバンプマップデータが有効です。バンプマップ情報は dwBumpBitCountdwBumpDuBitMaskdwBumpDvBitMaskdwBumpLuminanceBitMask の各メンバーに格納されます。

DDPF_COMPRESSED

サーフェスは指定された形式のピクセルデータを受け取り、書き込み操作の際にそれを圧縮します。

DDPF_D3DFORMAT

テクスチャ形式リスト内の DirectX 8.0 以降の形式機能エントリを示します。このフラグはアプリケーションには公開されず、Ddrawi.h で定義されています。

DDPF_FOURCC

dwFourCC メンバーが有効であり、非 RGB のピクセル形式を表す FOURCC コードを格納しています。

DDPF_LUMINANCE

ピクセル形式が輝度のみまたは輝度アルファのサーフェスを表します。

DDPF_PALETTEINDEXED1

サーフェスは 1 ビットのカラーインデックス形式です。

DDPF_PALETTEINDEXED2

サーフェスは 2 ビットのカラーインデックス形式です。

DDPF_PALETTEINDEXED4

サーフェスは 4 ビットのカラーインデックス形式です。

DDPF_PALETTEINDEXED8

サーフェスは 8 ビットのカラーインデックス形式です。

DDPF_PALETTEINDEXEDTO8

サーフェスは、8 ビットパレットに対する 1、2、または 4 ビットのカラーインデックス形式です。

DDPF_RGB

ピクセル形式構造体の RGB データが有効です。

DDPF_RGBTOYUV

サーフェスは RGB データを受け取り、書き込み操作の際にそれを YUV データへ変換します。書き込むデータの形式はピクセル形式構造体に格納されます。DDPF_RGB フラグが設定されます。

DDPF_STENCILBUFFER

サーフェスは、z バッファーの各ピクセルにステンシル情報と深度情報をエンコードします。このフラグは、DDPF_ZBUFFER フラグも指定されている場合にのみ使用できます。

DDPF_YUV

ピクセル形式構造体の YUV データが有効です。

DDPF_ZBUFFER

ピクセル形式が z バッファーサーフェスを表します。

DDPF_ZPIXELS

サーフェスのピクセルに z 情報が含まれます。

dwFourCCDWORD4+8+8FourCC コードです。
Anonymous1_Anonymous1_e__Union4+12+12総ビット数やZ/アルファ/輝度等の深度を保持する共用体。
Anonymous2_Anonymous2_e__Union4+16+16赤/Y/Zビットマスクや輝度ビット数を保持する共用体。
Anonymous3_Anonymous3_e__Union8/4+24+20緑/U/ステンシルビットマスク等を保持する共用体。
Anonymous4_Anonymous4_e__Union4+32+24青/V/Zビットマスク等を保持する共用体。
Anonymous5_Anonymous5_e__Union4+36+28RGBアルファ/Y用UVマスク等を保持する共用体。

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

フィールドサイズx64x86説明
dwRGBBitCountDWORD4+0+01 ピクセルあたりの RGB ビット数 (4、8、16、24、または 32)。
dwYUVBitCountDWORD4+0+01 ピクセルあたりの YUV ビット数 (4、8、16、24、または 32)。
dwZBufferBitDepthDWORD4+0+0z バッファーのビット深度 (8、16、24、または 32)。
dwAlphaBitDepthDWORD4+0+0アルファのみのサーフェス (DDPF_ALPHA) におけるアルファチャネルのビット深度 (1、2、4、または 8)。色データとインターリーブされたアルファ情報を含むピクセル形式 (DDPF_ALPHAPIXELS) の場合は、dwRGBAlphaBitMask メンバーのビット数を数えることで、アルファ成分のビット深度を取得します。アルファのビット深度を判定する方法の詳細については、「解説」を参照してください。
dwLuminanceBitCountDWORD4+0+01 ピクセルあたりの輝度ビットの合計数。このメンバーは、輝度のみおよび輝度アルファのサーフェスにのみ適用されます。
dwBumpBitCountDWORD4+0+0バンプマップサーフェスにおける 1 ピクセルあたりのバンプマップビットの合計数。
dwPrivateFormatBitCountDWORD4+0+0プライベートなドライバー形式の 1 ピクセルあたりのビット数。テクスチャ形式リスト内で、かつ DDPF_D3DFORMAT が設定されている場合にのみ有効です。

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

フィールドサイズx64x86説明
dwRBitMaskDWORD4+0+0赤のビットのマスク。
dwYBitMaskDWORD4+0+0Y のビットのマスク。
dwStencilBitDepthDWORD4+0+0ステンシルバッファーのビット深度。このメンバーは、z バッファーの各ピクセル内でステンシル情報用に予約されているビット数を指定します (z ビットの合計数は、dwZBufferBitDepth から dwStencilBitDepth を引いた値になります)。
dwLuminanceBitMaskDWORD4+0+0輝度のビットのマスク。
dwBumpDuBitMaskDWORD4+0+0バンプマップの U デルタのビットのマスク。
dwOperationsDWORD4+0+0DDPF_D3DFORMAT ピクセル形式のサーフェスに対して実行できる操作を指定するフラグ。これらのフラグは Ddrawi.h で定義されています。

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

フィールドサイズx64x86説明
dwGBitMaskDWORD4+0+0緑のビットのマスク。
dwUBitMaskDWORD4+0+0U のビットのマスク。
dwZBitMaskDWORD4+0+0z のビットのマスク。
dwBumpDvBitMaskDWORD4+0+0バンプマップの V デルタのビットのマスク。
MultiSampleCaps_MultiSampleCaps_e__Struct8/4+0+0次の 2 つのメンバーを含む構造体です。この構造体は、マルチサンプルレンダリングを実行するときに使用できるサーフェスを指定するために使用します。16 ビットのマスクの各ビットは、特定のサンプル数でのマルチサンプリングのサポートを示します。たとえば、ビット 0 は 1 サンプルのみのマルチサンプリングのサポートを示し、ビット 1 は 2 サンプルのマルチサンプリングのサポートを示します (以降も同様)。ドライバーは、ビット単位のOR でビットを組み合わせることにより、複数のサポートレベルを示すことができます。

共用体: _Anonymous4_e__Union x64 4B / x86 4B

フィールドサイズx64x86説明
dwBBitMaskDWORD4+0+0青のビットのマスク。
dwVBitMaskDWORD4+0+0V のビットのマスク。
dwStencilBitMaskDWORD4+0+0z バッファーの各ピクセル内のステンシルビットのマスク。
dwBumpLuminanceBitMaskDWORD4+0+0バンプマップのピクセル内の輝度のマスク。

共用体: _Anonymous5_e__Union x64 4B / x86 4B

フィールドサイズx64x86説明
dwRGBAlphaBitMaskDWORD4+0+0アルファチャネル用の RGB マスク。
dwYUVAlphaBitMaskDWORD4+0+0アルファチャネル用の YUV マスク。
dwLuminanceAlphaBitMaskDWORD4+0+0アルファチャネル用の輝度マスク。
dwRGBZBitMaskDWORD4+0+0z チャネル用の RGB マスク。
dwYUVZBitMaskDWORD4+0+0z チャネル用の YUV マスク。

公式ドキュメント

DDPIXELFORMAT 構造体は、IDirectDrawSurface7::GetPixelFormat メソッド用に DirectDrawSurface オブジェクトのピクセル形式を記述します。

Note DirectDraw Surface (DDS) ファイル形式 (.dds) のファイルをデコードする場合は、この構造体ではなく、Ddraw.h に依存しない代替の構造体を使用してください。DDS 用の代替構造体の詳細については、DDS を参照してください。

解説(Remarks)

dwAlphaBitDepth メンバーは、アルファのみのピクセル形式 (DDPF_ALPHA) のビット深度を反映します。色成分と共にアルファ成分を含むピクセル形式 (DDPF_ALPHAPIXELS) の場合、アルファのビット深度は各種のマスクメンバーのビット数を数えることで求めます。次のコード例は、指定したビットマスク内で設定されているビットの数を返します。

WORD GetNumberOfBits( DWORD dwMask )
{
    WORD wBits = 0;
    while( dwMask )
    {
        dwMask = dwMask & ( dwMask - 1 );  
        wBits++;
    }
    return wBits;
}

DDPIXELFORMAT 内の共用体は、無名共用体をサポートしないコンパイラーでも動作するように更新されています。使用しているコンパイラーが無名共用体をサポートしていない場合は、Ddraw.h ヘッダーファイルをインクルードする前に NONAMELESSUNION トークンを定義してください。

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

各言語での定義

#include <windows.h>

// DDPIXELFORMAT  (x64 40 / x86 32 バイト)
typedef struct DDPIXELFORMAT {
    DWORD dwSize;
    DWORD dwFlags;
    DWORD dwFourCC;
    _Anonymous1_e__Union Anonymous1;
    _Anonymous2_e__Union Anonymous2;
    _Anonymous3_e__Union Anonymous3;
    _Anonymous4_e__Union Anonymous4;
    _Anonymous5_e__Union Anonymous5;
} DDPIXELFORMAT;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct DDPIXELFORMAT
{
    public uint dwSize;
    public uint dwFlags;
    public uint dwFourCC;
    public _Anonymous1_e__Union Anonymous1;
    public _Anonymous2_e__Union Anonymous2;
    public _Anonymous3_e__Union Anonymous3;
    public _Anonymous4_e__Union Anonymous4;
    public _Anonymous5_e__Union Anonymous5;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure DDPIXELFORMAT
    Public dwSize As UInteger
    Public dwFlags As UInteger
    Public dwFourCC As UInteger
    Public Anonymous1 As _Anonymous1_e__Union
    Public Anonymous2 As _Anonymous2_e__Union
    Public Anonymous3 As _Anonymous3_e__Union
    Public Anonymous4 As _Anonymous4_e__Union
    Public Anonymous5 As _Anonymous5_e__Union
End Structure
import ctypes
from ctypes import wintypes

class DDPIXELFORMAT(ctypes.Structure):
    _fields_ = [
        ("dwSize", wintypes.DWORD),
        ("dwFlags", wintypes.DWORD),
        ("dwFourCC", wintypes.DWORD),
        ("Anonymous1", _Anonymous1_e__Union),
        ("Anonymous2", _Anonymous2_e__Union),
        ("Anonymous3", _Anonymous3_e__Union),
        ("Anonymous4", _Anonymous4_e__Union),
        ("Anonymous5", _Anonymous5_e__Union),
    ]
#[repr(C)]
pub struct DDPIXELFORMAT {
    pub dwSize: u32,
    pub dwFlags: u32,
    pub dwFourCC: u32,
    pub Anonymous1: _Anonymous1_e__Union,
    pub Anonymous2: _Anonymous2_e__Union,
    pub Anonymous3: _Anonymous3_e__Union,
    pub Anonymous4: _Anonymous4_e__Union,
    pub Anonymous5: _Anonymous5_e__Union,
}
import "golang.org/x/sys/windows"

type DDPIXELFORMAT struct {
	dwSize uint32
	dwFlags uint32
	dwFourCC uint32
	Anonymous1 _Anonymous1_e__Union
	Anonymous2 _Anonymous2_e__Union
	Anonymous3 _Anonymous3_e__Union
	Anonymous4 _Anonymous4_e__Union
	Anonymous5 _Anonymous5_e__Union
}
type
  DDPIXELFORMAT = record
    dwSize: DWORD;
    dwFlags: DWORD;
    dwFourCC: DWORD;
    Anonymous1: _Anonymous1_e__Union;
    Anonymous2: _Anonymous2_e__Union;
    Anonymous3: _Anonymous3_e__Union;
    Anonymous4: _Anonymous4_e__Union;
    Anonymous5: _Anonymous5_e__Union;
  end;
const DDPIXELFORMAT = extern struct {
    dwSize: u32,
    dwFlags: u32,
    dwFourCC: u32,
    Anonymous1: _Anonymous1_e__Union,
    Anonymous2: _Anonymous2_e__Union,
    Anonymous3: _Anonymous3_e__Union,
    Anonymous4: _Anonymous4_e__Union,
    Anonymous5: _Anonymous5_e__Union,
};
type
  DDPIXELFORMAT {.bycopy.} = object
    dwSize: uint32
    dwFlags: uint32
    dwFourCC: uint32
    Anonymous1: _Anonymous1_e__Union
    Anonymous2: _Anonymous2_e__Union
    Anonymous3: _Anonymous3_e__Union
    Anonymous4: _Anonymous4_e__Union
    Anonymous5: _Anonymous5_e__Union
struct DDPIXELFORMAT
{
    uint dwSize;
    uint dwFlags;
    uint dwFourCC;
    _Anonymous1_e__Union Anonymous1;
    _Anonymous2_e__Union Anonymous2;
    _Anonymous3_e__Union Anonymous3;
    _Anonymous4_e__Union Anonymous4;
    _Anonymous5_e__Union Anonymous5;
}

HSP用 定義

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

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; DDPIXELFORMAT サイズ: 32 バイト(x86)
dim st, 8    ; 4byte整数×8(構造体サイズ 32 / 4 切り上げ)
; dwSize : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; dwFlags : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; dwFourCC : DWORD (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; Anonymous1 : _Anonymous1_e__Union (+12, 4byte)  varptr(st)+12 を基点に操作(4byte:入れ子/配列)
; Anonymous2 : _Anonymous2_e__Union (+16, 4byte)  varptr(st)+16 を基点に操作(4byte:入れ子/配列)
; Anonymous3 : _Anonymous3_e__Union (+20, 4byte)  varptr(st)+20 を基点に操作(4byte:入れ子/配列)
; Anonymous4 : _Anonymous4_e__Union (+24, 4byte)  varptr(st)+24 を基点に操作(4byte:入れ子/配列)
; Anonymous5 : _Anonymous5_e__Union (+28, 4byte)  varptr(st)+28 を基点に操作(4byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; DDPIXELFORMAT サイズ: 40 バイト(x64)
dim st, 10    ; 4byte整数×10(構造体サイズ 40 / 4 切り上げ)
; dwSize : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; dwFlags : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; dwFourCC : DWORD (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; Anonymous1 : _Anonymous1_e__Union (+12, 4byte)  varptr(st)+12 を基点に操作(4byte:入れ子/配列)
; Anonymous2 : _Anonymous2_e__Union (+16, 4byte)  varptr(st)+16 を基点に操作(4byte:入れ子/配列)
; Anonymous3 : _Anonymous3_e__Union (+24, 8byte)  varptr(st)+24 を基点に操作(8byte:入れ子/配列)
; Anonymous4 : _Anonymous4_e__Union (+32, 4byte)  varptr(st)+32 を基点に操作(4byte:入れ子/配列)
; Anonymous5 : _Anonymous5_e__Union (+36, 4byte)  varptr(st)+36 を基点に操作(4byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global DDPIXELFORMAT
    #field int dwSize
    #field int dwFlags
    #field int dwFourCC
    #field byte Anonymous1 4
    #field byte Anonymous2 4
    #field byte Anonymous3 8
    #field byte Anonymous4 4
    #field byte Anonymous5 4
#endstruct

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