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_FIELD",
48 "DXGI_CPU_ACCESS_NONE",
49 "DXGI_CPU_ACCESS_DYNAMIC",
50 "DXGI_CPU_ACCESS_READ_WRITE",
51 "DXGI_CPU_ACCESS_SCRATCH",
52 "DXGI_USAGE_SHADER_INPUT",
53 "DXGI_USAGE_RENDER_TARGET_OUTPUT",
54 "DXGI_USAGE_BACK_BUFFER",
56 "DXGI_USAGE_READ_ONLY",
57 "DXGI_USAGE_DISCARD_ON_PRESENT",
58 "DXGI_USAGE_UNORDERED_ACCESS",
61 DXGI_FRAME_STATISTICS = Struct("DXGI_FRAME_STATISTICS", [
62 (UINT, "PresentCount"),
63 (UINT, "PresentRefreshCount"),
64 (UINT, "SyncRefreshCount"),
65 (LARGE_INTEGER, "SyncQPCTime"),
66 (LARGE_INTEGER, "SyncGPUTime"),
69 DXGI_MAPPED_RECT = Struct("DXGI_MAPPED_RECT", [
71 (OpaquePointer(BYTE), "pBits"),
74 DXGI_ADAPTER_DESC = Struct("DXGI_ADAPTER_DESC", [
75 (WString, "Description"),
80 (SIZE_T, "DedicatedVideoMemory"),
81 (SIZE_T, "DedicatedSystemMemory"),
82 (SIZE_T, "SharedSystemMemory"),
83 (LUID, "AdapterLuid"),
86 DXGI_OUTPUT_DESC = Struct("DXGI_OUTPUT_DESC", [
87 (WString, "DeviceName"),
88 (RECT, "DesktopCoordinates"),
89 (BOOL, "AttachedToDesktop"),
90 (DXGI_MODE_ROTATION, "Rotation"),
91 (HMONITOR, "Monitor"),
94 DXGI_SHARED_RESOURCE = Struct("DXGI_SHARED_RESOURCE", [
98 DXGI_RESOURCE_PRIORITY = FakeEnum(UINT, [
99 "DXGI_RESOURCE_PRIORITY_MINIMUM",
100 "DXGI_RESOURCE_PRIORITY_LOW",
101 "DXGI_RESOURCE_PRIORITY_NORMAL",
102 "DXGI_RESOURCE_PRIORITY_HIGH",
103 "DXGI_RESOURCE_PRIORITY_MAXIMUM",
106 DXGI_RESIDENCY = Enum("DXGI_RESIDENCY", [
107 "DXGI_RESIDENCY_FULLY_RESIDENT",
108 "DXGI_RESIDENCY_RESIDENT_IN_SHARED_MEMORY",
109 "DXGI_RESIDENCY_EVICTED_TO_DISK",
112 DXGI_SURFACE_DESC = Struct("DXGI_SURFACE_DESC", [
115 (DXGI_FORMAT, "Format"),
116 (DXGI_SAMPLE_DESC, "SampleDesc"),
119 DXGI_SWAP_EFFECT = Enum("DXGI_SWAP_EFFECT", [
120 "DXGI_SWAP_EFFECT_DISCARD",
121 "DXGI_SWAP_EFFECT_SEQUENTIAL",
124 DXGI_SWAP_CHAIN_FLAG = Flags(UINT, [
125 "DXGI_SWAP_CHAIN_FLAG_NONPREROTATED",
126 "DXGI_SWAP_CHAIN_FLAG_ALLOW_MODE_SWITCH",
127 "DXGI_SWAP_CHAIN_FLAG_GDI_COMPATIBLE",
130 DXGI_SWAP_CHAIN_DESC = Struct("DXGI_SWAP_CHAIN_DESC", [
131 (DXGI_MODE_DESC, "BufferDesc"),
132 (DXGI_SAMPLE_DESC, "SampleDesc"),
133 (DXGI_USAGE, "BufferUsage"),
134 (UINT, "BufferCount"),
135 (HWND, "OutputWindow"),
137 (DXGI_SWAP_EFFECT, "SwapEffect"),
138 (DXGI_SWAP_CHAIN_FLAG, "Flags"),
141 IDXGIObject.methods += [
142 StdMethod(HRESULT, "SetPrivateData", [(REFGUID, "Name"), (UINT, "DataSize"), (OpaqueBlob(Const(Void), "DataSize"), "pData")]),
143 StdMethod(HRESULT, "SetPrivateDataInterface", [(REFGUID, "Name"), (OpaquePointer(Const(IUnknown)), "pUnknown")]),
144 StdMethod(HRESULT, "GetPrivateData", [(REFGUID, "Name"), Out(Pointer(UINT), "pDataSize"), Out(OpaquePointer(Void), "pData")]),
145 StdMethod(HRESULT, "GetParent", [(REFIID, "riid"), Out(Pointer(ObjPointer(Void)), "ppParent")]),
148 IDXGIDeviceSubObject.methods += [
149 StdMethod(HRESULT, "GetDevice", [(REFIID, "riid"), Out(Pointer(ObjPointer(Void)), "ppDevice")]),
152 IDXGIResource.methods += [
153 StdMethod(HRESULT, "GetSharedHandle", [Out(Pointer(HANDLE), "pSharedHandle")]),
154 StdMethod(HRESULT, "GetUsage", [Out(Pointer(DXGI_USAGE), "pUsage")]),
155 StdMethod(HRESULT, "SetEvictionPriority", [(DXGI_RESOURCE_PRIORITY, "EvictionPriority")]),
156 StdMethod(HRESULT, "GetEvictionPriority", [Out(Pointer(DXGI_RESOURCE_PRIORITY), "pEvictionPriority")]),
159 IDXGIKeyedMutex.methods += [
160 StdMethod(HRESULT, "AcquireSync", [(UINT64, "Key"), (DWORD, "dwMilliseconds")]),
161 StdMethod(HRESULT, "ReleaseSync", [(UINT64, "Key")]),
164 DXGI_MAP = Flags(UINT, [
170 IDXGISurface.methods += [
171 StdMethod(HRESULT, "GetDesc", [Out(Pointer(DXGI_SURFACE_DESC), "pDesc")]),
172 StdMethod(HRESULT, "Map", [Out(Pointer(DXGI_MAPPED_RECT), "pLockedRect"), (DXGI_MAP, "MapFlags")]),
173 StdMethod(HRESULT, "Unmap", []),
176 IDXGISurface1.methods += [
177 StdMethod(HRESULT, "GetDC", [(BOOL, "Discard"), Out(Pointer(HDC), "phdc")]),
178 StdMethod(HRESULT, "ReleaseDC", [(Pointer(RECT), "pDirtyRect")]),
181 IDXGIAdapter.methods += [
182 StdMethod(HRESULT, "EnumOutputs", [(UINT, "Output"), Out(Pointer(ObjPointer(IDXGIOutput)), "ppOutput")]),
183 StdMethod(HRESULT, "GetDesc", [Out(Pointer(DXGI_ADAPTER_DESC), "pDesc")]),
184 StdMethod(HRESULT, "CheckInterfaceSupport", [(REFGUID, "InterfaceName"), Out(Pointer(LARGE_INTEGER), "pUMDVersion")]),
187 DXGI_ENUM_MODES = Flags(UINT, [
188 "DXGI_ENUM_MODES_INTERLACED",
189 "DXGI_ENUM_MODES_SCALING",
192 IDXGIOutput.methods += [
193 StdMethod(HRESULT, "GetDesc", [Out(Pointer(DXGI_OUTPUT_DESC), "pDesc")]),
194 StdMethod(HRESULT, "GetDisplayModeList", [(DXGI_FORMAT, "EnumFormat"), (DXGI_ENUM_MODES, "Flags"), Out(Pointer(UINT), "pNumModes"), Out(Array(DXGI_MODE_DESC, "*pNumModes"), "pDesc")]),
195 StdMethod(HRESULT, "FindClosestMatchingMode", [(Pointer(Const(DXGI_MODE_DESC)), "pModeToMatch"), Out(Pointer(DXGI_MODE_DESC), "pClosestMatch"), (ObjPointer(IUnknown), "pConcernedDevice")]),
196 StdMethod(HRESULT, "WaitForVBlank", []),
197 StdMethod(HRESULT, "TakeOwnership", [(ObjPointer(IUnknown), "pDevice"), (BOOL, "Exclusive")]),
198 StdMethod(Void, "ReleaseOwnership", []),
199 StdMethod(HRESULT, "GetGammaControlCapabilities", [Out(Pointer(DXGI_GAMMA_CONTROL_CAPABILITIES), "pGammaCaps")]),
200 StdMethod(HRESULT, "SetGammaControl", [(Pointer(Const(DXGI_GAMMA_CONTROL)), "pArray")]),
201 StdMethod(HRESULT, "GetGammaControl", [Out(Pointer(DXGI_GAMMA_CONTROL), "pArray")]),
202 StdMethod(HRESULT, "SetDisplaySurface", [(ObjPointer(IDXGISurface), "pScanoutSurface")]),
203 StdMethod(HRESULT, "GetDisplaySurfaceData", [(ObjPointer(IDXGISurface), "pDestination")]),
204 StdMethod(HRESULT, "GetFrameStatistics", [Out(Pointer(DXGI_FRAME_STATISTICS), "pStats")]),
207 DXGI_PRESENT = Flags(UINT, [
209 "DXGI_PRESENT_DO_NOT_SEQUENCE",
210 "DXGI_PRESENT_RESTART",
213 IDXGISwapChain.methods += [
214 StdMethod(HRESULT, "Present", [(UINT, "SyncInterval"), (DXGI_PRESENT, "Flags")]),
215 StdMethod(HRESULT, "GetBuffer", [(UINT, "Buffer"), (REFIID, "riid"), Out(Pointer(ObjPointer(Void)), "ppSurface")]),
216 StdMethod(HRESULT, "SetFullscreenState", [(BOOL, "Fullscreen"), (ObjPointer(IDXGIOutput), "pTarget")]),
217 StdMethod(HRESULT, "GetFullscreenState", [Out(Pointer(BOOL), "pFullscreen"), Out(Pointer(ObjPointer(IDXGIOutput)), "ppTarget")]),
218 StdMethod(HRESULT, "GetDesc", [Out(Pointer(DXGI_SWAP_CHAIN_DESC), "pDesc")]),
219 StdMethod(HRESULT, "ResizeBuffers", [(UINT, "BufferCount"), (UINT, "Width"), (UINT, "Height"), (DXGI_FORMAT, "NewFormat"), (UINT, "SwapChainFlags")]),
220 StdMethod(HRESULT, "ResizeTarget", [(Pointer(Const(DXGI_MODE_DESC)), "pNewTargetParameters")]),
221 StdMethod(HRESULT, "GetContainingOutput", [Out(Pointer(ObjPointer(IDXGIOutput)), "ppOutput")]),
222 StdMethod(HRESULT, "GetFrameStatistics", [Out(Pointer(DXGI_FRAME_STATISTICS), "pStats")]),
223 StdMethod(HRESULT, "GetLastPresentCount", [Out(Pointer(UINT), "pLastPresentCount")]),
226 DXGI_MWA = Flags(UINT, [
227 "DXGI_MWA_NO_WINDOW_CHANGES",
228 "DXGI_MWA_NO_ALT_ENTER",
229 "DXGI_MWA_NO_PRINT_SCREEN",
233 IDXGIFactory.methods += [
234 StdMethod(HRESULT, "EnumAdapters", [(UINT, "Adapter"), Out(Pointer(ObjPointer(IDXGIAdapter)), "ppAdapter")]),
235 StdMethod(HRESULT, "MakeWindowAssociation", [(HWND, "WindowHandle"), (DXGI_MWA, "Flags")]),
236 StdMethod(HRESULT, "GetWindowAssociation", [Out(Pointer(HWND), "pWindowHandle")]),
237 StdMethod(HRESULT, "CreateSwapChain", [(ObjPointer(IUnknown), "pDevice"), (Pointer(DXGI_SWAP_CHAIN_DESC), "pDesc"), Out(Pointer(ObjPointer(IDXGISwapChain)), "ppSwapChain")]),
238 StdMethod(HRESULT, "CreateSoftwareAdapter", [(HMODULE, "Module"), Out(Pointer(ObjPointer(IDXGIAdapter)), "ppAdapter")]),
241 IDXGIDevice.methods += [
242 StdMethod(HRESULT, "GetAdapter", [Out(Pointer(ObjPointer(IDXGIAdapter)), "pAdapter")]),
243 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")]),
244 StdMethod(HRESULT, "QueryResourceResidency", [(Array(Const(ObjPointer(IUnknown)), "NumResources"), "ppResources"), Out(Array(DXGI_RESIDENCY, "NumResources"), "pResidencyStatus"), (UINT, "NumResources")]),
245 StdMethod(HRESULT, "SetGPUThreadPriority", [(INT, "Priority")]),
246 StdMethod(HRESULT, "GetGPUThreadPriority", [Out(Pointer(INT), "pPriority")]),
249 DXGI_ADAPTER_FLAG = Enum("DXGI_ADAPTER_FLAG", [
250 "DXGI_ADAPTER_FLAG_NONE",
251 "DXGI_ADAPTER_FLAG_REMOTE",
254 DXGI_ADAPTER_DESC1 = Struct("DXGI_ADAPTER_DESC1", [
255 (WString, "Description"),
260 (SIZE_T, "DedicatedVideoMemory"),
261 (SIZE_T, "DedicatedSystemMemory"),
262 (SIZE_T, "SharedSystemMemory"),
263 (LUID, "AdapterLuid"),
267 DXGI_DISPLAY_COLOR_SPACE = Struct("DXGI_DISPLAY_COLOR_SPACE", [
268 (Array(Array(FLOAT, 8), 2), "PrimaryCoordinates"),
269 (Array(Array(FLOAT, 16), 2), "WhitePoints"),
272 IDXGIFactory1.methods += [
273 StdMethod(HRESULT, "EnumAdapters1", [(UINT, "Adapter"), Out(Pointer(ObjPointer(IDXGIAdapter1)), "ppAdapter")]),
274 StdMethod(BOOL, "IsCurrent", []),
277 IDXGIAdapter1.methods += [
278 StdMethod(HRESULT, "GetDesc1", [Out(Pointer(DXGI_ADAPTER_DESC1), "pDesc")]),
281 IDXGIDevice1.methods += [
282 StdMethod(HRESULT, "SetMaximumFrameLatency", [(UINT, "MaxLatency")]),
283 StdMethod(HRESULT, "GetMaximumFrameLatency", [Out(Pointer(UINT), "pMaxLatency")]),
288 StdFunction(HRESULT, "CreateDXGIFactory", [(REFIID, "riid"), (Pointer(ObjPointer(Void)), "ppFactory")]),
289 StdFunction(HRESULT, "CreateDXGIFactory1", [(REFIID, "riid"), (Pointer(ObjPointer(Void)), "ppFactory")]),