DXBitBlt function

  • Article

Copies a region of a DXSurface to a second DXSurface.

Syntax

HRESULT DXBitBlt(
  _In_       IDXSurface    *pDest,
  _In_ const CDXDBnds      &DestBnds,
  _In_       IDXSurface    *pSrc,
  _In_ const CDXDBnds      &SrcBnds,
  _In_       DWORD         dwFlags,
  _In_       unsigned long ulTimeout
);

Parameters

  • pDest [in]
    A pointer to an IDXSurface interface that specifies the destination DXSurface.

  • DestBnds [in, ref]
    A CDXDBnds object that specifies the bounds of the destination region.

  • pSrc [in]
    A pointer to an IDXSurface interface that specifies the source DXSurface.

  • SrcBnds [in, ref]
    A CDXDBnds object that specifies the bounds of the source region.

  • dwFlags [in]
    A value of type DWORD that specifies one of the DXBLTOPTIONS used to specify what type of blit operation to perform.

  • ulTimeout [in]
    A value of type unsigned long that specifies the time, in milliseconds, to allow for each surface lock before returning.

Return value

Returns an HRESULT value that depends on the implementation of the interface.

Remarks

This helper function performs a fast blitting operation, with no error checking or parameter validation. To use DXBitBlt, you must call the IDXSurface::LockSurface method on any of the surfaces you are using prior to blitting. If your transform or application is only performing a single blit, it is safer to use the IDXSurfaceFactory::BitBlt method.

Because this is a helper function and not a method on a Component Object Model (COM) interface, applications that use DXBitBlt must link with Dxtrans.lib.

Requirements

Minimum supported client

Windows XP

Minimum supported server

Windows 2000 Server

Header

 Dxhelper.h