DCompositionCreateDevice2
関数シグネチャ
// dcomp.dll
#include <windows.h>
HRESULT DCompositionCreateDevice2(
IUnknown* renderingDevice, // optional
const GUID* iid,
void** dcompositionDevice
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| renderingDevice | IUnknown* | inoptional | DirectComposition のサーフェスオブジェクトを作成するために使用する DirectX デバイスへの、省略可能なポインター。IDXGIDevice インターフェイスまたは ID2D1Device インターフェイスを実装するオブジェクトへのポインターである必要があります。 |
| iid | GUID* | in | 取得するインターフェイスの識別子。__uuidof(IDCompositionDevice) または __uuidof(IDCompositionDesktopDevice) のいずれかである必要があります。 |
| dcompositionDevice | void** | out | 新しく作成されたデバイスオブジェクトへのインターフェイスポインターを受け取ります。このポインターの型は、iid パラメーターで指定した型です。このパラメーターに NULL を指定することはできません。 |
戻り値の型: HRESULT
公式ドキュメント
他の Microsoft DirectComposition オブジェクトを作成するために使用できる、新しいデバイスオブジェクトを作成します。(DCompositionCreateDevice2)
戻り値
関数が成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。エラーコードの一覧については、DirectComposition Error Codes を参照してください。
解説(Remarks)
デバイスオブジェクトは、他のすべての DirectComposition オブジェクトのファクトリとして機能します。また、IDCompositionDevice2::Commit メソッドを通じてトランザクション単位のコンポジションを制御します。
renderingDevice パラメーターには、DXGI、Direct3D、または Direct2D のデバイスオブジェクトを指定できるほか、NULL を指定することもできます。このパラメーターは、IDCompositionDevice2::CreateSurface、IDCompositionDevice2::CreateVirtualSurface、および IDCompositionSurface::BeginDraw の各メソッドの動作に影響します。
renderingDevice パラメーターが NULL の場合、返される DirectComposition デバイスは DirectComposition のサーフェスオブジェクトを直接作成できません。特に、IDCompositionDevice2::CreateSurface メソッドと IDCompositionDevice2::CreateVirtualSurface メソッドは、指定されたパラメーターに関係なく E_INVALIDARG を返します。ただし、このような DirectComposition デバイスオブジェクトでも、アプリケーションが IDCompositionDevice2::CreateSurfaceFactory メソッドでサーフェスファクトリオブジェクトを作成すれば、間接的にサーフェスを作成できます。
renderingDevice パラメーターが DXGI デバイスを指している場合、そのデバイスは、IDCompositionDevice2::CreateSurface メソッドおよび IDCompositionDevice2::CreateVirtualSurface メソッドが必要とするすべてのビデオメモリの割り当てに使用されます。さらに、IDCompositionSurface::BeginDraw メソッドは、その同じ DXGI デバイスに属する DXGI サーフェスへのインターフェイスポインターを返します。
renderingDevice パラメーターが Direct2D デバイスオブジェクトを指している場合、DirectComposition はそこから基になる DXGI デバイスオブジェクトを取り出し、その DXGI デバイスオブジェクトが renderingDevice パラメーターとして渡されたものとして扱います。ただし、Direct2D オブジェクトを渡すと、さらに、IDCompositionDevice2::CreateSurface メソッドまたは IDCompositionDevice2::CreateVirtualSurface メソッドで作成された任意のオブジェクトについて、IDCompositionSurface::BeginDraw の iid パラメーターに __uuidof(ID2D1DeviceContext) を指定できるようになります。その場合、IDCompositionSurface::BeginDraw が返す Direct2D デバイスコンテキストオブジェクトは、renderingDevice パラメーターとして渡された Direct2D デバイスと同じデバイスに属します。
iid パラメーターが __uuidof(IDCompositionDevice) の場合、dcompositionDevice パラメーターはバージョン 1 の IDCompositionDevice インターフェイスへのポインターを受け取りますが、実際のオブジェクトはバージョン 2 のデスクトップデバイスオブジェクトです。アプリケーションは後から、そのデバイスに対して QueryInterface メソッドを呼び出すことで、IDCompositionDevice2 インターフェイスまたは IDCompositionDesktopDevice インターフェイスへのポインターを取得できます。同様に、このようなデバイスから作成されたすべての DirectComposition オブジェクトも、内部的にはバージョン 2 のオブジェクトです。たとえば、IDCompositionDevice::CreateVisual メソッドは、作成されたビジュアルの IDCompositionVisual インターフェイスを返しますが、アプリケーションは QueryInterface メソッドを介して IDCompositionVisual2 インターフェイスへのポインターを取得できます。この動作により、DirectComposition V1 API 向けに記述されたアプリケーションは、デバイス作成メソッドを DCompositionCreateDevice から DCompositionCreateDevice2 に変更し、引き続き IDCompositionDevice2 インターフェイスを要求するだけで、DirectComposition V2 の機能を段階的に採用できます。これにより、コードの残りの部分は変更しないまま、新しい機能が必要な箇所でのみ QueryInterface を使用できます。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// dcomp.dll
#include <windows.h>
HRESULT DCompositionCreateDevice2(
IUnknown* renderingDevice, // optional
const GUID* iid,
void** dcompositionDevice
);[DllImport("dcomp.dll", ExactSpelling = true)]
static extern int DCompositionCreateDevice2(
IntPtr renderingDevice, // IUnknown* optional
ref Guid iid, // GUID*
IntPtr dcompositionDevice // void** out
);<DllImport("dcomp.dll", ExactSpelling:=True)>
Public Shared Function DCompositionCreateDevice2(
renderingDevice As IntPtr, ' IUnknown* optional
ByRef iid As Guid, ' GUID*
dcompositionDevice As IntPtr ' void** out
) As Integer
End Function' renderingDevice : IUnknown* optional
' iid : GUID*
' dcompositionDevice : void** out
Declare PtrSafe Function DCompositionCreateDevice2 Lib "dcomp" ( _
ByVal renderingDevice As LongPtr, _
ByVal iid As LongPtr, _
ByVal dcompositionDevice As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
DCompositionCreateDevice2 = ctypes.windll.dcomp.DCompositionCreateDevice2
DCompositionCreateDevice2.restype = ctypes.c_int
DCompositionCreateDevice2.argtypes = [
ctypes.c_void_p, # renderingDevice : IUnknown* optional
ctypes.c_void_p, # iid : GUID*
ctypes.c_void_p, # dcompositionDevice : void** out
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('dcomp.dll')
DCompositionCreateDevice2 = Fiddle::Function.new(
lib['DCompositionCreateDevice2'],
[
Fiddle::TYPE_VOIDP, # renderingDevice : IUnknown* optional
Fiddle::TYPE_VOIDP, # iid : GUID*
Fiddle::TYPE_VOIDP, # dcompositionDevice : void** out
],
Fiddle::TYPE_INT)#[link(name = "dcomp")]
extern "system" {
fn DCompositionCreateDevice2(
renderingDevice: *mut core::ffi::c_void, // IUnknown* optional
iid: *const GUID, // GUID*
dcompositionDevice: *mut *mut () // void** out
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("dcomp.dll")]
public static extern int DCompositionCreateDevice2(IntPtr renderingDevice, ref Guid iid, IntPtr dcompositionDevice);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dcomp_DCompositionCreateDevice2' -Namespace Win32 -PassThru
# $api::DCompositionCreateDevice2(renderingDevice, iid, dcompositionDevice)#uselib "dcomp.dll"
#func global DCompositionCreateDevice2 "DCompositionCreateDevice2" sptr, sptr, sptr
; DCompositionCreateDevice2 renderingDevice, varptr(iid), dcompositionDevice ; 戻り値は stat
; renderingDevice : IUnknown* optional -> "sptr"
; iid : GUID* -> "sptr"
; dcompositionDevice : void** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "dcomp.dll" #cfunc global DCompositionCreateDevice2 "DCompositionCreateDevice2" sptr, var, sptr ; res = DCompositionCreateDevice2(renderingDevice, iid, dcompositionDevice) ; renderingDevice : IUnknown* optional -> "sptr" ; iid : GUID* -> "var" ; dcompositionDevice : void** out -> "sptr" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "dcomp.dll" #cfunc global DCompositionCreateDevice2 "DCompositionCreateDevice2" sptr, sptr, sptr ; res = DCompositionCreateDevice2(renderingDevice, varptr(iid), dcompositionDevice) ; renderingDevice : IUnknown* optional -> "sptr" ; iid : GUID* -> "sptr" ; dcompositionDevice : void** out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; HRESULT DCompositionCreateDevice2(IUnknown* renderingDevice, GUID* iid, void** dcompositionDevice) #uselib "dcomp.dll" #cfunc global DCompositionCreateDevice2 "DCompositionCreateDevice2" intptr, var, intptr ; res = DCompositionCreateDevice2(renderingDevice, iid, dcompositionDevice) ; renderingDevice : IUnknown* optional -> "intptr" ; iid : GUID* -> "var" ; dcompositionDevice : void** out -> "intptr" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; HRESULT DCompositionCreateDevice2(IUnknown* renderingDevice, GUID* iid, void** dcompositionDevice) #uselib "dcomp.dll" #cfunc global DCompositionCreateDevice2 "DCompositionCreateDevice2" intptr, intptr, intptr ; res = DCompositionCreateDevice2(renderingDevice, varptr(iid), dcompositionDevice) ; renderingDevice : IUnknown* optional -> "intptr" ; iid : GUID* -> "intptr" ; dcompositionDevice : void** out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
dcomp = windows.NewLazySystemDLL("dcomp.dll")
procDCompositionCreateDevice2 = dcomp.NewProc("DCompositionCreateDevice2")
)
// renderingDevice (IUnknown* optional), iid (GUID*), dcompositionDevice (void** out)
r1, _, err := procDCompositionCreateDevice2.Call(
uintptr(renderingDevice),
uintptr(iid),
uintptr(dcompositionDevice),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // HRESULTfunction DCompositionCreateDevice2(
renderingDevice: Pointer; // IUnknown* optional
iid: PGUID; // GUID*
dcompositionDevice: Pointer // void** out
): Integer; stdcall;
external 'dcomp.dll' name 'DCompositionCreateDevice2';result := DllCall("dcomp\DCompositionCreateDevice2"
, "Ptr", renderingDevice ; IUnknown* optional
, "Ptr", iid ; GUID*
, "Ptr", dcompositionDevice ; void** out
, "Int") ; return: HRESULT●DCompositionCreateDevice2(renderingDevice, iid, dcompositionDevice) = DLL("dcomp.dll", "int DCompositionCreateDevice2(void*, void*, void*)")
# 呼び出し: DCompositionCreateDevice2(renderingDevice, iid, dcompositionDevice)
# renderingDevice : IUnknown* optional -> "void*"
# iid : GUID* -> "void*"
# dcompositionDevice : void** out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "dcomp" fn DCompositionCreateDevice2(
renderingDevice: ?*anyopaque, // IUnknown* optional
iid: [*c]GUID, // GUID*
dcompositionDevice: ?*anyopaque // void** out
) callconv(std.os.windows.WINAPI) i32;proc DCompositionCreateDevice2(
renderingDevice: pointer, # IUnknown* optional
iid: ptr GUID, # GUID*
dcompositionDevice: pointer # void** out
): int32 {.importc: "DCompositionCreateDevice2", stdcall, dynlib: "dcomp.dll".}pragma(lib, "dcomp");
extern(Windows)
int DCompositionCreateDevice2(
void* renderingDevice, // IUnknown* optional
GUID* iid, // GUID*
void** dcompositionDevice // void** out
);ccall((:DCompositionCreateDevice2, "dcomp.dll"), stdcall, Int32,
(Ptr{Cvoid}, Ptr{GUID}, Ptr{Cvoid}),
renderingDevice, iid, dcompositionDevice)
# renderingDevice : IUnknown* optional -> Ptr{Cvoid}
# iid : GUID* -> Ptr{GUID}
# dcompositionDevice : void** out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t DCompositionCreateDevice2(
void* renderingDevice,
void* iid,
void** dcompositionDevice);
]]
local dcomp = ffi.load("dcomp")
-- dcomp.DCompositionCreateDevice2(renderingDevice, iid, dcompositionDevice)
-- renderingDevice : IUnknown* optional
-- iid : GUID*
-- dcompositionDevice : void** out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('dcomp.dll');
const DCompositionCreateDevice2 = lib.func('__stdcall', 'DCompositionCreateDevice2', 'int32_t', ['void *', 'void *', 'void *']);
// DCompositionCreateDevice2(renderingDevice, iid, dcompositionDevice)
// renderingDevice : IUnknown* optional -> 'void *'
// iid : GUID* -> 'void *'
// dcompositionDevice : void** out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("dcomp.dll", {
DCompositionCreateDevice2: { parameters: ["pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.DCompositionCreateDevice2(renderingDevice, iid, dcompositionDevice)
// renderingDevice : IUnknown* optional -> "pointer"
// iid : GUID* -> "pointer"
// dcompositionDevice : void** out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t DCompositionCreateDevice2(
void* renderingDevice,
void* iid,
void** dcompositionDevice);
C, "dcomp.dll");
// $ffi->DCompositionCreateDevice2(renderingDevice, iid, dcompositionDevice);
// renderingDevice : IUnknown* optional
// iid : GUID*
// dcompositionDevice : void** 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 DCompositionCreateDevice2(
Pointer renderingDevice, // IUnknown* optional
Pointer iid, // GUID*
Pointer dcompositionDevice // void** out
);
}@[Link("dcomp")]
lib Libdcomp
fun DCompositionCreateDevice2 = DCompositionCreateDevice2(
renderingDevice : Void*, # IUnknown* optional
iid : GUID*, # GUID*
dcompositionDevice : Void** # void** out
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef DCompositionCreateDevice2Native = Int32 Function(Pointer<Void>, Pointer<Void>, Pointer<Void>);
typedef DCompositionCreateDevice2Dart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Void>);
final DCompositionCreateDevice2 = DynamicLibrary.open('dcomp.dll')
.lookupFunction<DCompositionCreateDevice2Native, DCompositionCreateDevice2Dart>('DCompositionCreateDevice2');
// renderingDevice : IUnknown* optional -> Pointer<Void>
// iid : GUID* -> Pointer<Void>
// dcompositionDevice : void** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function DCompositionCreateDevice2(
renderingDevice: Pointer; // IUnknown* optional
iid: PGUID; // GUID*
dcompositionDevice: Pointer // void** out
): Integer; stdcall;
external 'dcomp.dll' name 'DCompositionCreateDevice2';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "DCompositionCreateDevice2"
c_DCompositionCreateDevice2 :: Ptr () -> Ptr () -> Ptr () -> IO Int32
-- renderingDevice : IUnknown* optional -> Ptr ()
-- iid : GUID* -> Ptr ()
-- dcompositionDevice : void** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let dcompositioncreatedevice2 =
foreign "DCompositionCreateDevice2"
((ptr void) @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* renderingDevice : IUnknown* optional -> (ptr void) *)
(* iid : GUID* -> (ptr void) *)
(* dcompositionDevice : void** out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library dcomp (t "dcomp.dll"))
(cffi:use-foreign-library dcomp)
(cffi:defcfun ("DCompositionCreateDevice2" dcomposition-create-device2 :convention :stdcall) :int32
(rendering-device :pointer) ; IUnknown* optional
(iid :pointer) ; GUID*
(dcomposition-device :pointer)) ; void** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $DCompositionCreateDevice2 = Win32::API::More->new('dcomp',
'int DCompositionCreateDevice2(LPVOID renderingDevice, LPVOID iid, LPVOID dcompositionDevice)');
# my $ret = $DCompositionCreateDevice2->Call($renderingDevice, $iid, $dcompositionDevice);
# renderingDevice : IUnknown* optional -> LPVOID
# iid : GUID* -> LPVOID
# dcompositionDevice : void** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f DCompositionCreateDevice — DirectComposition合成デバイスを作成する。
- f DCompositionCreateDevice3 — 拡張機能対応のDirectComposition合成デバイスを作成する。