DirectX Graphics API Reference

IDXGIOutput1 Interface

This interface extends the IDXGIOutput interface to support advanced output capabilities, particularly for high-color-depth displays and stereo 3D rendering.

interface IDXGIOutput1 : IDXGIOutput {
    // Inherited from IDXGIOutput
    // HRESULT GetDesc(DXGI_OUTPUT_DESC *pDesc);
    // HRESULT GetDisplayModeList(DXGI_FORMAT EnumFormat, UINT Flags, UINT *pNumModes, DXGI_MODE_DESC *pDesc);
    // HRESULT FindClosestMatchingMode(const DXGI_MODE_DESC *pModeToMatch, DXGI_MODE_DESC *pClosestMatch, IUnknown *pConcernedDevice);
    // HRESULT EnumerateAdvancedColorRegions(UINT Producer, UINT *pFlags, DXGI_ADVANCED_COLOR_REGION *pRegions);
    // HRESULT DuplicateOutput(IUnknown *pDevice, IDXGIOutputDuplication **ppOutputDuplication);

    // New methods for IDXGIOutput1
    HRESULT GetDesc1(DXGI_OUTPUT_DESC1 *pDesc);
    HRESULT GetDisplaySurfaceData1(IDXGIResource *pDestination);
    HRESULT DuplicateOutput1(IUnknown *pDevice, UINT OverlayWidth, UINT OverlayHeight, DXGI_FORMAT OverlayFormat, BOOL ConstrainWatermark, IDXGIOutputDuplication **ppOutputDuplication);
};

Methods

• GetDesc1

  Retrieves a description of the output.

  Return value

  • S_OK on success.
  • DXGI_ERROR_INVALID_CALL if the previous GetDesc method returned an invalid configuration.
  Parameters

  • pDesc [out] A pointer to a DXGI_OUTPUT_DESC1 structure that describes the output.

• GetDisplaySurfaceData1

  Copies the contents of the output surface to the specified destination resource.

  Return value

  • S_OK on success.
  • DXGI_ERROR_INVALID_CALL if the previous GetDesc method returned an invalid configuration.
  • DXGI_ERROR_NOT_CURRENTLY_AVAILABLE if the desktop duplication API is not currently available.
  Parameters

  • pDestination [in] A pointer to the destination resource.

• DuplicateOutput1

  Creates a desktop duplication interface that you can use to get a copy of the desktop image.

  Return value

  • S_OK on success.
  • DXGI_ERROR_DEVICE_REMOVED if the graphics adapter has been removed.
  • DXGI_ERROR_ACCESS_DENIED if you called this for a desktop that is already being duplicated.
  • DXGI_ERROR_INVALID_CALL if you called this for an invalid configuration.
  Parameters

  • pDevice [in] The DirectX device that you want to use to duplicate the desktop.
  • OverlayWidth [in] The width of the overlay.
  • OverlayHeight [in] The height of the overlay.
  • OverlayFormat [in] The format of the overlay.
  • ConstrainWatermark [in] A flag that specifies whether to constrain the watermark.
  • ppOutputDuplication [out] A pointer to the duplicated output interface.

Remarks

To obtain a pointer to an IDXGIOutput1 interface, call the QueryInterface method on an IDXGIOutput interface.

The IDXGIOutput1 interface is used for scenarios requiring advanced color capabilities or stereo 3D rendering. It extends the functionality of IDXGIOutput by providing methods to access more detailed output descriptions and manage desktop duplication with enhanced options.

See Also

• DXGI Interfaces
• IDXGIOutput
• DXGI_OUTPUT_DESC1