Microsoft DirectX 8.1 (C++)

IDirectSound3DBuffer8::SetMaxDistance

The SetMaxDistance method sets the maximum distance value.

Syntax

HRESULT SetMaxDistance(
  D3DVALUE flMaxDistance, 
  DWORD dwApply 
);

Parameters

flMaxDistance

New maximum distance value. D3DVALUE is defined as float in D3dtypes.h.

dwApply

Value that specifies when the setting should be applied. This value must be one of the following:

Value Description
DS3D_DEFERRED Settings are not applied until the application calls the IDirectSound3DListener8::CommitDeferredSettings method. This allows the application to change several settings and generate a single recalculation.
DS3D_IMMEDIATE Settings are applied immediately, causing the system to recalculate the 3-D coordinates for all 3-D sound buffers.

Return Values

If the method succeeds, the return value is DS_OK.

If the method fails, the return value may be DSERR_INVALIDPARAM.

Remarks

The default maximum distance, defined as DS3D_DEFAULTMAXDISTANCE, is effectively infinite.

Requirements

  Header: Declared in dsound.h.

See Also