Skip to content

Commit 0624540

Browse files
committed
Improve documentation for speakers and vkey op-codes
1 parent adc0352 commit 0624540

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

vst.h

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -318,14 +318,14 @@ enum VST_SPEAKER_TYPE {
318318

319319
struct vst_speaker_properties_t {
320320
/** Azimuth in Radians
321-
* Range: -PI to PI
321+
* Range: -PI (Left) through 0.0 (Right) to PI (Left)
322322
*
323323
* Note: Must be 10.0 if this is a LFE.
324324
*/
325325
float azimuth;
326326

327327
/** Altitude in Radians
328-
* Range: -PI/2 to PI/2
328+
* Range: -PI/2 (Bottom) to PI/2 (Top)
329329
*
330330
* Note: Must be 10.0 if this is a LFE.
331331
*/
@@ -522,7 +522,7 @@ enum VST_HOST_OPCODE {
522522
VST_HOST_OPCODE_0D = 0x0D,
523523

524524
/** Notify the host that numInputs/numOutputs/delay/numParams has changed.
525-
* Only supported if the host replies VST_STATUS_TRUE to VST_HOST_OPCODE_SUPPORTS("ioChanged")
525+
* Only supported if the host replies VST_STATUS_TRUE to VST_HOST_OPCODE_SUPPORTS("acceptIOChanges")
526526
*
527527
* Note: In VST 2.3 and earlier calling this outside of VST_EFFECT_OPCODE_IDLE may result in a crash.
528528
* Note: In VST 2.3 and later this may only be called while between VST_EFFECT_OPCODE_PROCESS_END and VST_EFFECT_OPCODE_BEGIN.
@@ -1395,7 +1395,8 @@ enum VST_EFFECT_OPCODE {
13951395

13961396
/** Retrieve the VST Version supported.
13971397
*
1398-
* @return Return 0 for <2.0, 2 for 2.0, 2100 for 2.1, 2200 for 2.2, 2300 for 2.3, etc.
1398+
* @sa VST_VERSION
1399+
* @return One of the valid enums in \ref VST_VERSION
13991400
*/
14001401
VST_EFFECT_OPCODE_3A = 0x3A,
14011402
VST_EFFECT_OPCODE_VST_VERSION = 0x3A,
@@ -1406,19 +1407,19 @@ enum VST_EFFECT_OPCODE {
14061407

14071408
/** Editor Virtual Key Down Input
14081409
*
1409-
* @param p_int1 ASCII Character
1410+
* @param p_int1 ASCII character that represents the virtual key code.
14101411
* @param p_int2 Virtual Key Code
1411-
* @param p_float Modifiers
1412+
* @param p_float Modifiers being held down (bitfield)
14121413
* @return VST_STATUS_TRUE if we used the input, otherwise VST_STATUS_FALSE
14131414
*/
14141415
VST_EFFECT_OPCODE_3B = 0x3B,
14151416
VST_EFFECT_OPCODE_EDITOR_VKEY_DOWN = 0x3B,
14161417

14171418
/** Editor Virtual Key Up Event
14181419
*
1419-
* @param p_int1 ASCII Character
1420+
* @param p_int1 ASCII character that represents the virtual key code.
14201421
* @param p_int2 Virtual Key Code
1421-
* @param p_float Modifiers
1422+
* @param p_float Modifiers being held down (bitfield)
14221423
* @return VST_STATUS_TRUE if we used the input, otherwise VST_STATUS_FALSE
14231424
*/
14241425
VST_EFFECT_OPCODE_3C = 0x3C,

0 commit comments

Comments
 (0)