DirectX SDK

IDirect3DDevice7::CaptureStateBlock

The IDirect3DDevice7::CaptureStateBlock method updates the values within an existing state block to the values currently set for the device.

HRESULT CaptureStateBlock(
  DWORD dwBlockHandle 
);

Parameters

dwBlockHandle
Handle to the state block into which the current device state is captured.

Return Values

If the method succeeds, the return value is D3D_OK.

If the method fails, the return value can be a standard error code, or D3DERR_INBEGINSTATEBLOCK if a state block is currently being recorded.

Remarks

This method captures updated values for states within an existing state block. It does not capture the entire state of the device. For more information, see Capturing State Blocks.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Requires Windows 95 or later. Available as a redistributable for Windows 95.
  Windows CE: Unsupported.
  Version: Requires DirectX 7.0.
  Header: Declared in d3d.h.

See Also

IDirect3DDevice7::ApplyStateBlock, IDirect3DDevice7::BeginStateBlock, IDirect3DDevice7::CreateStateBlock, IDirect3DDevice7::EndStateBlock, IDirect3DDevice7::DeleteStateBlock, State Blocks, Capturing State Blocks