IDCompositionDevice::GroupCommit method

[This documentation is preliminary and is subject to change.]

Applies to: desktop apps only

Commits all Microsoft DirectComposition commands pending on this device and on other devices, in a single atomic transaction.

Syntax

HRESULT GroupCommit(
  [in]  IDCompositionDevice **otherDevices,
  [in]  int otherDeviceCount
);

Parameters

  • otherDevices [in]
    Type: IDCompositionDevice**

    An array of device objects to commit at the same time as this one.

  • otherDeviceCount [in]
    Type: int

    The number of elements in the otherDevices array.

Return value

Type: HRESULT

If the function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. See DirectComposition Error Codes for a list of error codes.

Remarks

Calls to DirectComposition methods are always batched and executed atomically as a single transaction. Method calls take effect only after the IDCompositionDevice::Commit method is called, at which time all pending methods execute at once.

If an application uses multiple devices, each can be committed separately, but that does not guarantee that all of the commits take effect on the same composition frame. This method makes a set of commits atomic, ensuring that all commits take effect on the same frame.

Requirements

Minimum supported client

Windows 8 Consumer Preview

Minimum supported server

Windows Server 8 Beta

Header

Dcomp.h

Library

Dcomp.lib

DLL

Dcomp.dll

See also

IDCompositionDevice

IDCompositionDevice::Commit

 

 

Build date: 3/7/2012