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

DD_SETCOLORKEYDATA

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

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

フィールド

フィールドサイズx64x86説明
lpDDDD_DIRECTDRAW_GLOBAL*8/4+0+0ドライバーのデバイスを記述する DD_DIRECTDRAW_GLOBAL 構造体を指すポインターです。
lpDDSurfaceDD_SURFACE_LOCAL*8/4+8+4カラーキーを関連付けるサーフェスを記述する DD_SURFACE_LOCAL 構造体を指すポインターです。
dwFlagsDWORD4+16+8

どのカラーキーが要求されているかを指定します。このメンバーは、次の値のビット単位のOR です。

意味
DDCKEY_COLORSPACE DDCOLORKEY 構造体にカラースペースが格納されます。このビットが設定されていない場合、構造体には単一のカラーキーが格納されます。
DDCKEY_DESTBLT DDCOLORKEY 構造体は、blt 操作の転送先カラーキーとして使用するカラーキーまたはカラースペースを指定します。
DDCKEY_DESTOVERLAY DDCOLORKEY 構造体は、オーバーレイ操作の転送先カラーキーとして使用するカラーキーまたはカラースペースを指定します。
DDCKEY_SRCBLT DDCOLORKEY 構造体は、ブリット操作の転送元カラーキーとして使用するカラーキーまたはカラースペースを指定します。
DDCKEY_SRCOVERLAY DDCOLORKEY 構造体は、オーバーレイ操作の転送元カラーキーとして使用するカラーキーまたはカラースペースを指定します。
ckNewDDCOLORKEY8+20+12DirectDrawSurface オブジェクトの新しいカラーキー値を指定する DDCOLORKEY 構造体を指定します。DDCOLORKEY の詳細については、最新の Microsoft DirectX SDK のドキュメントを参照してください。
ddRValHRESULT4+28+20ドライバーが DdSetColorKey コールバックの戻り値を書き込む場所を指定します。戻り値 DD_OK は成功を示します。詳細については、Return Values for DirectDraw を参照してください。
SetColorKeyvoid*8/4+32+24これは Microsoft Windows 2000 以降では使用されません。

公式ドキュメント

DD_SETCOLORKEYDATA 構造体は、指定されたサーフェスのカラーキー値を設定するために必要な情報を格納します。

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

各言語での定義

#include <windows.h>

// DDCOLORKEY  (x64 8 / x86 8 バイト)
typedef struct DDCOLORKEY {
    DWORD dwColorSpaceLowValue;
    DWORD dwColorSpaceHighValue;
} DDCOLORKEY;

// DD_SETCOLORKEYDATA  (x64 40 / x86 28 バイト)
typedef struct DD_SETCOLORKEYDATA {
    DD_DIRECTDRAW_GLOBAL* lpDD;
    DD_SURFACE_LOCAL* lpDDSurface;
    DWORD dwFlags;
    DDCOLORKEY ckNew;
    HRESULT ddRVal;
    void* SetColorKey;
} DD_SETCOLORKEYDATA;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct DDCOLORKEY
{
    public uint dwColorSpaceLowValue;
    public uint dwColorSpaceHighValue;
}

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct DD_SETCOLORKEYDATA
{
    public IntPtr lpDD;
    public IntPtr lpDDSurface;
    public uint dwFlags;
    public DDCOLORKEY ckNew;
    public int ddRVal;
    public IntPtr SetColorKey;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure DDCOLORKEY
    Public dwColorSpaceLowValue As UInteger
    Public dwColorSpaceHighValue As UInteger
End Structure

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure DD_SETCOLORKEYDATA
    Public lpDD As IntPtr
    Public lpDDSurface As IntPtr
    Public dwFlags As UInteger
    Public ckNew As DDCOLORKEY
    Public ddRVal As Integer
    Public SetColorKey As IntPtr
End Structure
import ctypes
from ctypes import wintypes

class DDCOLORKEY(ctypes.Structure):
    _fields_ = [
        ("dwColorSpaceLowValue", wintypes.DWORD),
        ("dwColorSpaceHighValue", wintypes.DWORD),
    ]

class DD_SETCOLORKEYDATA(ctypes.Structure):
    _fields_ = [
        ("lpDD", ctypes.c_void_p),
        ("lpDDSurface", ctypes.c_void_p),
        ("dwFlags", wintypes.DWORD),
        ("ckNew", DDCOLORKEY),
        ("ddRVal", ctypes.c_int),
        ("SetColorKey", ctypes.c_void_p),
    ]
#[repr(C)]
pub struct DDCOLORKEY {
    pub dwColorSpaceLowValue: u32,
    pub dwColorSpaceHighValue: u32,
}

#[repr(C)]
pub struct DD_SETCOLORKEYDATA {
    pub lpDD: *mut core::ffi::c_void,
    pub lpDDSurface: *mut core::ffi::c_void,
    pub dwFlags: u32,
    pub ckNew: DDCOLORKEY,
    pub ddRVal: i32,
    pub SetColorKey: *mut core::ffi::c_void,
}
import "golang.org/x/sys/windows"

type DDCOLORKEY struct {
	dwColorSpaceLowValue uint32
	dwColorSpaceHighValue uint32
}

type DD_SETCOLORKEYDATA struct {
	lpDD uintptr
	lpDDSurface uintptr
	dwFlags uint32
	ckNew DDCOLORKEY
	ddRVal int32
	SetColorKey uintptr
}
type
  DDCOLORKEY = record
    dwColorSpaceLowValue: DWORD;
    dwColorSpaceHighValue: DWORD;
  end;

  DD_SETCOLORKEYDATA = record
    lpDD: Pointer;
    lpDDSurface: Pointer;
    dwFlags: DWORD;
    ckNew: DDCOLORKEY;
    ddRVal: Integer;
    SetColorKey: Pointer;
  end;
const DDCOLORKEY = extern struct {
    dwColorSpaceLowValue: u32,
    dwColorSpaceHighValue: u32,
};

const DD_SETCOLORKEYDATA = extern struct {
    lpDD: ?*anyopaque,
    lpDDSurface: ?*anyopaque,
    dwFlags: u32,
    ckNew: DDCOLORKEY,
    ddRVal: i32,
    SetColorKey: ?*anyopaque,
};
type
  DDCOLORKEY {.bycopy.} = object
    dwColorSpaceLowValue: uint32
    dwColorSpaceHighValue: uint32

  DD_SETCOLORKEYDATA {.bycopy.} = object
    lpDD: pointer
    lpDDSurface: pointer
    dwFlags: uint32
    ckNew: DDCOLORKEY
    ddRVal: int32
    SetColorKey: pointer
struct DDCOLORKEY
{
    uint dwColorSpaceLowValue;
    uint dwColorSpaceHighValue;
}

struct DD_SETCOLORKEYDATA
{
    void* lpDD;
    void* lpDDSurface;
    uint dwFlags;
    DDCOLORKEY ckNew;
    int ddRVal;
    void* SetColorKey;
}

HSP用 定義

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

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

#defstruct global DD_SETCOLORKEYDATA
    #field intptr lpDD
    #field intptr lpDDSurface
    #field int dwFlags
    #field DDCOLORKEY ckNew
    #field int ddRVal
    #field intptr SetColorKey
#endstruct

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