Microsoft DirectX 9.0

IDirectSound3DListener8::SetOrientation

The SetOrientation method sets the orientation of the listener's head.

Syntax

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

Parameters

xFront, yFront, zFront

Values that specify the coordinates of the front orientation vector. D3DVALUE is defined as float.

xTop, yTop, zTop

Values that specify the coordinates of the top orientation vector.

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 front vector points in the direction of the listener's nose, and the top vector points up from 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 top vector after setting the front vector.

Requirements

  Header: Declared in dsound.h.

See Also