AXART_3D

Syntax

#include <cafe.h>
#include <cafe/axart.h>

typedef struct
{
    AXART_ART   art;

    // runtime user parameters

    f32         hAngle;         // horizontal angle
    f32         vAngle;         // vertical angle
    f32         dist;           // distance from listener
    f32         closingSpeed;   // for Doppler
    u32         update;         // set to true after changing parameters

    // do not write to these parameters

    u8          pan;
    u8          span;
    u8          src;
    u16         itdL;
    u16         itdR;
    f32         pitch;
    s32         attenuation;

} AXART_3D;

Elements

art AXART articulator descriptor maintained by AXART. Do not write to this parameter.
hAngle Horizontal angle for the sound source relative to the camera. Units are in radians.
vAngle Vertical angle for the sound source relative to the camera. Units are in radians.
dist Distance for the sound source relative to the camera.
closingSpeed Closing speed for the sound source relative to the camera.
update Set to TRUE after changing hAngle, vAngle, dist, or closingSpeed. This causes AXART to update the sound position, pitch and volume.
pan AXART generated pan value. Do not write to this parameter.
span AXART generated surround pan value. Do not write to this parameter.
src AXART generated SRC type. Do not write to this parameter.
itdL AXART generated ITD. Do not write to this parameter.
itdR AXART generated ITD. Do not write to this parameter.
pitch AXART generated pitch. Do not write to this parameter.
attenuation AXART generated volume attenuation. Do not write to this parameter.

Description

AXART_3D is a data structure that denotes a 3D sound articulator. The table above describes the information that is obtained. This articulator will place an AXART_SOUND in 3D space. Do not use this articulator sound in conjunction with AXART_PANNING or AXART_ITD. For the AXART_3D structure, call the AXARTInitArt3D function prior to calling AXARTAddArticulator.

See Also

AXARTSet3DDistanceScale
AXARTSet3DDopplerScale
AXARTInitArt3D
AXARTAddArticulator
AXART_PANNING
AXART_ITD
AXART_ART
AXART_SOUND

Revision History

2013/05/08 Automated cleanup pass.
2006/03/01 Initial version.


CONFIDENTIAL