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

DD_GETSCANLINEDATA

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

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

フィールド

フィールドサイズx64x86説明
lpDDDD_DIRECTDRAW_GLOBAL*8/4+0+0ドライバーのデバイスを記述する DD_DIRECTDRAW_GLOBAL 構造体を指すポインターです。
dwScanLineDWORD4+8+4ドライバーが現在のスキャンラインの番号を返す場所を指定します。詳細については、「解説」セクションを参照してください。
ddRValHRESULT4+12+8ドライバーが DdGetScanLine コールバックの戻り値を書き込む場所を指定します。戻りコード DD_OK は成功を示します。詳細については、「Return Values for DirectDraw」を参照してください。
GetScanLinevoid*8/4+16+12Microsoft DirectDraw API によって使用されるメンバーであり、ドライバーが値を設定してはなりません。

公式ドキュメント

DD_GETSCANLINEDATA 構造体は、現在のスキャンラインの番号を照会して返すために必要なメンバーを格納します。

解説(Remarks)

dwScanLine で返されるスキャンラインの値は、0 以上 N 未満でなければなりません。ここで N は、可視スキャンラインの数と垂直帰線期間中に発生するスキャンラインの数の合計です。たとえば、解像度 640x480 で動作し、垂直帰線期間中に 12 本のスキャンラインがあるディスプレイの場合、GetScanLine に返される値は 0 から 491 の範囲になります。

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

各言語での定義

#include <windows.h>

// DD_GETSCANLINEDATA  (x64 24 / x86 16 バイト)
typedef struct DD_GETSCANLINEDATA {
    DD_DIRECTDRAW_GLOBAL* lpDD;
    DWORD dwScanLine;
    HRESULT ddRVal;
    void* GetScanLine;
} DD_GETSCANLINEDATA;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct DD_GETSCANLINEDATA
{
    public IntPtr lpDD;
    public uint dwScanLine;
    public int ddRVal;
    public IntPtr GetScanLine;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure DD_GETSCANLINEDATA
    Public lpDD As IntPtr
    Public dwScanLine As UInteger
    Public ddRVal As Integer
    Public GetScanLine As IntPtr
End Structure
import ctypes
from ctypes import wintypes

class DD_GETSCANLINEDATA(ctypes.Structure):
    _fields_ = [
        ("lpDD", ctypes.c_void_p),
        ("dwScanLine", wintypes.DWORD),
        ("ddRVal", ctypes.c_int),
        ("GetScanLine", ctypes.c_void_p),
    ]
#[repr(C)]
pub struct DD_GETSCANLINEDATA {
    pub lpDD: *mut core::ffi::c_void,
    pub dwScanLine: u32,
    pub ddRVal: i32,
    pub GetScanLine: *mut core::ffi::c_void,
}
import "golang.org/x/sys/windows"

type DD_GETSCANLINEDATA struct {
	lpDD uintptr
	dwScanLine uint32
	ddRVal int32
	GetScanLine uintptr
}
type
  DD_GETSCANLINEDATA = record
    lpDD: Pointer;
    dwScanLine: DWORD;
    ddRVal: Integer;
    GetScanLine: Pointer;
  end;
const DD_GETSCANLINEDATA = extern struct {
    lpDD: ?*anyopaque,
    dwScanLine: u32,
    ddRVal: i32,
    GetScanLine: ?*anyopaque,
};
type
  DD_GETSCANLINEDATA {.bycopy.} = object
    lpDD: pointer
    dwScanLine: uint32
    ddRVal: int32
    GetScanLine: pointer
struct DD_GETSCANLINEDATA
{
    void* lpDD;
    uint dwScanLine;
    int ddRVal;
    void* GetScanLine;
}

HSP用 定義

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

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; DD_GETSCANLINEDATA サイズ: 16 バイト(x86)
dim st, 4    ; 4byte整数×4(構造体サイズ 16 / 4 切り上げ)
; lpDD : DD_DIRECTDRAW_GLOBAL* (+0, 4byte)  varptr(st)+0 を基点に操作(4byte:入れ子/配列)
; dwScanLine : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; ddRVal : HRESULT (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; GetScanLine : void* (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; DD_GETSCANLINEDATA サイズ: 24 バイト(x64)
dim st, 6    ; 4byte整数×6(構造体サイズ 24 / 4 切り上げ)
; lpDD : DD_DIRECTDRAW_GLOBAL* (+0, 8byte)  varptr(st)+0 を基点に操作(8byte:入れ子/配列)
; dwScanLine : DWORD (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; ddRVal : HRESULT (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; GetScanLine : void* (+16, 8byte)  qpoke st,16,値 / qpeek(st,16)  ※IronHSPのみ。3.7/3.8は lpoke st,16,下位 : lpoke st,20,上位
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global DD_GETSCANLINEDATA
    #field intptr lpDD
    #field int dwScanLine
    #field int ddRVal
    #field intptr GetScanLine
#endstruct

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