IDirectSound3DListener::SetOrientation

The IDirectSound3DListener::SetOrientation method sets the listener's current orientation in terms of two vectors: a front vector and a top vector.

HRESULT SetOrientation(
  D3DVALUE xFront,  
  D3DVALUE yFront,  
  D3DVALUE zFront,  
  D3DVALUE xTop,    
  D3DVALUE yTop,    
  D3DVALUE zTop,    
  DWORD dwApply     
);

Parameters

xFront, yFront, and zFront

Values whose types are D3DVALUE and that represent the coordinates of the front orientation vector.

xTop, yTop, and zTop

Values whose types are D3DVALUE and that represent the coordinates of the top orientation vector.

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

The front vector points in the direction of the listener's nose, and the top vector points out the top of the listener's head. By default, the front vector is (0,0,1.0) and the top vector is (0,1.0,0).

The top vector must be at right angles to the front vector. If necessary, DirectSound adjusts the front vector after setting the top vector.

Requirements

  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

IDirectSound3DListener::GetOrientation