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

CreateDXGIFactory1

関数
DXGI 1.1ファクトリオブジェクトを作成する。
DLLdxgi.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

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

HRESULT CreateDXGIFactory1(
    const GUID* riid,
    void** ppFactory
);

パラメーター

名前方向説明
riidGUID*inppFactory パラメーターが参照する IDXGIFactory1 オブジェクトのグローバル一意識別子 (GUID)。
ppFactoryvoid**outIDXGIFactory1 オブジェクトへのポインターのアドレス。

戻り値の型: HRESULT

公式ドキュメント

他の DXGI オブジェクトを生成するために使用できる DXGI 1.1 ファクトリを作成します。

戻り値

型: HRESULT

成功した場合は S_OK を返します。それ以外の場合はエラーコードを返します。エラーコードの一覧については、DXGI_ERROR を参照してください。

解説(Remarks)

DXGI 1.1 ファクトリを使用すると、アダプターを列挙するスワップチェーンを作成する、フルスクリーン表示モードとの切り替えに使う alt+enter キーシーケンスにウィンドウを関連付ける、といったオブジェクトを生成できます。

CreateDXGIFactory1 関数が成功すると、IDXGIFactory1 インターフェイスの参照カウントがインクリメントされます。メモリリークを避けるため、インターフェイスの使用を終えたら IDXGIFactory1::Release メソッドを呼び出してインターフェイスを解放してください。

このエントリポイントは、Windows Vista および Windows Server 2008 に搭載された DXGI 1.0 ではサポートされていません。DXGI 1.1 のサポートが必要であり、これは Windows 7 および Windows Server 2008 R2 で利用できるほか、Service Pack 2 (SP2) 適用済みの Windows Vista (KB 971644) および Windows Server 2008 (KB 971512) の更新プログラムとして提供されます。

メモ 1 つのアプリケーション内で DXGI 1.0 (IDXGIFactory) と DXGI 1.1 (IDXGIFactory1) を混在させないでください。アプリケーションでは IDXGIFactory または IDXGIFactory1 のいずれか一方を使用し、両方を使用しないでください。
メモ アプリの DllMain 関数から呼び出した場合、CreateDXGIFactory1 は失敗します。DllMain からの DXGI の応答の詳細については、DXGI Responses from DLLMain を参照してください。
メモ Windows 8 以降では、すべての DXGI ファクトリは (CreateDXGIFactoryCreateDXGIFactory1 のどちらで作成されたかにかかわらず) 同じ方法でアダプターを列挙します。IDXGIFactory::EnumAdapters または IDXGIFactory1::EnumAdapters1 で取得するアダプターの列挙順序は次のとおりです。
  • デスクトップのプライマリが表示される出力を持つアダプター。このアダプターのインデックスは 0 になります。
  • 出力を持つアダプター。
  • 出力を持たないアダプター。

DXGI 1.1 ファクトリの作成

次のコード例は、DXGI 1.1 ファクトリを作成する方法を示しています。この例では、__uuidof() 組み込み関数を使用して IDXGIFactory1 インターフェイスの REFIID (GUID) を取得しています。


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

各言語での呼び出し定義

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

HRESULT CreateDXGIFactory1(
    const GUID* riid,
    void** ppFactory
);
[DllImport("dxgi.dll", ExactSpelling = true)]
static extern int CreateDXGIFactory1(
    ref Guid riid,   // GUID*
    IntPtr ppFactory   // void** out
);
<DllImport("dxgi.dll", ExactSpelling:=True)>
Public Shared Function CreateDXGIFactory1(
    ByRef riid As Guid,   ' GUID*
    ppFactory As IntPtr   ' void** out
) As Integer
End Function
' riid : GUID*
' ppFactory : void** out
Declare PtrSafe Function CreateDXGIFactory1 Lib "dxgi" ( _
    ByVal riid As LongPtr, _
    ByVal ppFactory As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CreateDXGIFactory1 = ctypes.windll.dxgi.CreateDXGIFactory1
CreateDXGIFactory1.restype = ctypes.c_int
CreateDXGIFactory1.argtypes = [
    ctypes.c_void_p,  # riid : GUID*
    ctypes.c_void_p,  # ppFactory : void** out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('dxgi.dll')
CreateDXGIFactory1 = Fiddle::Function.new(
  lib['CreateDXGIFactory1'],
  [
    Fiddle::TYPE_VOIDP,  # riid : GUID*
    Fiddle::TYPE_VOIDP,  # ppFactory : void** out
  ],
  Fiddle::TYPE_INT)
#[link(name = "dxgi")]
extern "system" {
    fn CreateDXGIFactory1(
        riid: *const GUID,  // GUID*
        ppFactory: *mut *mut ()  // void** out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("dxgi.dll")]
public static extern int CreateDXGIFactory1(ref Guid riid, IntPtr ppFactory);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dxgi_CreateDXGIFactory1' -Namespace Win32 -PassThru
# $api::CreateDXGIFactory1(riid, ppFactory)
#uselib "dxgi.dll"
#func global CreateDXGIFactory1 "CreateDXGIFactory1" sptr, sptr
; CreateDXGIFactory1 varptr(riid), ppFactory   ; 戻り値は stat
; riid : GUID* -> "sptr"
; ppFactory : void** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "dxgi.dll"
#cfunc global CreateDXGIFactory1 "CreateDXGIFactory1" var, sptr
; res = CreateDXGIFactory1(riid, ppFactory)
; riid : GUID* -> "var"
; ppFactory : void** out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT CreateDXGIFactory1(GUID* riid, void** ppFactory)
#uselib "dxgi.dll"
#cfunc global CreateDXGIFactory1 "CreateDXGIFactory1" var, intptr
; res = CreateDXGIFactory1(riid, ppFactory)
; riid : GUID* -> "var"
; ppFactory : void** out -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	dxgi = windows.NewLazySystemDLL("dxgi.dll")
	procCreateDXGIFactory1 = dxgi.NewProc("CreateDXGIFactory1")
)

// riid (GUID*), ppFactory (void** out)
r1, _, err := procCreateDXGIFactory1.Call(
	uintptr(riid),
	uintptr(ppFactory),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function CreateDXGIFactory1(
  riid: PGUID;   // GUID*
  ppFactory: Pointer   // void** out
): Integer; stdcall;
  external 'dxgi.dll' name 'CreateDXGIFactory1';
result := DllCall("dxgi\CreateDXGIFactory1"
    , "Ptr", riid   ; GUID*
    , "Ptr", ppFactory   ; void** out
    , "Int")   ; return: HRESULT
●CreateDXGIFactory1(riid, ppFactory) = DLL("dxgi.dll", "int CreateDXGIFactory1(void*, void*)")
# 呼び出し: CreateDXGIFactory1(riid, ppFactory)
# riid : GUID* -> "void*"
# ppFactory : void** out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "dxgi" fn CreateDXGIFactory1(
    riid: [*c]GUID, // GUID*
    ppFactory: ?*anyopaque // void** out
) callconv(std.os.windows.WINAPI) i32;
proc CreateDXGIFactory1(
    riid: ptr GUID,  # GUID*
    ppFactory: pointer  # void** out
): int32 {.importc: "CreateDXGIFactory1", stdcall, dynlib: "dxgi.dll".}
pragma(lib, "dxgi");
extern(Windows)
int CreateDXGIFactory1(
    GUID* riid,   // GUID*
    void** ppFactory   // void** out
);
ccall((:CreateDXGIFactory1, "dxgi.dll"), stdcall, Int32,
      (Ptr{GUID}, Ptr{Cvoid}),
      riid, ppFactory)
# riid : GUID* -> Ptr{GUID}
# ppFactory : void** out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t CreateDXGIFactory1(
    void* riid,
    void** ppFactory);
]]
local dxgi = ffi.load("dxgi")
-- dxgi.CreateDXGIFactory1(riid, ppFactory)
-- riid : GUID*
-- ppFactory : void** out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('dxgi.dll');
const CreateDXGIFactory1 = lib.func('__stdcall', 'CreateDXGIFactory1', 'int32_t', ['void *', 'void *']);
// CreateDXGIFactory1(riid, ppFactory)
// riid : GUID* -> 'void *'
// ppFactory : void** out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("dxgi.dll", {
  CreateDXGIFactory1: { parameters: ["pointer", "pointer"], result: "i32" },
});
// lib.symbols.CreateDXGIFactory1(riid, ppFactory)
// riid : GUID* -> "pointer"
// ppFactory : void** out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t CreateDXGIFactory1(
    void* riid,
    void** ppFactory);
C, "dxgi.dll");
// $ffi->CreateDXGIFactory1(riid, ppFactory);
// riid : GUID*
// ppFactory : 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 Dxgi extends StdCallLibrary {
    Dxgi INSTANCE = Native.load("dxgi", Dxgi.class);
    int CreateDXGIFactory1(
        Pointer riid,   // GUID*
        Pointer ppFactory   // void** out
    );
}
@[Link("dxgi")]
lib Libdxgi
  fun CreateDXGIFactory1 = CreateDXGIFactory1(
    riid : GUID*,   # GUID*
    ppFactory : 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 CreateDXGIFactory1Native = Int32 Function(Pointer<Void>, Pointer<Void>);
typedef CreateDXGIFactory1Dart = int Function(Pointer<Void>, Pointer<Void>);
final CreateDXGIFactory1 = DynamicLibrary.open('dxgi.dll')
    .lookupFunction<CreateDXGIFactory1Native, CreateDXGIFactory1Dart>('CreateDXGIFactory1');
// riid : GUID* -> Pointer<Void>
// ppFactory : void** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CreateDXGIFactory1(
  riid: PGUID;   // GUID*
  ppFactory: Pointer   // void** out
): Integer; stdcall;
  external 'dxgi.dll' name 'CreateDXGIFactory1';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CreateDXGIFactory1"
  c_CreateDXGIFactory1 :: Ptr () -> Ptr () -> IO Int32
-- riid : GUID* -> Ptr ()
-- ppFactory : void** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let createdxgifactory1 =
  foreign "CreateDXGIFactory1"
    ((ptr void) @-> (ptr void) @-> returning int32_t)
(* riid : GUID* -> (ptr void) *)
(* ppFactory : void** out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library dxgi (t "dxgi.dll"))
(cffi:use-foreign-library dxgi)

(cffi:defcfun ("CreateDXGIFactory1" create-dxgifactory1 :convention :stdcall) :int32
  (riid :pointer)   ; GUID*
  (pp-factory :pointer))   ; void** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CreateDXGIFactory1 = Win32::API::More->new('dxgi',
    'int CreateDXGIFactory1(LPVOID riid, LPVOID ppFactory)');
# my $ret = $CreateDXGIFactory1->Call($riid, $ppFactory);
# riid : GUID* -> LPVOID
# ppFactory : void** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API