include/dxgi.idl

   1 /*
   2  * Copyright 2007 Andras Kovacs
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2.1 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  17  */
  18
  19 import "oaidl.idl";
  20 import "ocidl.idl";
  21 import "dxgitype.h";
  22
  23 const UINT _FACDXGI = 0x87a;
  24
  25 cpp_quote("#define MAKE_DXGI_STATUS(x)                         MAKE_HRESULT(0, _FACDXGI, x)")
  26 cpp_quote("#define DXGI_STATUS_OCCLUDED                        MAKE_DXGI_STATUS(1)")
  27 cpp_quote("#define DXGI_STATUS_CLIPPED                         MAKE_DXGI_STATUS(2)")
  28 cpp_quote("#define DXGI_STATUS_NO_REDIRECTION                  MAKE_DXGI_STATUS(4)")
  29 cpp_quote("#define DXGI_STATUS_NO_DESKTOP_ACCESS               MAKE_DXGI_STATUS(5)")
  30 cpp_quote("#define DXGI_STATUS_GRAPHICS_VIDPN_SOURCE_IN_USE    MAKE_DXGI_STATUS(6)")
  31 cpp_quote("#define DXGI_STATUS_MODE_CHANGED                    MAKE_DXGI_STATUS(7)")
  32 cpp_quote("#define DXGI_STATUS_MODE_CHANGE_IN_PROGRESS         MAKE_DXGI_STATUS(8)")
  33
  34 cpp_quote("#define MAKE_DXGI_HRESULT(x)                        MAKE_HRESULT(1, _FACDXGI, x)")
  35 cpp_quote("#define DXGI_ERROR_INVALID_CALL                     MAKE_DXGI_HRESULT(1)")
  36 cpp_quote("#define DXGI_ERROR_NOT_FOUND                        MAKE_DXGI_HRESULT(2)")
  37 cpp_quote("#define DXGI_ERROR_MORE_DATA                        MAKE_DXGI_HRESULT(3)")
  38 cpp_quote("#define DXGI_ERROR_UNSUPPORTED                      MAKE_DXGI_HRESULT(4)")
  39 cpp_quote("#define DXGI_ERROR_DEVICE_REMOVED                   MAKE_DXGI_HRESULT(5)")
  40 cpp_quote("#define DXGI_ERROR_DEVICE_HUNG                      MAKE_DXGI_HRESULT(6)")
  41 cpp_quote("#define DXGI_ERROR_DEVICE_RESET                     MAKE_DXGI_HRESULT(7)")
  42 cpp_quote("#define DXGI_ERROR_WAS_STILL_DRAWING                MAKE_DXGI_HRESULT(10)")
  43 cpp_quote("#define DXGI_ERROR_FRAME_STATISTICS_DISJOINT        MAKE_DXGI_HRESULT(11)")
  44 cpp_quote("#define DXGI_ERROR_GRAPHICS_VIDPN_SOURCE_IN_USE     MAKE_DXGI_HRESULT(12)")
  45 cpp_quote("#define DXGI_ERROR_DRIVER_INTERNAL_ERROR            MAKE_DXGI_HRESULT(32)")
  46 cpp_quote("#define DXGI_ERROR_NONEXCLUSIVE                     MAKE_DXGI_HRESULT(33)")
  47 cpp_quote("#define DXGI_ERROR_NOT_CURRENTLY_AVAILABLE          MAKE_DXGI_HRESULT(34)")
  48
  49 cpp_quote("#if 0")
  50 typedef HANDLE HMONITOR;
  51 typedef struct _LUID {
  52     DWORD LowPart;
  53     LONG HighPart;
  54 } LUID, *PLUID;
  55 cpp_quote("#endif")
  56
  57 typedef UINT DXGI_USAGE;
  58 const DXGI_USAGE DXGI_USAGE_SHADER_INPUT            = 0x10L;
  59 const DXGI_USAGE DXGI_USAGE_RENDER_TARGET_OUTPUT    = 0x20L;
  60 const DXGI_USAGE DXGI_USAGE_BACK_BUFFER             = 0x40L;
  61 const DXGI_USAGE DXGI_USAGE_SHARED                  = 0x80L;
  62 const DXGI_USAGE DXGI_USAGE_READ_ONLY               = 0x100L;
  63 const DXGI_USAGE DXGI_USAGE_DISCARD_ON_PRESENT      = 0x200L;
  64 const DXGI_USAGE DXGI_USAGE_UNORDERED_ACCESS        = 0x400L;
  65
  66 const UINT DXGI_ENUM_MODES_INTERLACED               = 1;
  67 const UINT DXGI_ENUM_MODES_SCALING                  = 2;
  68
  69 typedef enum DXGI_SWAP_EFFECT {
  70     DXGI_SWAP_EFFECT_DISCARD    = 0,
  71     DXGI_SWAP_EFFECT_SEQUENTIAL = 1,
  72     DXGI_SWAP_EFFECT_FLIP_SEQUENTIAL = 3
  73 } DXGI_SWAP_EFFECT;
  74
  75 typedef enum DXGI_RESIDENCY {
  76     DXGI_RESIDENCY_FULLY_RESIDENT               = 1,
  77     DXGI_RESIDENCY_RESIDENT_IN_SHARED_MEMORY    = 2,
  78     DXGI_RESIDENCY_EVICTED_TO_DISK              = 3,
  79 } DXGI_RESIDENCY;
  80
  81 typedef struct DXGI_SURFACE_DESC {
  82     UINT Width;
  83     UINT Height;
  84     DXGI_FORMAT Format;
  85     DXGI_SAMPLE_DESC SampleDesc;
  86 } DXGI_SURFACE_DESC;
  87
  88 typedef struct DXGI_MAPPED_RECT {
  89     INT Pitch;
  90     BYTE *pBits;
  91 } DXGI_MAPPED_RECT;
  92
  93 typedef struct DXGI_OUTPUT_DESC {
  94     WCHAR DeviceName[32];
  95     RECT DesktopCoordinates;
  96     BOOL AttachedToDesktop;
  97     DXGI_MODE_ROTATION Rotation;
  98     HMONITOR Monitor;
  99 } DXGI_OUTPUT_DESC;
 100
 101 typedef struct DXGI_FRAME_STATISTICS {
 102     UINT PresentCount;
 103     UINT PresentRefreshCount;
 104     UINT SyncRefreshCount;
 105     LARGE_INTEGER SyncQPCTime;
 106     LARGE_INTEGER SyncGPUTime;
 107 } DXGI_FRAME_STATISTICS;
 108
 109 typedef struct DXGI_ADAPTER_DESC {
 110     WCHAR Description[128];
 111     UINT VendorId;
 112     UINT DeviceId;
 113     UINT SubSysId;
 114     UINT Revision;
 115     SIZE_T DedicatedVideoMemory;
 116     SIZE_T DedicatedSystemMemory;
 117     SIZE_T SharedSystemMemory;
 118     LUID AdapterLuid;
 119 } DXGI_ADAPTER_DESC;
 120
 121 typedef enum DXGI_SWAP_CHAIN_FLAG {
 122     DXGI_SWAP_CHAIN_FLAG_NONPREROTATED      = 1,
 123     DXGI_SWAP_CHAIN_FLAG_ALLOW_MODE_SWITCH  = 2,
 124     DXGI_SWAP_CHAIN_FLAG_GDI_COMPATIBLE     = 4
 125 } DXGI_SWAP_CHAIN_FLAG;
 126
 127 typedef struct DXGI_SWAP_CHAIN_DESC {
 128     DXGI_MODE_DESC BufferDesc;
 129     DXGI_SAMPLE_DESC SampleDesc;
 130     DXGI_USAGE BufferUsage;
 131     UINT BufferCount;
 132     HWND OutputWindow;
 133     BOOL Windowed;
 134     DXGI_SWAP_EFFECT SwapEffect;
 135     UINT Flags;
 136 } DXGI_SWAP_CHAIN_DESC;
 137
 138 typedef struct DXGI_SHARED_RESOURCE {
 139     HANDLE Handle;
 140 } DXGI_SHARED_RESOURCE;
 141
 142 [
 143     object,
 144     local,
 145     uuid(aec22fb8-76f3-4639-9be0-28eb43a67a2e)
 146 ]
 147 interface IDXGIObject : IUnknown
 148 {
 149     HRESULT SetPrivateData(
 150         [in] REFGUID guid,
 151         [in] UINT data_size,
 152         [in] const void *data
 153     );
 154     HRESULT SetPrivateDataInterface(
 155         [in] REFGUID guid,
 156         [in] const IUnknown *object
 157     );
 158     HRESULT GetPrivateData(
 159         [in] REFGUID guid,
 160         [in, out] UINT *data_size,
 161         [out] void *data
 162     );
 163     HRESULT GetParent(
 164         [in] REFIID riid,
 165         [out] void **parent
 166     );
 167 }
 168
 169 [
 170     object,
 171     local,
 172     uuid(3d3e0379-f9de-4d58-bb6c-18d62992f1a6)
 173 ]
 174 interface IDXGIDeviceSubObject : IDXGIObject
 175 {
 176     HRESULT GetDevice(
 177         [in] REFIID riid,
 178         [out] void **device
 179     );
 180 }
 181
 182 [
 183     object,
 184     uuid(035f3ab4-482e-4e50-b41f-8a7f8bd8960b),
 185     local,
 186     pointer_default(unique)
 187 ]
 188 interface IDXGIResource : IDXGIDeviceSubObject
 189 {
 190     HRESULT GetSharedHandle([out] HANDLE *pSharedHandle);
 191     HRESULT GetUsage([out] DXGI_USAGE *pUsage);
 192     HRESULT SetEvictionPriority([in] UINT EvictionPriority);
 193     HRESULT GetEvictionPriority([out, retval] UINT *pEvictionPriority);
 194 }
 195
 196 [
 197     object,
 198     uuid(9d8e1289-d7b3-465f-8126-250e349af85d),
 199     local,
 200     pointer_default(unique)
 201 ]
 202 interface IDXGIKeyedMutex : IDXGIDeviceSubObject
 203 {
 204     HRESULT AcquireSync([in] UINT64 Key, [in] DWORD dwMilliseconds);
 205     HRESULT ReleaseSync([in] UINT64 Key);
 206 }
 207
 208 [
 209     object,
 210     local,
 211     uuid(cafcb56c-6ac3-4889-bf47-9e23bbd260ec)
 212 ]
 213 interface IDXGISurface : IDXGIDeviceSubObject
 214 {
 215     HRESULT GetDesc(
 216         [out] DXGI_SURFACE_DESC *desc
 217     );
 218     HRESULT Map(
 219         [out] DXGI_MAPPED_RECT *mapped_rect,
 220         [in] UINT flags
 221     );
 222     HRESULT Unmap(
 223     );
 224 }
 225
 226 [
 227     object,
 228     local,
 229     uuid(ae02eedb-c735-4690-8d52-5a8dc20213aa)
 230 ]
 231 interface IDXGIOutput : IDXGIObject
 232 {
 233     HRESULT GetDesc(
 234         [out] DXGI_OUTPUT_DESC *desc
 235     );
 236     HRESULT GetDisplayModeList(
 237         [in] DXGI_FORMAT format,
 238         [in] UINT flags,
 239         [in, out] UINT *mode_count,
 240         [out] DXGI_MODE_DESC *desc
 241     );
 242     HRESULT FindClosestMatchingMode(
 243         [in] const DXGI_MODE_DESC *mode,
 244         [out] DXGI_MODE_DESC *closest_match,
 245         [in] IUnknown *device
 246     );
 247     HRESULT WaitForVBlank(
 248     );
 249     HRESULT TakeOwnership(
 250         [in] IUnknown *device,
 251         [in] BOOL exclusive
 252     );
 253     void ReleaseOwnership(
 254     );
 255     HRESULT GetGammaControlCapabilities(
 256         [out] DXGI_GAMMA_CONTROL_CAPABILITIES *gamma_caps
 257     );
 258     HRESULT SetGammaControl(
 259         [in] const DXGI_GAMMA_CONTROL *gamma_control
 260     );
 261     HRESULT GetGammaControl(
 262         [out] DXGI_GAMMA_CONTROL *gamma_control
 263     );
 264     HRESULT SetDisplaySurface(
 265         [in] IDXGISurface *surface
 266     );
 267     HRESULT GetDisplaySurfaceData(
 268         [in] IDXGISurface *surface
 269     );
 270     HRESULT GetFrameStatistics(
 271         [out] DXGI_FRAME_STATISTICS *stats
 272     );
 273 }
 274
 275 [
 276     object,
 277     local,
 278     uuid(2411e7e1-12ac-4ccf-bd14-9798e8534dc0)
 279 ]
 280 interface IDXGIAdapter : IDXGIObject
 281 {
 282     HRESULT EnumOutputs(
 283         [in] UINT output_idx,
 284         [in, out] IDXGIOutput **output
 285     );
 286     HRESULT GetDesc(
 287         [out] DXGI_ADAPTER_DESC *desc
 288     );
 289     HRESULT CheckInterfaceSupport(
 290         [in] REFGUID guid,
 291         [out] LARGE_INTEGER *umd_version
 292     );
 293 }
 294
 295 cpp_quote("#define DXGI_MAX_SWAP_CHAIN_BUFFERS  (16)")
 296
 297 cpp_quote("#define DXGI_PRESENT_TEST                   __MSABI_LONG(0x00000001U)")
 298 cpp_quote("#define DXGI_PRESENT_DO_NOT_SEQUENCE        __MSABI_LONG(0x00000002U)")
 299 cpp_quote("#define DXGI_PRESENT_RESTART                __MSABI_LONG(0x00000004U)")
 300 cpp_quote("#define DXGI_PRESENT_DO_NOT_WAIT            __MSABI_LONG(0x00000008U)")
 301 cpp_quote("#define DXGI_PRESENT_STEREO_PREFER_RIGHT    __MSABI_LONG(0x00000010U)")
 302 cpp_quote("#define DXGI_PRESENT_STEREO_TEMPORARY_MONO  __MSABI_LONG(0x00000020U)")
 303 cpp_quote("#define DXGI_PRESENT_RESTRICT_TO_OUTPUT     __MSABI_LONG(0x00000040U)")
 304
 305 [
 306     object,
 307     local,
 308     uuid(310d36a0-d2e7-4c0a-aa04-6a9d23b8886a)
 309 ]
 310 interface IDXGISwapChain : IDXGIDeviceSubObject
 311 {
 312     HRESULT Present(
 313         [in] UINT sync_interval,
 314         [in] UINT flags
 315     );
 316     HRESULT GetBuffer(
 317         [in] UINT buffer_idx,
 318         [in] REFIID riid,
 319         [in, out] void **surface
 320     );
 321     HRESULT SetFullscreenState(
 322         [in] BOOL fullscreen,
 323         [in] IDXGIOutput *target
 324     );
 325     HRESULT GetFullscreenState(
 326         [out] BOOL *fullscreen,
 327         [out] IDXGIOutput **target
 328     );
 329     HRESULT GetDesc(
 330         [out] DXGI_SWAP_CHAIN_DESC *desc
 331     );
 332     HRESULT ResizeBuffers(
 333         [in] UINT buffer_count,
 334         [in] UINT width,
 335         [in] UINT height,
 336         [in] DXGI_FORMAT format,
 337         [in] UINT flags
 338     );
 339     HRESULT ResizeTarget(
 340         [in] const DXGI_MODE_DESC *target_mode_desc
 341     );
 342     HRESULT GetContainingOutput(
 343         [out] IDXGIOutput **output
 344     );
 345     HRESULT GetFrameStatistics(
 346         [out] DXGI_FRAME_STATISTICS *stats
 347     );
 348     HRESULT GetLastPresentCount(
 349         [out] UINT *last_present_count
 350     );
 351 }
 352
 353 cpp_quote("#define DXGI_MWA_NO_WINDOW_CHANGES  0x1")
 354 cpp_quote("#define DXGI_MWA_NO_ALT_ENTER       0x2")
 355 cpp_quote("#define DXGI_MWA_NO_PRINT_SCREEN    0x4")
 356 cpp_quote("#define DXGI_MWA_VALID              0x7")
 357
 358 [
 359     object,
 360     local,
 361     uuid(7b7166ec-21c7-44ae-b21a-c9ae321ae369)
 362 ]
 363 interface IDXGIFactory : IDXGIObject
 364 {
 365     HRESULT EnumAdapters(
 366         [in] UINT adapter_idx,
 367         [out] IDXGIAdapter **adapter
 368     );
 369     HRESULT MakeWindowAssociation(
 370         [in] HWND window,
 371         [in] UINT flags
 372     );
 373     HRESULT GetWindowAssociation(
 374         [in] HWND *window
 375     );
 376     HRESULT CreateSwapChain(
 377         [in] IUnknown *device,
 378         [in] DXGI_SWAP_CHAIN_DESC *desc,
 379         [out] IDXGISwapChain **swapchain
 380     );
 381     HRESULT CreateSoftwareAdapter(
 382         [in] HMODULE swrast,
 383         [out] IDXGIAdapter **adapter
 384     );
 385 }
 386
 387 [local] HRESULT __stdcall CreateDXGIFactory(REFIID riid, void **factory);
 388 [local] HRESULT __stdcall CreateDXGIFactory1(REFIID riid, void **factory);
 389
 390 [
 391     object,
 392     local,
 393     uuid(54ec77fa-1377-44e6-8c32-88fd5f44c84c)
 394 ]
 395 interface IDXGIDevice : IDXGIObject
 396 {
 397     HRESULT GetAdapter(
 398         [out] IDXGIAdapter **adapter
 399     );
 400     HRESULT CreateSurface(
 401         [in] const DXGI_SURFACE_DESC *desc,
 402         [in] UINT surface_count,
 403         [in] DXGI_USAGE usage,
 404         [in] const DXGI_SHARED_RESOURCE *shared_resource,
 405         [out] IDXGISurface **surface
 406     );
 407     HRESULT QueryResourceResidency(
 408         [in] IUnknown *const *resources,
 409         [out] DXGI_RESIDENCY *residency,
 410         [in] UINT resource_count
 411     );
 412     HRESULT SetGPUThreadPriority(
 413         [in] INT priority
 414     );
 415     HRESULT GetGPUThreadPriority(
 416         [out] INT *priority
 417     );
 418 }
 419
 420 typedef enum DXGI_ADAPTER_FLAG {
 421     DXGI_ADAPTER_FLAG_NONE         = 0,
 422     DXGI_ADAPTER_FLAG_REMOTE       = 1,
 423     DXGI_ADAPTER_FLAG_FORCE_DWORD  = 0xFFFFFFFF
 424 } DXGI_ADAPTER_FLAG;
 425
 426 typedef struct DXGI_ADAPTER_DESC1 {
 427     WCHAR  Description[128];
 428     UINT   VendorId;
 429     UINT   DeviceId;
 430     UINT   SubSysId;
 431     UINT   Revision;
 432     SIZE_T DedicatedVideoMemory;
 433     SIZE_T DedicatedSystemMemory;
 434     SIZE_T SharedSystemMemory;
 435     LUID   AdapterLuid;
 436     UINT   Flags;
 437 } DXGI_ADAPTER_DESC1;
 438
 439 [
 440     object,
 441     uuid(29038f61-3839-4626-91fd-086879011a05),
 442     local,
 443     pointer_default(unique)
 444 ]
 445 interface IDXGIAdapter1 : IDXGIAdapter
 446 {
 447     HRESULT GetDesc1([out] DXGI_ADAPTER_DESC1 *pDesc);
 448 }
 449
 450 [
 451     object,
 452     uuid(77db970f-6276-48ba-ba28-070143b4392c),
 453     local,
 454     pointer_default(unique)
 455 ]
 456 interface IDXGIDevice1 : IDXGIDevice
 457 {
 458     HRESULT SetMaximumFrameLatency([in] UINT MaxLatency);
 459     HRESULT GetMaximumFrameLatency([out] UINT *pMaxLatency);
 460 }
 461
 462 [
 463     object,
 464     uuid(770aae78-f26f-4dba-a829-253c83d1b387),
 465     local,
 466     pointer_default(unique)
 467  ]
 468 interface IDXGIFactory1 : IDXGIFactory
 469 {
 470     HRESULT EnumAdapters1([in] UINT Adapter, [out] IDXGIAdapter1 **ppAdapter);
 471     BOOL IsCurrent();
 472 }