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 ##########################################################################/
27 from dxgitype import *
30 IDXGIObject = Interface("IDXGIObject", IUnknown)
31 IDXGIDeviceSubObject = Interface("IDXGIDeviceSubObject", IDXGIObject)
32 IDXGIResource = Interface("IDXGIResource", IDXGIDeviceSubObject)
33 IDXGIKeyedMutex = Interface("IDXGIKeyedMutex", IDXGIDeviceSubObject)
34 IDXGISurface = Interface("IDXGISurface", IDXGIDeviceSubObject)
35 IDXGISurface1 = Interface("IDXGISurface1", IDXGISurface)
36 IDXGIAdapter = Interface("IDXGIAdapter", IDXGIObject)
37 IDXGIOutput = Interface("IDXGIOutput", IDXGIObject)
38 IDXGISwapChain = Interface("IDXGISwapChain", IDXGIDeviceSubObject)
39 IDXGIFactory = Interface("IDXGIFactory", IDXGIObject)
40 IDXGIDevice = Interface("IDXGIDevice", IDXGIObject)
41 IDXGIFactory1 = Interface("IDXGIFactory1", IDXGIFactory)
42 IDXGIAdapter1 = Interface("IDXGIAdapter1", IDXGIAdapter)
43 IDXGIDevice1 = Interface("IDXGIDevice1", IDXGIDevice)
46 DXGI_USAGE = Flags(UINT, [
47 "DXGI_CPU_ACCESS_NONE", # 0
48 "DXGI_CPU_ACCESS_SCRATCH", # 3
49 "DXGI_CPU_ACCESS_DYNAMIC", # 1
50 "DXGI_CPU_ACCESS_READ_WRITE", # 2
51 "DXGI_USAGE_SHADER_INPUT",
52 "DXGI_USAGE_RENDER_TARGET_OUTPUT",
53 "DXGI_USAGE_BACK_BUFFER",
55 "DXGI_USAGE_READ_ONLY",
56 "DXGI_USAGE_DISCARD_ON_PRESENT",
57 "DXGI_USAGE_UNORDERED_ACCESS",
60 DXGI_FRAME_STATISTICS = Struct("DXGI_FRAME_STATISTICS", [
61 (UINT, "PresentCount"),
62 (UINT, "PresentRefreshCount"),
63 (UINT, "SyncRefreshCount"),
64 (LARGE_INTEGER, "SyncQPCTime"),
65 (LARGE_INTEGER, "SyncGPUTime"),
68 DXGI_MAPPED_RECT = Struct("DXGI_MAPPED_RECT", [
70 (OpaquePointer(BYTE), "pBits"),
73 DXGI_ADAPTER_DESC = Struct("DXGI_ADAPTER_DESC", [
74 (WString, "Description"),
79 (SIZE_T, "DedicatedVideoMemory"),
80 (SIZE_T, "DedicatedSystemMemory"),
81 (SIZE_T, "SharedSystemMemory"),
82 (LUID, "AdapterLuid"),
85 DXGI_OUTPUT_DESC = Struct("DXGI_OUTPUT_DESC", [
86 (WString, "DeviceName"),
87 (RECT, "DesktopCoordinates"),
88 (BOOL, "AttachedToDesktop"),
89 (DXGI_MODE_ROTATION, "Rotation"),
90 (HMONITOR, "Monitor"),
93 DXGI_SHARED_RESOURCE = Struct("DXGI_SHARED_RESOURCE", [
97 DXGI_RESOURCE_PRIORITY = FakeEnum(UINT, [
98 "DXGI_RESOURCE_PRIORITY_MINIMUM",
99 "DXGI_RESOURCE_PRIORITY_LOW",
100 "DXGI_RESOURCE_PRIORITY_NORMAL",
101 "DXGI_RESOURCE_PRIORITY_HIGH",
102 "DXGI_RESOURCE_PRIORITY_MAXIMUM",
105 DXGI_RESIDENCY = Enum("DXGI_RESIDENCY", [
106 "DXGI_RESIDENCY_FULLY_RESIDENT",
107 "DXGI_RESIDENCY_RESIDENT_IN_SHARED_MEMORY",
108 "DXGI_RESIDENCY_EVICTED_TO_DISK",
111 DXGI_SURFACE_DESC = Struct("DXGI_SURFACE_DESC", [
114 (DXGI_FORMAT, "Format"),
115 (DXGI_SAMPLE_DESC, "SampleDesc"),
118 DXGI_SWAP_EFFECT = Enum("DXGI_SWAP_EFFECT", [
119 "DXGI_SWAP_EFFECT_DISCARD",
120 "DXGI_SWAP_EFFECT_SEQUENTIAL",
123 DXGI_SWAP_CHAIN_FLAG = Flags(UINT, [
124 "DXGI_SWAP_CHAIN_FLAG_NONPREROTATED",
125 "DXGI_SWAP_CHAIN_FLAG_ALLOW_MODE_SWITCH",
126 "DXGI_SWAP_CHAIN_FLAG_GDI_COMPATIBLE",
129 DXGI_SWAP_CHAIN_DESC = Struct("DXGI_SWAP_CHAIN_DESC", [
130 (DXGI_MODE_DESC, "BufferDesc"),
131 (DXGI_SAMPLE_DESC, "SampleDesc"),
132 (DXGI_USAGE, "BufferUsage"),
133 (UINT, "BufferCount"),
134 (HWND, "OutputWindow"),
136 (DXGI_SWAP_EFFECT, "SwapEffect"),
137 (DXGI_SWAP_CHAIN_FLAG, "Flags"),
140 IDXGIObject.methods += [
141 StdMethod(HRESULT, "SetPrivateData", [(REFGUID, "Name"), (UINT, "DataSize"), (OpaqueBlob(Const(Void), "DataSize"), "pData")], sideeffects=False),
142 StdMethod(HRESULT, "SetPrivateDataInterface", [(REFGUID, "Name"), (OpaquePointer(Const(IUnknown)), "pUnknown")], sideeffects=False),
143 StdMethod(HRESULT, "GetPrivateData", [(REFGUID, "Name"), Out(Pointer(UINT), "pDataSize"), Out(OpaquePointer(Void), "pData")], sideeffects=False),
144 StdMethod(HRESULT, "GetParent", [(REFIID, "riid"), Out(Pointer(ObjPointer(Void)), "ppParent")]),
147 IDXGIDeviceSubObject.methods += [
148 StdMethod(HRESULT, "GetDevice", [(REFIID, "riid"), Out(Pointer(ObjPointer(Void)), "ppDevice")]),
151 IDXGIResource.methods += [
152 StdMethod(HRESULT, "GetSharedHandle", [Out(Pointer(HANDLE), "pSharedHandle")]),
153 StdMethod(HRESULT, "GetUsage", [Out(Pointer(DXGI_USAGE), "pUsage")], sideeffects=False),
154 StdMethod(HRESULT, "SetEvictionPriority", [(DXGI_RESOURCE_PRIORITY, "EvictionPriority")]),
155 StdMethod(HRESULT, "GetEvictionPriority", [Out(Pointer(DXGI_RESOURCE_PRIORITY), "pEvictionPriority")], sideeffects=False),
158 IDXGIKeyedMutex.methods += [
159 StdMethod(HRESULT, "AcquireSync", [(UINT64, "Key"), (DWORD, "dwMilliseconds")]),
160 StdMethod(HRESULT, "ReleaseSync", [(UINT64, "Key")]),
163 DXGI_MAP = Flags(UINT, [
169 IDXGISurface.methods += [
170 StdMethod(HRESULT, "GetDesc", [Out(Pointer(DXGI_SURFACE_DESC), "pDesc")], sideeffects=False),
171 StdMethod(HRESULT, "Map", [Out(Pointer(DXGI_MAPPED_RECT), "pLockedRect"), (DXGI_MAP, "MapFlags")]),
172 StdMethod(HRESULT, "Unmap", []),
175 IDXGISurface1.methods += [
176 StdMethod(HRESULT, "GetDC", [(BOOL, "Discard"), Out(Pointer(HDC), "phdc")]),
177 StdMethod(HRESULT, "ReleaseDC", [(Pointer(RECT), "pDirtyRect")]),
180 IDXGIAdapter.methods += [
181 StdMethod(HRESULT, "EnumOutputs", [(UINT, "Output"), Out(Pointer(ObjPointer(IDXGIOutput)), "ppOutput")]),
182 StdMethod(HRESULT, "GetDesc", [Out(Pointer(DXGI_ADAPTER_DESC), "pDesc")], sideeffects=False),
183 StdMethod(HRESULT, "CheckInterfaceSupport", [(REFGUID, "InterfaceName"), Out(Pointer(LARGE_INTEGER), "pUMDVersion")], sideeffects=False),
186 DXGI_ENUM_MODES = Flags(UINT, [
187 "DXGI_ENUM_MODES_INTERLACED",
188 "DXGI_ENUM_MODES_SCALING",
191 IDXGIOutput.methods += [
192 StdMethod(HRESULT, "GetDesc", [Out(Pointer(DXGI_OUTPUT_DESC), "pDesc")], sideeffects=False),
193 StdMethod(HRESULT, "GetDisplayModeList", [(DXGI_FORMAT, "EnumFormat"), (DXGI_ENUM_MODES, "Flags"), Out(Pointer(UINT), "pNumModes"), Out(Array(DXGI_MODE_DESC, "*pNumModes"), "pDesc")], sideeffects=False),
194 StdMethod(HRESULT, "FindClosestMatchingMode", [(Pointer(Const(DXGI_MODE_DESC)), "pModeToMatch"), Out(Pointer(DXGI_MODE_DESC), "pClosestMatch"), (ObjPointer(IUnknown), "pConcernedDevice")]),
195 StdMethod(HRESULT, "WaitForVBlank", []),
196 StdMethod(HRESULT, "TakeOwnership", [(ObjPointer(IUnknown), "pDevice"), (BOOL, "Exclusive")]),
197 StdMethod(Void, "ReleaseOwnership", []),
198 StdMethod(HRESULT, "GetGammaControlCapabilities", [Out(Pointer(DXGI_GAMMA_CONTROL_CAPABILITIES), "pGammaCaps")]),
199 StdMethod(HRESULT, "SetGammaControl", [(Pointer(Const(DXGI_GAMMA_CONTROL)), "pArray")]),
200 StdMethod(HRESULT, "GetGammaControl", [Out(Pointer(DXGI_GAMMA_CONTROL), "pArray")], sideeffects=False),
201 StdMethod(HRESULT, "SetDisplaySurface", [(ObjPointer(IDXGISurface), "pScanoutSurface")]),
202 StdMethod(HRESULT, "GetDisplaySurfaceData", [(ObjPointer(IDXGISurface), "pDestination")]),
203 StdMethod(HRESULT, "GetFrameStatistics", [Out(Pointer(DXGI_FRAME_STATISTICS), "pStats")], sideeffects=False),
206 DXGI_PRESENT = Flags(UINT, [
208 "DXGI_PRESENT_DO_NOT_SEQUENCE",
209 "DXGI_PRESENT_RESTART",
212 IDXGISwapChain.methods += [
213 StdMethod(HRESULT, "Present", [(UINT, "SyncInterval"), (DXGI_PRESENT, "Flags")]),
214 StdMethod(HRESULT, "GetBuffer", [(UINT, "Buffer"), (REFIID, "riid"), Out(Pointer(ObjPointer(Void)), "ppSurface")]),
215 StdMethod(HRESULT, "SetFullscreenState", [(BOOL, "Fullscreen"), (ObjPointer(IDXGIOutput), "pTarget")]),
216 StdMethod(HRESULT, "GetFullscreenState", [Out(Pointer(BOOL), "pFullscreen"), Out(Pointer(ObjPointer(IDXGIOutput)), "ppTarget")]),
217 StdMethod(HRESULT, "GetDesc", [Out(Pointer(DXGI_SWAP_CHAIN_DESC), "pDesc")], sideeffects=False),
218 StdMethod(HRESULT, "ResizeBuffers", [(UINT, "BufferCount"), (UINT, "Width"), (UINT, "Height"), (DXGI_FORMAT, "NewFormat"), (DXGI_SWAP_CHAIN_FLAG, "SwapChainFlags")]),
219 StdMethod(HRESULT, "ResizeTarget", [(Pointer(Const(DXGI_MODE_DESC)), "pNewTargetParameters")]),
220 StdMethod(HRESULT, "GetContainingOutput", [Out(Pointer(ObjPointer(IDXGIOutput)), "ppOutput")]),
221 StdMethod(HRESULT, "GetFrameStatistics", [Out(Pointer(DXGI_FRAME_STATISTICS), "pStats")], sideeffects=False),
222 StdMethod(HRESULT, "GetLastPresentCount", [Out(Pointer(UINT), "pLastPresentCount")], sideeffects=False),
225 DXGI_MWA = Flags(UINT, [
226 "DXGI_MWA_NO_WINDOW_CHANGES",
227 "DXGI_MWA_NO_ALT_ENTER",
228 "DXGI_MWA_NO_PRINT_SCREEN",
232 IDXGIFactory.methods += [
233 StdMethod(HRESULT, "EnumAdapters", [(UINT, "Adapter"), Out(Pointer(ObjPointer(IDXGIAdapter)), "ppAdapter")]),
234 StdMethod(HRESULT, "MakeWindowAssociation", [(HWND, "WindowHandle"), (DXGI_MWA, "Flags")]),
235 StdMethod(HRESULT, "GetWindowAssociation", [Out(Pointer(HWND), "pWindowHandle")], sideeffects=False),
236 StdMethod(HRESULT, "CreateSwapChain", [(ObjPointer(IUnknown), "pDevice"), (Pointer(DXGI_SWAP_CHAIN_DESC), "pDesc"), Out(Pointer(ObjPointer(IDXGISwapChain)), "ppSwapChain")]),
237 StdMethod(HRESULT, "CreateSoftwareAdapter", [(HMODULE, "Module"), Out(Pointer(ObjPointer(IDXGIAdapter)), "ppAdapter")]),
240 IDXGIDevice.methods += [
241 StdMethod(HRESULT, "GetAdapter", [Out(Pointer(ObjPointer(IDXGIAdapter)), "pAdapter")]),
242 StdMethod(HRESULT, "CreateSurface", [(Pointer(Const(DXGI_SURFACE_DESC)), "pDesc"), (UINT, "NumSurfaces"), (DXGI_USAGE, "Usage"), (Pointer(Const(DXGI_SHARED_RESOURCE)), "pSharedResource"), Out(Pointer(ObjPointer(IDXGISurface)), "ppSurface")]),
243 StdMethod(HRESULT, "QueryResourceResidency", [(Array(Const(ObjPointer(IUnknown)), "NumResources"), "ppResources"), Out(Array(DXGI_RESIDENCY, "NumResources"), "pResidencyStatus"), (UINT, "NumResources")], sideeffects=False),
244 StdMethod(HRESULT, "SetGPUThreadPriority", [(INT, "Priority")]),
245 StdMethod(HRESULT, "GetGPUThreadPriority", [Out(Pointer(INT), "pPriority")], sideeffects=False),
248 DXGI_ADAPTER_FLAG = Enum("DXGI_ADAPTER_FLAG", [
249 "DXGI_ADAPTER_FLAG_NONE",
250 "DXGI_ADAPTER_FLAG_REMOTE",
253 DXGI_ADAPTER_DESC1 = Struct("DXGI_ADAPTER_DESC1", [
254 (WString, "Description"),
259 (SIZE_T, "DedicatedVideoMemory"),
260 (SIZE_T, "DedicatedSystemMemory"),
261 (SIZE_T, "SharedSystemMemory"),
262 (LUID, "AdapterLuid"),
266 DXGI_DISPLAY_COLOR_SPACE = Struct("DXGI_DISPLAY_COLOR_SPACE", [
267 (Array(Array(FLOAT, 8), 2), "PrimaryCoordinates"),
268 (Array(Array(FLOAT, 16), 2), "WhitePoints"),
271 IDXGIFactory1.methods += [
272 StdMethod(HRESULT, "EnumAdapters1", [(UINT, "Adapter"), Out(Pointer(ObjPointer(IDXGIAdapter1)), "ppAdapter")]),
273 StdMethod(BOOL, "IsCurrent", []),
276 IDXGIAdapter1.methods += [
277 StdMethod(HRESULT, "GetDesc1", [Out(Pointer(DXGI_ADAPTER_DESC1), "pDesc")], sideeffects=False),
280 IDXGIDevice1.methods += [
281 StdMethod(HRESULT, "SetMaximumFrameLatency", [(UINT, "MaxLatency")]),
282 StdMethod(HRESULT, "GetMaximumFrameLatency", [Out(Pointer(UINT), "pMaxLatency")], sideeffects=False),
286 IDXGIFactoryDWM = Interface("IDXGIFactoryDWM", IUnknown)
287 IDXGISwapChainDWM = Interface("IDXGISwapChainDWM", IDXGIDeviceSubObject)
289 IDXGIFactoryDWM.methods += [
290 StdMethod(HRESULT, "CreateSwapChain", [(ObjPointer(IUnknown), "pDevice"), (Pointer(DXGI_SWAP_CHAIN_DESC), "pDesc"), (ObjPointer(IDXGIOutput), "pOutput"), Out(Pointer(ObjPointer(IDXGISwapChainDWM)), "ppSwapChain")]),
293 IDXGISwapChainDWM.methods += [
294 StdMethod(HRESULT, "Present", [(UINT, "SyncInterval"), (DXGI_PRESENT, "Flags")]),
295 StdMethod(HRESULT, "GetBuffer", [(UINT, "Buffer"), (REFIID, "riid"), Out(Pointer(ObjPointer(Void)), "ppSurface")]),
296 StdMethod(HRESULT, "GetDesc", [Out(Pointer(DXGI_SWAP_CHAIN_DESC), "pDesc")], sideeffects=False),
297 StdMethod(HRESULT, "ResizeBuffers", [(UINT, "BufferCount"), (UINT, "Width"), (UINT, "Height"), (DXGI_FORMAT, "NewFormat"), (DXGI_SWAP_CHAIN_FLAG, "SwapChainFlags")]),
298 StdMethod(HRESULT, "ResizeTarget", [(Pointer(Const(DXGI_MODE_DESC)), "pNewTargetParameters")]),
299 StdMethod(HRESULT, "GetContainingOutput", [Out(Pointer(ObjPointer(IDXGIOutput)), "ppOutput")]),
300 StdMethod(HRESULT, "GetFrameStatistics", [(Pointer(DXGI_FRAME_STATISTICS), "pStats")], sideeffects=False),
301 StdMethod(HRESULT, "GetLastPresentCount", [(Pointer(UINT), "pLastPresentCount")], sideeffects=False),
302 StdMethod(HRESULT, "SetFullscreenState", [(BOOL, "Fullscreen"), (ObjPointer(IDXGIOutput), "pTarget")]),
303 StdMethod(HRESULT, "GetFullscreenState", [Out(Pointer(BOOL), "pFullscreen"), Out(Pointer(ObjPointer(IDXGIOutput)), "ppTarget")]),
307 dxgi = Module('dxgi')
313 StdFunction(HRESULT, "CreateDXGIFactory", [(REFIID, "riid"), Out(Pointer(ObjPointer(Void)), "ppFactory")]),
314 StdFunction(HRESULT, "CreateDXGIFactory1", [(REFIID, "riid"), Out(Pointer(ObjPointer(Void)), "ppFactory")]),