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

DCompositionGetStatistics

関数
指定フレームの合成統計情報とターゲット情報を取得する。
DLLdcomp.dll呼出規約winapi
📘 Microsoft Learn (日本語) · English

シグネチャ

// dcomp.dll
#include <windows.h>

HRESULT DCompositionGetStatistics(
    ULONGLONG frameId,
    COMPOSITION_FRAME_STATS* frameStats,
    DWORD targetIdCount,
    COMPOSITION_TARGET_ID* targetIds,   // optional
    DWORD* actualTargetIdCount   // optional
);

パラメーター

名前型方向説明
frameIdULONGLONGin統計を取得する対象のコンポジションフレームID。
frameStatsCOMPOSITION_FRAME_STATS*out取得したフレーム統計を格納する出力構造体。
targetIdCountDWORDintargetIds配列の確保済み要素数を指定する。
targetIdsCOMPOSITION_TARGET_ID*outoptional対象ターゲットIDを受け取る配列。
actualTargetIdCountDWORD*outoptional実際に書き込まれたターゲットID数を受け取る出力先。

戻り値の型: HRESULT

各言語での呼び出し定義

// dcomp.dll
#include <windows.h>

HRESULT DCompositionGetStatistics(
    ULONGLONG frameId,
    COMPOSITION_FRAME_STATS* frameStats,
    DWORD targetIdCount,
    COMPOSITION_TARGET_ID* targetIds,   // optional
    DWORD* actualTargetIdCount   // optional
);
[DllImport("dcomp.dll", ExactSpelling = true)]
static extern int DCompositionGetStatistics(
    ulong frameId,   // ULONGLONG
    IntPtr frameStats,   // COMPOSITION_FRAME_STATS* out
    uint targetIdCount,   // DWORD
    IntPtr targetIds,   // COMPOSITION_TARGET_ID* optional, out
    IntPtr actualTargetIdCount   // DWORD* optional, out
);
<DllImport("dcomp.dll", ExactSpelling:=True)>
Public Shared Function DCompositionGetStatistics(
    frameId As ULong,   ' ULONGLONG
    frameStats As IntPtr,   ' COMPOSITION_FRAME_STATS* out
    targetIdCount As UInteger,   ' DWORD
    targetIds As IntPtr,   ' COMPOSITION_TARGET_ID* optional, out
    actualTargetIdCount As IntPtr   ' DWORD* optional, out
) As Integer
End Function
' frameId : ULONGLONG
' frameStats : COMPOSITION_FRAME_STATS* out
' targetIdCount : DWORD
' targetIds : COMPOSITION_TARGET_ID* optional, out
' actualTargetIdCount : DWORD* optional, out
Declare PtrSafe Function DCompositionGetStatistics Lib "dcomp" ( _
    ByVal frameId As LongLong, _
    ByVal frameStats As LongPtr, _
    ByVal targetIdCount As Long, _
    ByVal targetIds As LongPtr, _
    ByVal actualTargetIdCount As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

DCompositionGetStatistics = ctypes.windll.dcomp.DCompositionGetStatistics
DCompositionGetStatistics.restype = ctypes.c_int
DCompositionGetStatistics.argtypes = [
    ctypes.c_ulonglong,  # frameId : ULONGLONG
    ctypes.c_void_p,  # frameStats : COMPOSITION_FRAME_STATS* out
    wintypes.DWORD,  # targetIdCount : DWORD
    ctypes.c_void_p,  # targetIds : COMPOSITION_TARGET_ID* optional, out
    ctypes.POINTER(wintypes.DWORD),  # actualTargetIdCount : DWORD* optional, out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('dcomp.dll')
DCompositionGetStatistics = Fiddle::Function.new(
  lib['DCompositionGetStatistics'],
  [
    -Fiddle::TYPE_LONG_LONG,  # frameId : ULONGLONG
    Fiddle::TYPE_VOIDP,  # frameStats : COMPOSITION_FRAME_STATS* out
    -Fiddle::TYPE_INT,  # targetIdCount : DWORD
    Fiddle::TYPE_VOIDP,  # targetIds : COMPOSITION_TARGET_ID* optional, out
    Fiddle::TYPE_VOIDP,  # actualTargetIdCount : DWORD* optional, out
  ],
  Fiddle::TYPE_INT)
#[link(name = "dcomp")]
extern "system" {
    fn DCompositionGetStatistics(
        frameId: u64,  // ULONGLONG
        frameStats: *mut COMPOSITION_FRAME_STATS,  // COMPOSITION_FRAME_STATS* out
        targetIdCount: u32,  // DWORD
        targetIds: *mut COMPOSITION_TARGET_ID,  // COMPOSITION_TARGET_ID* optional, out
        actualTargetIdCount: *mut u32  // DWORD* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("dcomp.dll")]
public static extern int DCompositionGetStatistics(ulong frameId, IntPtr frameStats, uint targetIdCount, IntPtr targetIds, IntPtr actualTargetIdCount);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dcomp_DCompositionGetStatistics' -Namespace Win32 -PassThru
# $api::DCompositionGetStatistics(frameId, frameStats, targetIdCount, targetIds, actualTargetIdCount)
#uselib "dcomp.dll"
#func global DCompositionGetStatistics "DCompositionGetStatistics" sptr, sptr, sptr, sptr, sptr
; DCompositionGetStatistics frameId, varptr(frameStats), targetIdCount, varptr(targetIds), varptr(actualTargetIdCount)   ; 戻り値は stat
; frameId : ULONGLONG -> "sptr"
; frameStats : COMPOSITION_FRAME_STATS* out -> "sptr"
; targetIdCount : DWORD -> "sptr"
; targetIds : COMPOSITION_TARGET_ID* optional, out -> "sptr"
; actualTargetIdCount : DWORD* optional, out -> "sptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "dcomp.dll"
#cfunc global DCompositionGetStatistics "DCompositionGetStatistics" int64, var, int, var, var
; res = DCompositionGetStatistics(frameId, frameStats, targetIdCount, targetIds, actualTargetIdCount)
; frameId : ULONGLONG -> "int64"
; frameStats : COMPOSITION_FRAME_STATS* out -> "var"
; targetIdCount : DWORD -> "int"
; targetIds : COMPOSITION_TARGET_ID* optional, out -> "var"
; actualTargetIdCount : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。
出力引数: 
; HRESULT DCompositionGetStatistics(ULONGLONG frameId, COMPOSITION_FRAME_STATS* frameStats, DWORD targetIdCount, COMPOSITION_TARGET_ID* targetIds, DWORD* actualTargetIdCount)
#uselib "dcomp.dll"
#cfunc global DCompositionGetStatistics "DCompositionGetStatistics" int64, var, int, var, var
; res = DCompositionGetStatistics(frameId, frameStats, targetIdCount, targetIds, actualTargetIdCount)
; frameId : ULONGLONG -> "int64"
; frameStats : COMPOSITION_FRAME_STATS* out -> "var"
; targetIdCount : DWORD -> "int"
; targetIds : COMPOSITION_TARGET_ID* optional, out -> "var"
; actualTargetIdCount : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	dcomp = windows.NewLazySystemDLL("dcomp.dll")
	procDCompositionGetStatistics = dcomp.NewProc("DCompositionGetStatistics")
)

// frameId (ULONGLONG), frameStats (COMPOSITION_FRAME_STATS* out), targetIdCount (DWORD), targetIds (COMPOSITION_TARGET_ID* optional, out), actualTargetIdCount (DWORD* optional, out)
r1, _, err := procDCompositionGetStatistics.Call(
	uintptr(frameId),
	uintptr(frameStats),
	uintptr(targetIdCount),
	uintptr(targetIds),
	uintptr(actualTargetIdCount),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function DCompositionGetStatistics(
  frameId: UInt64;   // ULONGLONG
  frameStats: Pointer;   // COMPOSITION_FRAME_STATS* out
  targetIdCount: DWORD;   // DWORD
  targetIds: Pointer;   // COMPOSITION_TARGET_ID* optional, out
  actualTargetIdCount: Pointer   // DWORD* optional, out
): Integer; stdcall;
  external 'dcomp.dll' name 'DCompositionGetStatistics';
result := DllCall("dcomp\DCompositionGetStatistics"
    , "Int64", frameId   ; ULONGLONG
    , "Ptr", frameStats   ; COMPOSITION_FRAME_STATS* out
    , "UInt", targetIdCount   ; DWORD
    , "Ptr", targetIds   ; COMPOSITION_TARGET_ID* optional, out
    , "Ptr", actualTargetIdCount   ; DWORD* optional, out
    , "Int")   ; return: HRESULT
●DCompositionGetStatistics(frameId, frameStats, targetIdCount, targetIds, actualTargetIdCount) = DLL("dcomp.dll", "int DCompositionGetStatistics(qword, void*, dword, void*, void*)")
# 呼び出し: DCompositionGetStatistics(frameId, frameStats, targetIdCount, targetIds, actualTargetIdCount)
# frameId : ULONGLONG -> "qword"
# frameStats : COMPOSITION_FRAME_STATS* out -> "void*"
# targetIdCount : DWORD -> "dword"
# targetIds : COMPOSITION_TARGET_ID* optional, out -> "void*"
# actualTargetIdCount : DWORD* optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "dcomp" fn DCompositionGetStatistics(
    frameId: u64, // ULONGLONG
    frameStats: [*c]COMPOSITION_FRAME_STATS, // COMPOSITION_FRAME_STATS* out
    targetIdCount: u32, // DWORD
    targetIds: [*c]COMPOSITION_TARGET_ID, // COMPOSITION_TARGET_ID* optional, out
    actualTargetIdCount: [*c]u32 // DWORD* optional, out
) callconv(std.os.windows.WINAPI) i32;
proc DCompositionGetStatistics(
    frameId: uint64,  # ULONGLONG
    frameStats: ptr COMPOSITION_FRAME_STATS,  # COMPOSITION_FRAME_STATS* out
    targetIdCount: uint32,  # DWORD
    targetIds: ptr COMPOSITION_TARGET_ID,  # COMPOSITION_TARGET_ID* optional, out
    actualTargetIdCount: ptr uint32  # DWORD* optional, out
): int32 {.importc: "DCompositionGetStatistics", stdcall, dynlib: "dcomp.dll".}
pragma(lib, "dcomp");
extern(Windows)
int DCompositionGetStatistics(
    ulong frameId,   // ULONGLONG
    COMPOSITION_FRAME_STATS* frameStats,   // COMPOSITION_FRAME_STATS* out
    uint targetIdCount,   // DWORD
    COMPOSITION_TARGET_ID* targetIds,   // COMPOSITION_TARGET_ID* optional, out
    uint* actualTargetIdCount   // DWORD* optional, out
);
ccall((:DCompositionGetStatistics, "dcomp.dll"), stdcall, Int32,
      (UInt64, Ptr{COMPOSITION_FRAME_STATS}, UInt32, Ptr{COMPOSITION_TARGET_ID}, Ptr{UInt32}),
      frameId, frameStats, targetIdCount, targetIds, actualTargetIdCount)
# frameId : ULONGLONG -> UInt64
# frameStats : COMPOSITION_FRAME_STATS* out -> Ptr{COMPOSITION_FRAME_STATS}
# targetIdCount : DWORD -> UInt32
# targetIds : COMPOSITION_TARGET_ID* optional, out -> Ptr{COMPOSITION_TARGET_ID}
# actualTargetIdCount : DWORD* optional, out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t DCompositionGetStatistics(
    uint64_t frameId,
    void* frameStats,
    uint32_t targetIdCount,
    void* targetIds,
    uint32_t* actualTargetIdCount);
]]
local dcomp = ffi.load("dcomp")
-- dcomp.DCompositionGetStatistics(frameId, frameStats, targetIdCount, targetIds, actualTargetIdCount)
-- frameId : ULONGLONG
-- frameStats : COMPOSITION_FRAME_STATS* out
-- targetIdCount : DWORD
-- targetIds : COMPOSITION_TARGET_ID* optional, out
-- actualTargetIdCount : DWORD* optional, out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('dcomp.dll');
const DCompositionGetStatistics = lib.func('__stdcall', 'DCompositionGetStatistics', 'int32_t', ['uint64_t', 'void *', 'uint32_t', 'void *', 'uint32_t *']);
// DCompositionGetStatistics(frameId, frameStats, targetIdCount, targetIds, actualTargetIdCount)
// frameId : ULONGLONG -> 'uint64_t'
// frameStats : COMPOSITION_FRAME_STATS* out -> 'void *'
// targetIdCount : DWORD -> 'uint32_t'
// targetIds : COMPOSITION_TARGET_ID* optional, out -> 'void *'
// actualTargetIdCount : DWORD* optional, out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("dcomp.dll", {
  DCompositionGetStatistics: { parameters: ["u64", "pointer", "u32", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.DCompositionGetStatistics(frameId, frameStats, targetIdCount, targetIds, actualTargetIdCount)
// frameId : ULONGLONG -> "u64"
// frameStats : COMPOSITION_FRAME_STATS* out -> "pointer"
// targetIdCount : DWORD -> "u32"
// targetIds : COMPOSITION_TARGET_ID* optional, out -> "pointer"
// actualTargetIdCount : DWORD* optional, out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t DCompositionGetStatistics(
    uint64_t frameId,
    void* frameStats,
    uint32_t targetIdCount,
    void* targetIds,
    uint32_t* actualTargetIdCount);
C, "dcomp.dll");
// $ffi->DCompositionGetStatistics(frameId, frameStats, targetIdCount, targetIds, actualTargetIdCount);
// frameId : ULONGLONG
// frameStats : COMPOSITION_FRAME_STATS* out
// targetIdCount : DWORD
// targetIds : COMPOSITION_TARGET_ID* optional, out
// actualTargetIdCount : DWORD* optional, out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Dcomp extends StdCallLibrary {
    Dcomp INSTANCE = Native.load("dcomp", Dcomp.class);
    int DCompositionGetStatistics(
        long frameId,   // ULONGLONG
        Pointer frameStats,   // COMPOSITION_FRAME_STATS* out
        int targetIdCount,   // DWORD
        Pointer targetIds,   // COMPOSITION_TARGET_ID* optional, out
        IntByReference actualTargetIdCount   // DWORD* optional, out
    );
}
@[Link("dcomp")]
lib Libdcomp
  fun DCompositionGetStatistics = DCompositionGetStatistics(
    frameId : UInt64,   # ULONGLONG
    frameStats : COMPOSITION_FRAME_STATS*,   # COMPOSITION_FRAME_STATS* out
    targetIdCount : UInt32,   # DWORD
    targetIds : COMPOSITION_TARGET_ID*,   # COMPOSITION_TARGET_ID* optional, out
    actualTargetIdCount : UInt32*   # DWORD* optional, out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef DCompositionGetStatisticsNative = Int32 Function(Uint64, Pointer<Void>, Uint32, Pointer<Void>, Pointer<Uint32>);
typedef DCompositionGetStatisticsDart = int Function(int, Pointer<Void>, int, Pointer<Void>, Pointer<Uint32>);
final DCompositionGetStatistics = DynamicLibrary.open('dcomp.dll')
    .lookupFunction<DCompositionGetStatisticsNative, DCompositionGetStatisticsDart>('DCompositionGetStatistics');
// frameId : ULONGLONG -> Uint64
// frameStats : COMPOSITION_FRAME_STATS* out -> Pointer<Void>
// targetIdCount : DWORD -> Uint32
// targetIds : COMPOSITION_TARGET_ID* optional, out -> Pointer<Void>
// actualTargetIdCount : DWORD* optional, out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DCompositionGetStatistics(
  frameId: UInt64;   // ULONGLONG
  frameStats: Pointer;   // COMPOSITION_FRAME_STATS* out
  targetIdCount: DWORD;   // DWORD
  targetIds: Pointer;   // COMPOSITION_TARGET_ID* optional, out
  actualTargetIdCount: Pointer   // DWORD* optional, out
): Integer; stdcall;
  external 'dcomp.dll' name 'DCompositionGetStatistics';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "DCompositionGetStatistics"
  c_DCompositionGetStatistics :: Word64 -> Ptr () -> Word32 -> Ptr () -> Ptr Word32 -> IO Int32
-- frameId : ULONGLONG -> Word64
-- frameStats : COMPOSITION_FRAME_STATS* out -> Ptr ()
-- targetIdCount : DWORD -> Word32
-- targetIds : COMPOSITION_TARGET_ID* optional, out -> Ptr ()
-- actualTargetIdCount : DWORD* optional, out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let dcompositiongetstatistics =
  foreign "DCompositionGetStatistics"
    (uint64_t @-> (ptr void) @-> uint32_t @-> (ptr void) @-> (ptr uint32_t) @-> returning int32_t)
(* frameId : ULONGLONG -> uint64_t *)
(* frameStats : COMPOSITION_FRAME_STATS* out -> (ptr void) *)
(* targetIdCount : DWORD -> uint32_t *)
(* targetIds : COMPOSITION_TARGET_ID* optional, out -> (ptr void) *)
(* actualTargetIdCount : DWORD* optional, out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library dcomp (t "dcomp.dll"))
(cffi:use-foreign-library dcomp)

(cffi:defcfun ("DCompositionGetStatistics" dcomposition-get-statistics :convention :stdcall) :int32
  (frame-id :uint64)   ; ULONGLONG
  (frame-stats :pointer)   ; COMPOSITION_FRAME_STATS* out
  (target-id-count :uint32)   ; DWORD
  (target-ids :pointer)   ; COMPOSITION_TARGET_ID* optional, out
  (actual-target-id-count :pointer))   ; DWORD* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DCompositionGetStatistics = Win32::API::More->new('dcomp',
    'int DCompositionGetStatistics(UINT64 frameId, LPVOID frameStats, DWORD targetIdCount, LPVOID targetIds, LPVOID actualTargetIdCount)');
# my $ret = $DCompositionGetStatistics->Call($frameId, $frameStats, $targetIdCount, $targetIds, $actualTargetIdCount);
# frameId : ULONGLONG -> UINT64
# frameStats : COMPOSITION_FRAME_STATS* out -> LPVOID
# targetIdCount : DWORD -> DWORD
# targetIds : COMPOSITION_TARGET_ID* optional, out -> LPVOID
# actualTargetIdCount : DWORD* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型