IDirectSound3DBuffer::SetMinDistance

The IDirectSound3DBuffer::SetMinDistance method sets the current minimum distance value.

HRESULT SetMinDistance(
  D3DVALUE flMinDistance,  
  DWORD dwApply            
);
 

Parameters

flMinDistance

New minimum distance value.

dwApply

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

DS3D_DEFERRED

Settings are not applied until the application calls the IDirectSound3DListener::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

By default, the minimum distance value is DS3D_DEFAULTMINDISTANCE, currently defined as 1.0 (corresponding to 1.0 meter at the default distance factor of 1.0 meters per unit).

QuickInfo

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Requires Windows 95 or later. Available as a redistributable for Windows 95.
  Header: Declared in dsound.h.
  Import Library: Use dsound.lib.

See Also

IDirectSound3DBuffer::SetMaxDistance