1 ##########################################################################
3 # Copyright 2011 Jose Fonseca
6 # Permission is hereby granted, free of charge, to any person obtaining a copy
7 # of this software and associated documentation files (the "Software"), to deal
8 # in the Software without restriction, including without limitation the rights
9 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 # copies of the Software, and to permit persons to whom the Software is
11 # furnished to do so, subject to the following conditions:
13 # The above copyright notice and this permission notice shall be included in
14 # all copies or substantial portions of the Software.
16 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 ##########################################################################/
26 from dxgitype import *
28 HMONITOR = Alias("HMONITOR", HANDLE)
29 _LUID = Struct("_LUID", [
34 DXGI_USAGE = Alias("DXGI_USAGE", UINT)
35 DXGI_SWAP_EFFECT = Enum("DXGI_SWAP_EFFECT", [
36 "DXGI_SWAP_EFFECT_DISCARD",
37 "DXGI_SWAP_EFFECT_SEQUENTIAL",
40 DXGI_RESIDENCY = Enum("DXGI_RESIDENCY", [
41 "DXGI_RESIDENCY_FULLY_RESIDENT",
42 "DXGI_RESIDENCY_RESIDENT_IN_SHARED_MEMORY",
43 "DXGI_RESIDENCY_EVICTED_TO_DISK",
46 DXGI_SURFACE_DESC = Struct("DXGI_SURFACE_DESC", [
49 (DXGI_FORMAT, "Format"),
50 (DXGI_SAMPLE_DESC, "SampleDesc"),
53 DXGI_MAPPED_RECT = Struct("DXGI_MAPPED_RECT", [
55 (OpaquePointer(BYTE), "pBits"),
58 DXGI_OUTPUT_DESC = Struct("DXGI_OUTPUT_DESC", [
59 (Array(WCHAR, "32"), "DeviceName"),
60 (RECT, "DesktopCoordinates"),
61 (BOOL, "AttachedToDesktop"),
62 (DXGI_MODE_ROTATION, "Rotation"),
63 (HMONITOR, "Monitor"),
66 DXGI_FRAME_STATISTICS = Struct("DXGI_FRAME_STATISTICS", [
67 (UINT, "PresentCount"),
68 (UINT, "PresentRefreshCount"),
69 (UINT, "SyncRefreshCount"),
70 (LARGE_INTEGER, "SyncQPCTime"),
71 (LARGE_INTEGER, "SyncGPUTime"),
74 DXGI_ADAPTER_DESC = Struct("DXGI_ADAPTER_DESC", [
75 (Array(WCHAR, "128"), "Description"),
80 (SIZE_T, "DedicatedVideoMemory"),
81 (SIZE_T, "DedicatedSystemMemory"),
82 (SIZE_T, "SharedSystemMemory"),
83 (LUID, "AdapterLuid"),
86 DXGI_SWAP_CHAIN_FLAG = Enum("DXGI_SWAP_CHAIN_FLAG", [
87 "DXGI_SWAP_CHAIN_FLAG_NONPREROTATED",
88 "DXGI_SWAP_CHAIN_FLAG_ALLOW_MODE_SWITCH",
89 "DXGI_SWAP_CHAIN_FLAG_GDI_COMPATIBLE",
92 DXGI_SWAP_CHAIN_DESC = Struct("DXGI_SWAP_CHAIN_DESC", [
93 (DXGI_MODE_DESC, "BufferDesc"),
94 (DXGI_SAMPLE_DESC, "SampleDesc"),
95 (DXGI_USAGE, "BufferUsage"),
96 (UINT, "BufferCount"),
97 (HWND, "OutputWindow"),
99 (DXGI_SWAP_EFFECT, "SwapEffect"),
103 DXGI_SHARED_RESOURCE = Struct("DXGI_SHARED_RESOURCE", [
107 IDXGIObject = Interface("IDXGIObject", IUnknown)
108 IDXGIObject.methods += [
109 Method(HRESULT, "SetPrivateData", [(REFGUID, "guid"), (UINT, "data_size"), (OpaquePointer(Const(Void)), "data")]),
110 Method(HRESULT, "SetPrivateDataInterface", [(REFGUID, "guid"), (OpaquePointer(Const(IUnknown)), "object")]),
111 Method(HRESULT, "GetPrivateData", [(REFGUID, "guid"), Out(OpaquePointer(UINT), "data_size"), Out(OpaquePointer(Void), "data")]),
112 Method(HRESULT, "GetParent", [(REFIID, "riid"), Out(OpaquePointer(OpaquePointer(Void)), "parent")]),
115 IDXGIDeviceSubObject = Interface("IDXGIDeviceSubObject", IDXGIObject)
116 IDXGIDeviceSubObject.methods += [
117 Method(HRESULT, "GetDevice", [(REFIID, "riid"), Out(OpaquePointer(OpaquePointer(Void)), "device")]),
120 IDXGISurface = Interface("IDXGISurface", IDXGIDeviceSubObject)
121 IDXGISurface.methods += [
122 Method(HRESULT, "GetDesc", [Out(OpaquePointer(DXGI_SURFACE_DESC), "desc")]),
123 Method(HRESULT, "Map", [Out(OpaquePointer(DXGI_MAPPED_RECT), "mapped_rect"), (UINT, "flags")]),
124 Method(HRESULT, "Unmap", []),
127 IDXGIOutput = Interface("IDXGIOutput", IDXGIObject)
128 IDXGIOutput.methods += [
129 Method(HRESULT, "GetDesc", [Out(OpaquePointer(DXGI_OUTPUT_DESC), "desc")]),
130 Method(HRESULT, "GetDisplayModeList", [(DXGI_FORMAT, "format"), (UINT, "flags"), Out(OpaquePointer(UINT), "mode_count"), Out(OpaquePointer(DXGI_MODE_DESC), "desc")]),
131 Method(HRESULT, "FindClosestMatchingMode", [(Const(OpaquePointer(DXGI_MODE_DESC)), "mode"), Out(OpaquePointer(DXGI_MODE_DESC), "closest_match"), (OpaquePointer(IUnknown), "device")]),
132 Method(HRESULT, "WaitForVBlank", []),
133 Method(HRESULT, "TakeOwnership", [(OpaquePointer(IUnknown), "device"), (BOOL, "exclusive")]),
134 Method(Void, "ReleaseOwnership", []),
135 Method(HRESULT, "GetGammaControlCapabilities", [Out(OpaquePointer(DXGI_GAMMA_CONTROL_CAPABILITIES), "gamma_caps")]),
136 Method(HRESULT, "SetGammaControl", [(Const(OpaquePointer(DXGI_GAMMA_CONTROL)), "gamma_control")]),
137 Method(HRESULT, "GetGammaControl", [Out(OpaquePointer(DXGI_GAMMA_CONTROL), "gamma_control")]),
138 Method(HRESULT, "SetDisplaySurface", [(OpaquePointer(IDXGISurface), "surface")]),
139 Method(HRESULT, "GetDisplaySurfaceData", [(OpaquePointer(IDXGISurface), "surface")]),
140 Method(HRESULT, "GetFrameStatistics", [Out(OpaquePointer(DXGI_FRAME_STATISTICS), "stats")]),
143 IDXGIAdapter = Interface("IDXGIAdapter", IDXGIObject)
144 IDXGIAdapter.methods += [
145 Method(HRESULT, "EnumOutputs", [(UINT, "output_idx"), Out(OpaquePointer(OpaquePointer(IDXGIOutput)), "output")]),
146 Method(HRESULT, "GetDesc", [Out(OpaquePointer(DXGI_ADAPTER_DESC), "desc")]),
147 Method(HRESULT, "CheckInterfaceSupport", [(REFGUID, "guid"), Out(OpaquePointer(LARGE_INTEGER), "umd_version")]),
150 IDXGISwapChain = Interface("IDXGISwapChain", IDXGIDeviceSubObject)
151 IDXGISwapChain.methods += [
152 Method(HRESULT, "Present", [(UINT, "sync_interval"), (UINT, "flags")]),
153 Method(HRESULT, "GetBuffer", [(UINT, "buffer_idx"), (REFIID, "riid"), Out(OpaquePointer(OpaquePointer(Void)), "surface")]),
154 Method(HRESULT, "SetFullscreenState", [(BOOL, "fullscreen"), (OpaquePointer(IDXGIOutput), "target")]),
155 Method(HRESULT, "GetFullscreenState", [Out(OpaquePointer(BOOL), "fullscreen"), Out(OpaquePointer(OpaquePointer(IDXGIOutput)), "target")]),
156 Method(HRESULT, "GetDesc", [Out(OpaquePointer(DXGI_SWAP_CHAIN_DESC), "desc")]),
157 Method(HRESULT, "ResizeBuffers", [(UINT, "buffer_count"), (UINT, "width"), (UINT, "height"), (DXGI_FORMAT, "format"), (UINT, "flags")]),
158 Method(HRESULT, "ResizeTarget", [(OpaquePointer(Const(DXGI_MODE_DESC)), "target_mode_desc")]),
159 Method(HRESULT, "GetContainingOutput", [Out(OpaquePointer(OpaquePointer(IDXGIOutput)), "output")]),
160 Method(HRESULT, "GetFrameStatistics", [Out(OpaquePointer(DXGI_FRAME_STATISTICS), "stats")]),
161 Method(HRESULT, "GetLastPresentCount", [Out(OpaquePointer(UINT), "last_present_count")]),
164 IDXGIFactory = Interface("IDXGIFactory", IDXGIObject)
165 IDXGIFactory.methods += [
166 Method(HRESULT, "EnumAdapters", [(UINT, "adapter_idx"), Out(OpaquePointer(OpaquePointer(IDXGIAdapter)), "adapter")]),
167 Method(HRESULT, "MakeWindowAssociation", [(HWND, "window"), (UINT, "flags")]),
168 Method(HRESULT, "GetWindowAssociation", [(OpaquePointer(HWND), "window")]),
169 Method(HRESULT, "CreateSwapChain", [(OpaquePointer(IUnknown), "device"), (OpaquePointer(DXGI_SWAP_CHAIN_DESC), "desc"), Out(OpaquePointer(OpaquePointer(IDXGISwapChain)), "swapchain")]),
170 Method(HRESULT, "CreateSoftwareAdapter", [(HMODULE, "swrast"), Out(OpaquePointer(OpaquePointer(IDXGIAdapter)), "adapter")]),
173 #StdFunction(HRESULT, "CreateDXGIFactory", [(REFIID, "riid"), (OpaquePointer(OpaquePointer(Void)), "factory")]),
175 IDXGIDevice = Interface("IDXGIDevice", IDXGIObject)
176 IDXGIDevice.methods += [
177 Method(HRESULT, "GetAdapter", [Out(OpaquePointer(OpaquePointer(IDXGIAdapter)), "adapter")]),
178 Method(HRESULT, "CreateSurface", [(Const(OpaquePointer(DXGI_SURFACE_DESC)), "desc"), (UINT, "surface_count"), (DXGI_USAGE, "usage"), (Const(OpaquePointer(DXGI_SHARED_RESOURCE)), "shared_resource"), Out(OpaquePointer(OpaquePointer(IDXGISurface)), "surface")]),
179 Method(HRESULT, "QueryResourceResidency", [(OpaquePointer(Const(OpaquePointer(IUnknown))), "resources"), Out(OpaquePointer(DXGI_RESIDENCY), "residency"), (UINT, "resource_count")]),
180 Method(HRESULT, "SetGPUThreadPriority", [(INT, "priority")]),
181 Method(HRESULT, "GetGPUThreadPriority", [Out(OpaquePointer(INT), "priority")]),