| Microsoft DirectX 9.0 |
The SetMinDistance method sets the minimum distance, which is the distance from the listener at which sounds in this buffer begin to be attenuated.
Syntax
HRESULT SetMinDistance(
D3DVALUE flMinDistance,
DWORD dwApply
);
Parameters
flMinDistance
Minimum distance, in meters by default. D3DVALUE is defined as float.
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
By default, the minimum distance value is DS3D_DEFAULTMINDISTANCE, defined as 1.0 (corresponding to 1.0 meter at the default distance factor of 1.0 meters per unit).
The default unit of measurement is meters, but this can be changed by using the IDirectSound3DListener8::SetDistanceFactor method.
Requirements
Header: Declared in dsound.h.
See Also