ID3DXEffect::DeleteParameterBlock method

Delete a parameter block.

Syntax

HRESULT DeleteParameterBlock(
  [in] D3DXHANDLE  hParameterBlock
);

Parameters

hParameterBlock [in]

Type: D3DXHANDLE

A handle to the parameter block. This is the handle returned by ID3DXEffect::EndParameterBlock.

Return value

Type: HRESULT

If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be one of the following: D3DERR_INVALIDCALL, D3DXERR_INVALIDDATA.

Remarks

Parameter blocks are blocks of effect states. Use a parameter block to record state changes so that they can be applied later on with a single API call. When no longer needed, delete the parameter block to reduce memory usage.

Requirements

See also

ID3DXEffect

ID3DXEffect::BeginParameterBlock

ID3DXEffect::EndParameterBlock