Microsoft DirectX 8.1 (C++)

IDirectSound3DListener8::GetOrientation

The GetOrientation method retrieves the listener's orientation in vectors: a front vector and a top vector.

Syntax

HRESULT GetOrientation(
  D3DVECTOR * pvOrientFront, 
  D3DVECTOR * pvOrientTop 
);

Parameters

pvOrientFront

Address of a D3DVECTOR structure that receives the listener's front orientation vector.

pvOrientTop

Address of a D3DVECTOR structure that receives the listener's top orientation vector.

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 values returned are not necessarily the same as those set by using the IDirectSound3DListener8::SetOrientation method. DirectSound adjusts orientation vectors so that they are at right angles and have a magnitude of less than or equal to 1.0.

Requirements

  Header: Declared in dsound.h.

See Also